For AI agents: visit https://developer.walkme.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
WalkMe Events
PlayerInitComplete
Triggered after the WalkMe Player is fully loaded.
NewStepShown
Triggered when the next step balloon is shown.
LauncherIsShown
Triggered after the launcher element is shown.
TaskCompleted
Triggered after a task is completed.
TasksLoaded
Triggered after tasks is fully loaded.
wmLauncherClicked
Triggered when the launcher element is clicked.
SurveyCompleted
Triggered when a survey is completed.
SurveyPlayed
Triggered when a survey is started.
BalloonCreated
Triggered after the balloon element is shown.
WalkthruAborted
Triggered when a Walk-Thru is aborted.
UserStoppedWalkthru
Triggered when a user stops a Walk-Thru, before a Walk-Thru stops.
UserStoppedWalkthruAfterStop
Triggered when a user stops a Walk-Thru, after the Walk-Thru stops.
WalkthruFailedToStart
Triggered when a Walk-Thru fails to start.
BackButtonClicked
Triggered when the "Back" button on a step balloon is clicked.
NextButtonClicked
Triggered when the "Next" button on a step balloon is clicked.
DoneButtonClicked
Triggered when the "Done" button on a step balloon is clicked.
BBCodeLinkClicked
Triggered when a BBCode Link on a step balloon is clicked.
JavaScript
var importantTaskId = 123456;
window.walkme_event = function(eventData) {
if (eventData.Type === "SurveyCompleted") {
if (eventData.ExtraData.TaskId == importantTaskId) {
alert("Important task completed");
}
}
}