Appcues Events Reference

This document is a reference for Appcues Events, if you're looking for information on Appcues Flow events please reference the Client-side Events Reference (Developer) document. If you're looking to learn about sending events into Appcues or tracking events in Appcues see the Events Overview document.

This is a complete guide and reference to internal Appcues Events including Flow Events, Checklist Events, and NPS Events used when creating custom integrations, looking for events in the CSV or your current Integration.

Flow Events

After you start collecting feedback from customers, you can build reports outside of Appcues using our CSV exports or an integration. Here is a summary of the event names you may find:


Event Name              Event Description

flow_started When the first step of a flow is started or displayed on the page. If this event is fired, then the Flow Aborted and Flow Error events should not be fired. This should be fired before the Step Started event.
flow_completed
The user completes the last step of the flow. This should be fired after the Step Completed event .
flow_skipped The user chooses to skip a flow. This should fire after the Step Skipped event is fired for the corresponding step.
step_started When the step-group is run or displayed on the page. If this event is fired, then the Step Aborted and Step Error events should not be fired. This should be fired before Step Child Activated or Step Child Recovered events are fired.
step_completed When the user completes a step-group. For modals and tooltips, this means closing the content with the "complete button". For hotspots, this means clicking on the last hotspot. This should be fired before the flow_completed event.
step_skipped When the user chooses to skip a step-group or flow. This should be fired before the Flow Skipped event.
step_aborted When there is a "fatal" error that prevents starting or completing a step-group. If this event is fired before we show the step-group, then Step Started should not be fired. This should be fired before the Flow Aborted event.
step_interacted When a user interacts with a step-group in some way. Currently we track when a user does any of the following:

    -Clicks a link in a flow
    -Clicks a button (built-in or custom) in a flow
    -Submits a form in a flow
    -Clicks on a hotspot to expand it 
This should be fired before the Step Child Deactivated or Step Child Activated events that it may trigger.
form_submitted When a user submits a form in a modal. This should be fired before the Step Child Deactivated event it may trigger and before the Form Field Submitted event(s) that it will trigger.
form_field_submitted For each field in a form that a user submits in a modal. This should be fired after the Form Submitted event.

NPS Events and Properties

After you start collecting feedback from customers, you can build reports outside of Appcues using our CSV exports or an integration. Here is a summary of the event names you may find:

Event Name                        Event Description

nps_survey_started A user has seen the NPS survey
nps_score A user submitted an NPS score.
nps_feedback A user submitted NPS feedback after selecting an NPS score.
nps_ask_me_later_selected_at A user selected the "Ask Me Later" button at the given timestamp property on an NPS survey that was shown to them
nps_clicked_update_nps_score A user that has already submitted an NPS score selected the "Update Score" option and potentially changed their NPS score.

Default Properties

Each of these events will have default properties as well as additional properties related to the event.

Property Name            Property Description

timestamp the time at which this event occurred
userId the user that completed the event
currentPageTitle the title of the page the user was on when the event was completed
currentPageUrl     the url of the page the user was on when the event was completed
sessionPageviews  the number of pages the user visited in the session in which the event was completed

Event Specific Properties

Each of these properties will have default properties related to the event.

 Event Name                           Event Description

nps_survey_started default properties (see above)
nps_score score- the score that the user selected,   default properties (see above)
nps_feedback feedback- the qualitative feedback the user provided,  default properties (see above)
nps_ask_me_later_selected_at  askMeLaterSelectedAt- the timestamp at which the user selected "Ask Me Later",   default properties (see above)
nps_clicked_update_nps_score  score- the new score that the user selected,   default properties (see above)

Checklist Events

Here is a summary of the Checklist event names you may find when you export your CSV or in your Integration

 Event Name                        Event Description

checklist_shown A user has seen the Checklist
checklist_completed A user has fully completed the Checklist
checklist_skipped A user has selected 'No thanks' to dismiss prior to completing all items on the list
checklist_dismissed A user has selected 'No thanks' to dismiss after completing all items on the checklist 
checklist_item_started A user has clicked an item on the Checklist
checklist_item_completed A user has met the success criteria to check an item off of the list   

    

Default Properties

Each of the above events will have default properties and additional properties related to the event that will be available via the CSV download

Property Name            Property Description

timestamp The time at which this event occurred
userId The id for the user that completed the event
currentPageTitle Title of the page the user was on when the event was completed
currentPageUrl      URL of the page the user was on when the event was completed
sessionPageviews Number of pages the user visited in the session in which the event was completed

    

Event Specific Properties

Here is a summary of the Checklist event names you may find when you export your CSV or in your Integration

 Property Name          Property Description

checklistId Internal Id of the checklist (not a targetable option) 
checklistName The name of your checklist 
itemId Internal identifier of the relevant checklist item 
itemIndex List order of the relevant item (starting at 0) 
itemLabel Name of the relevant checklist item (i.e. text of checklist item) 

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.