WalkMe Item Events and Defintions
Brief Overview
When your users see or interact with WalkMe content, those actions are captured as events. These events are what power WalkMe Insights, helping you understand how your content is being experienced across your applications.
Every WalkMe item — from Smart Walk-Thrus to ShoutOuts, Launchers, Surveys, and more — generates specific events that represent exposure (the item was displayed to the user) or interaction (the user actively engaged with it).
By collecting these events, Insights allows you to:
-
Track how many users were exposed to WalkMe content
-
Measure how users engaged with that content
-
Use this data in reports, system dashboards, and Flow Analytics to improve adoption and optimize your solutions
The table below lists all standard WalkMe item events and their definitions.
WalkMe Item Event Definitions
WalkMe Item | Event | Definition | Notes |
Smart Walk-Thru | Play | A flow has started | The flow can start from any SWT step |
Smart Walk-Thru | Play Failed | The user tried to play the SWT and it didn't play | |
Smart Walk-Thru Step | Play | A flow has started | The flow can start from any SWT step |
Walk-Thru | Play | A flow has started | The flow can start from any Walk-Thru step |
Walk-Thru | Play Failed | The user tried to play the Walk-Thru and it didn't play | |
Walk-Thru Step | Play | A Walk-Thru step has started | The flow can start from any Walk-Thru step |
Task | Play | The user clicked the task | |
Task | Complete | The main goal was reached | A task can be completed without being initiated from Onboarding Task list. We will receive a 'task completed' event without the preceding 'play' event |
ShoutOut | Play | The ShoutOut was shown/visible to the user | |
ShoutOut | Click | The user clicked on the ShoutOut | |
ShoutOut | Close | The user clicked the X button / close button | |
ShoutOut Action | Click | The user clicked on a ShoutOut Action (usually a button) | |
ShoutOut Action | Close | The user closed via a ShoutOut Action (For example, 'Remind Me Later' button) | |
Launcher | Play | The Launcher was shown/drawn on the page | We send a 'Play' event for each Launcher drawn once per session |
Launcher | Click | The Launcher was clicked on | |
Resource | Play | The user clicked on the Resource | 'Play' can be triggered by another WalkMe Item/Menu |
Shuttle | Play | The user clicked on the Shuttle | 'Play' can be triggered by another WalkMe Item/Menu |
Survey | Play | The Survey was viewed | 'Play' can be triggered by another WalkMe Item/Auto-start |
Survey | Submitted | The user submitted the Survey | User must click Submit to complete and send survey |
Survey | Close | The Survey was closed | |
Survey Question | Submitted | The user submitted a Survey question | |
SmartTip | Play | The SmartTip was shown/drawn on the page | Play sent once per session |
SmartTip | Visible | The user hovered over the SmartTip | |
SmartTip | Passed | Validation passed | |
SmartTip | Failed | Validation failed | |
SmartTip | Click | The user clicked an element that hides a guidance SmartTip | Click always comes with a Visible event |
Menu | Open | The user opened the WalkMe Web Menu | Open can be triggered by click or API |
WidgetSearch | Search | An event that is sent after the user stopped typing for ~3 seconds | |
WidgetSearch | Click | The user clicked on a search result | |
Help Desk | Play | The user clicked on the Help Desk | |
Live Chat | Click | The user clicked on the Live Chat | |
ActionBot | Chat Opened | The user opened ActionBot | |
ActionBot | End User Engaged | The user sent a message to ActionBot | |
ActionBot | Chat Closed | The user closed ActionBot | |
ActionBot | Conversation Search | The user searched for conversation topics | |
ActionBot Conversation | Conversation Started | The user started a conversation | |
ActionBot Conversation | Conversation Ended | The user ended a conversation | |
ActionBot Node | Conversation Action Triggered | An ActionBot node action was triggered | |
ActionBot Node | Conversation Question Answered | An ActionBot node question was answered | |
ActionBot Node | Conversation Node Served | An ActionBot node was served | |
TeachMe | Visible | The TeachMe widget first appeared on the page (sent once every 24h) | Refresh won't trigger another event for 24h |
TeachMe | Open | The user opened the TeachMe menu | |
TeachMe | TeachMe Step Started | A user started a TeachMe item from a course | |
TeachMe Quiz | Play | The quiz was started by the user | |
TeachMe Quiz | Submitted | The quiz was submitted by the user | |
TeachMe Quiz | Passed | The user passed the quiz after submission | Event triggered whether or not the user passed or failed the quiz |
TeachMe Quiz | Failed | The user failed the quiz after submission | Event triggered whether or not the user passed or failed the quiz |
TeachMe Quiz Question | Submitted | The quiz question was submitted by the user |