Userflow-generated events

This page describes all the events that Userflow generates when users interact with flows/checklists. These events can be continuously streamed to other product analytics providers.

Event anatomy

An event consists of:

  • Event name : The raw name Userflow stores events with, and which will be sent to your product analytics provider.
  • Display name (the headers below): A user-friendly representation of the Event name.
  • Attributes : A dictionary of extra information about the event, such as which flow it concerns. May be referred to as “properties” in your analytics provider.

Table of contents

Checklist Completed

Event name: checklist_completed

All of a Userflow checklist tasks were completed.

Attribute name Display name Description
checklist_id Checklist ID Userflow checklist
checklist_name Checklist Name Userflow checklist name
checklist_session_id Checklist Session ID A session of a specific user viewing a specific checklist
checklist_version_id Checklist Version ID Userflow checklist version
checklist_version_number Checklist Version Number Userflow checklist version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Checklist Ended

Event name: checklist_ended

A Userflow checklist was ended/closed permanently.

Attribute name Display name Description
checklist_end_reason Checklist End Reason Describes why a checklist ended
checklist_id Checklist ID Userflow checklist
checklist_name Checklist Name Userflow checklist name
checklist_session_id Checklist Session ID A session of a specific user viewing a specific checklist
checklist_version_id Checklist Version ID Userflow checklist version
checklist_version_number Checklist Version Number Userflow checklist version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Checklist Hidden

Event name: checklist_hidden

A Userflow checklist was hidden/minimized.

Attribute name Display name Description
checklist_id Checklist ID Userflow checklist
checklist_name Checklist Name Userflow checklist name
checklist_session_id Checklist Session ID A session of a specific user viewing a specific checklist
checklist_version_id Checklist Version ID Userflow checklist version
checklist_version_number Checklist Version Number Userflow checklist version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Checklist Shown

Event name: checklist_shown

A Userflow checklist was shown/expanded.

Attribute name Display name Description
checklist_id Checklist ID Userflow checklist
checklist_name Checklist Name Userflow checklist name
checklist_session_id Checklist Session ID A session of a specific user viewing a specific checklist
checklist_version_id Checklist Version ID Userflow checklist version
checklist_version_number Checklist Version Number Userflow checklist version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Checklist Started

Event name: checklist_started

A Userflow checklist was started.

Attribute name Display name Description
checklist_id Checklist ID Userflow checklist
checklist_name Checklist Name Userflow checklist name
checklist_session_id Checklist Session ID A session of a specific user viewing a specific checklist
checklist_start_reason Checklist Start Reason Describes why a checklist started
checklist_version_id Checklist Version ID Userflow checklist version
checklist_version_number Checklist Version Number Userflow checklist version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Checklist Task Completed

Event name: checklist_task_completed

A Userflow checklist task was marked as completed.

Attribute name Display name Description
checklist_id Checklist ID Userflow checklist
checklist_name Checklist Name Userflow checklist name
checklist_session_id Checklist Session ID A session of a specific user viewing a specific checklist
checklist_task_id Checklist Task ID Userflow checklist task
checklist_task_name Checklist Task Name Userflow checklist task name
checklist_version_id Checklist Version ID Userflow checklist version
checklist_version_number Checklist Version Number Userflow checklist version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Flow Completed

Event name: flow_completed

A Userflow flow was completed (user saw a goal step).

Attribute name Display name Description
flow_id Flow ID Userflow flow
flow_name Flow Name Userflow flow name
flow_session_id Flow Session ID A session of a specific user viewing a specific flow
flow_step_id Flow Step ID Userflow flow step
flow_step_name Flow Step Name Userflow flow step name
flow_step_number Flow Step Number Userflow flow step number
flow_step_progress Flow Step Progress Userflow flow step progress (% towards goal step)
flow_version_id Flow Version ID Userflow flow version
flow_version_number Flow Version Number Userflow flow version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Flow Ended

Event name: flow_ended

A Userflow flow was ended/closed permanently.

Attribute name Display name Description
flow_end_reason Flow End Reason Describes why a flow ended
flow_id Flow ID Userflow flow
flow_name Flow Name Userflow flow name
flow_session_id Flow Session ID A session of a specific user viewing a specific flow
flow_step_id Flow Step ID Userflow flow step
flow_step_name Flow Step Name Userflow flow step name
flow_step_number Flow Step Number Userflow flow step number
flow_step_progress Flow Step Progress Userflow flow step progress (% towards goal step)
flow_version_id Flow Version ID Userflow flow version
flow_version_number Flow Version Number Userflow flow version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Flow Started

Event name: flow_started

A Userflow flow was started.

Attribute name Display name Description
flow_id Flow ID Userflow flow
flow_name Flow Name Userflow flow name
flow_session_id Flow Session ID A session of a specific user viewing a specific flow
flow_start_reason Flow Start Reason Describes why a flow started
flow_version_id Flow Version ID Userflow flow version
flow_version_number Flow Version Number Userflow flow version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Flow Step Seen

Event name: flow_step_seen

A Userflow flow step was seen.

Attribute name Display name Description
flow_id Flow ID Userflow flow
flow_name Flow Name Userflow flow name
flow_session_id Flow Session ID A session of a specific user viewing a specific flow
flow_step_id Flow Step ID Userflow flow step
flow_step_name Flow Step Name Userflow flow step name
flow_step_number Flow Step Number Userflow flow step number
flow_step_progress Flow Step Progress Userflow flow step progress (% towards goal step)
flow_version_id Flow Version ID Userflow flow version
flow_version_number Flow Version Number Userflow flow version number
page_url Page URL Page URL when the event occurred
viewport_height Viewport Height Height of the user’s viewport (browser window)
viewport_width Viewport Width Width of the user’s viewport (browser window)

Got questions? We're here for you!

The best way to get help is to
We usually reply within 5 minutes
You can also send an email to support@getuserflow.com
We usually reply within a few hours