Starting and stopping Smart Walk-Thrus can be done by utilizing the following client APIs. Some example usages:

  1. Starting a Smart Walk-Thru with a custom element
  2. Starting a Smart Walk-Thru at an intermediary step when certain conditions are met
  3. Stopping a Smart Walk-Thru when certain conditions are met
WalkMeAPI Functions
WalkMeAPI.getFlows() Returns an array of all published Smart Walk-Thrus.
WalkMeAPI.startFlowById(FlowId, stepNodeId) Start a Smart Walk-Thru by its Id with an option to start a specific step.
WalkMeAPI.stopFlow(FlowId) Stop a Smart Walk-Thru.
// Example Smart Walk-Thru Object
  ConditionTrees: {...},
  Description: null,
  Flow: {...}, // Contains each step (node) metadata
  FlowId: 664,
  Goals: [{...},{...}],
  HasMainGoal: false,
  Id: 12445, // Smart WalkThru Id
  IsFlow: true,
  KeyWords: "",
  Name: "How to Use the WalkMe API",
  OrderIndex: 5,
  Settings: {...},
  SmartTips: [],
  Surveys: [],
  deployableType: 19,
  userGuid: "3210abcde"
// Start a Smart Walk-Thru from the beginning         
// Start a Smart Walk-Thru from a specific step         
WalkMeAPI.startFlowById(12445, 4016);