📍Deprecated: Checkpoints

Checkpoints are pre-defined stages that users can reach when they pass through a Flow.

What are checkpoints used for?

• Triggering things like data outputs or custom code

• Analytics: segmenting users, funnels, user timelines etc

What checkpoints can I add?

Savvy has a list (see below) of pre-defined checkpoints that you can add to stages of a Flow. We recommend using these since Savvy 'understands' their meaning so can report them back to you in analytics more appropriately.

A few of these are automatically added to all Flows, so you don't need to add them yourself - see the "Automatically added" label in the table below.

You can also define your own custom checkpoints.

How should I name custom checkpoints?

Checkpoints are always stored in snake_case (their "key") but displayed in Title Case (their "friendly name"). Checkpoints are always an action in the past tense and describe what the user has just done.

For example, began_flow, booked_meeting or reached_triage_page.

Where can checkpoints occur?

Checkpoints can be triggered when:

• A user reaches a pages

• A user 'completes' a page (i.e. moves successfully on to the next page)

• A user clicks a custom button

Note that some events can trigger multiple checkpoints. For example, opening a popup containing a Flow would trigger both opened_popup and viewed_flow.

How should I decide whether a checkpoint is worth adding?

An ideal set of checkpoints in a Flow will correspond to the steps in the funnel that you are trying to measure. Most funnels are 3-6 steps long and contain only key events, not every single page change.

However, you may be considering extra checkpoints, such as:

• Some checkpoints, marked as "Optional Detail", represent a less-prominent event such as completing a certain field. We suggest adding these if collecting a particular field marks a significant event in your funnel.

• Sometimes the same event can be described in multiple ways - for example, submitted_email might be equivalent to reached_triage_page. We suggest only including both of these if you have logic that routes different users to different places and causes certain users to trigger one but not both of these checkpoints (e.g. the email page is hidden for some users).

It's up to you whether to add more detailed checkpoints - you're free to add as many events as you can. The downside is it can risk overcomplicating or adding noise to your funnel, but it can be useful if you want to dive deeper into funnel analytics later on.

And don't forget that Savvy tracks all Flow pages that a user reaches by default - you can filter by these and view them as events on user timelines.

Pre-defined Checkpoints

For automatically added checkpoints, the "Triggers when..." column describes precisely what will trigger it. For other checkpoints, it's a suggestion for how best to define the trigger if you add it to a Flow.

Key	Friendly Name	Triggers when...	Labels
loaded_flow	Loaded Flow	Any page containing the Flow (even hidden behind a popup) loads	Automatically Added
opened_popup	Opened Popup	A popup containing the Flow is opened (must use Flows' built-in popup functionality)	Automatically Added
viewed_flow	Viewed Flow	The Flow is scrolled into view, or inside a popup that is opened	Automatically Added
interacted_with_flow	Interacted with Flow	The user clicks on any dynamic elements or field within the Flow (e.g. an input field is focused or a button is clicked)	Automatically Added
began_flow	Began Flow	The user takes a significant first step in the Flow. Can sometimes be the same as interacted_with_flow, for example if the first question is an OptionSelector.
submitted_flow	Submitted Flow	The user completes the main submission action of a Flow, usually involving sending data somewhere like a CRM. Often triggered at the same time as a more specific checkpoint such as subscribed_to_emails or booked_meeting.
submitted_request	Submitted Request	The user submits a request or message, such as completing a Contact Us form.
subscribed_to_emails	Subscribed to Emails	The user subscribes to email updates such as a newsletter
booked_meeting	Booked Meeting	The user books a meeting using the Calendly or HubSpot integrations
collected_email	Collected Email	The user completes an email field	Optional Detail
collected_name	Collected Name	The user completes a name field (or first_name + last_name fields)	Optional Detail
collected_phone	Collected Phone	The user completes a phone number field	Optional Detail
collected_org	Collected Org	The user completes an org/company/business field	Optional Detail
collected_address	Collected Address	The user completes an address field	Optional Detail
reached_triage_page	Reached Triage Page	The user reaches the triage page	Optional Detail
reached_email_page	Reached Email Page	The user reaches the email page	Optional Detail
reached_contact_details_page	Reached Contact Details Page	The user reaches the contact details page	Optional Detail
reached_book_meeting_page	Reached Book Meeting Page	The user reaches the book meeting page	Optional Detail
reached_results_page	Reached Triage Page	The user reaches the results page (often the same as the triage page)	Optional Detail