Overview

A walkthrough starts in one of two ways: automatically on its target page, through its Launch Triggers (on by default for new walkthroughs, shown Only Once per user), or from a Control Walkthrough action. At runtime, you drive it with two actions wired to events:

Control Walkthrough — starts or stops the whole tour.
Control Step — moves forward or back one step within a running tour.

Like the Walkthroughs tab, both actions are available for web apps only. They are not offered in the mobile app builder. See Walkthroughs Overview.

Launch Triggers

Launch Triggers start a walkthrough automatically when a user opens its target page. They are on by default for every new walkthrough. Once the walkthrough is Active and the app is published, it starts by itself on its target page for every user.

To change them, open Settings in the walkthrough builder's left side nav and select Launch Triggers (Target Audience and Activation Window are covered in Building a Walkthrough):

Enable Launch Triggers — turns automatic start on or off. Turn it off if the tour should start only from a Control Walkthrough action.
Set Display Frequency — how often the same user sees the tour: Only Once (default), Once in a Session, Once in 1 Day, Once in 7 Days, Once in 30 Days, Once in 90 Days, or Always.
Display Priority — Low, Medium (default) or High.

Control Walkthrough Action

The Control Walkthrough action launches, ends, or coordinates timing for a guided tour on the current app.

Inputs

Field	Type	Required	Description
Select Walkthrough (`walkthroughId`)	`string`	Start Walkthrough only (required)	Which walkthrough to start. Ignored by every method except Start Walkthrough.
Method (`method`)	`enum`	Optional	What to do. Defaults to Start Walkthrough.

Methods

Method	What it does
Start Walkthrough (`startWalkthrough`)	Launches the selected tour. Stops any running walkthrough first. Requires Select Walkthrough.
Stop Walkthrough (`stopWalkthrough`)	Ends the current tour and removes all highlights and the backdrop.
Acknowledge Pre-Start (`ackPreStart`)	Page signals it needs setup time before the tour starts. Fire it within 1 second of the trigger, so make it the first action; the tour then waits up to 10s for Complete Pre-Start.
Decline Pre-Start (`declinePreStart`)	No setup needed — start the tour immediately. Fire it within 1 second of the trigger, otherwise the tour starts anyway.
Complete Pre-Start (`donePreStart`)	Page is ready; the tour can begin. Use only after Acknowledge Pre-Start.
Acknowledge Pre-End (`ackPreEnd`)	Page signals it needs cleanup time before the tour ends. Fire it within 1 second of the trigger, so make it the first action; the tour then waits up to 10s for Complete Pre-End.
Decline Pre-End (`declinePreEnd`)	No cleanup needed — end the tour immediately. Fire it within 1 second of the trigger, otherwise the tour ends anyway.
Complete Pre-End (`donePreEnd`)	Cleanup done; the tour can finish. Use only after Acknowledge Pre-End.

Note: The six handshake methods (ackPreStart, declinePreStart, donePreStart, and the pre-end variants) coordinate timing between the tour and the page — for example, letting the page open a panel before a tooltip tries to anchor to an element inside it. For most tours, you only need startWalkthrough and stopWalkthrough.

The handshake methods are fired from two page triggers: On Walkthrough Pre Start fires just before a walkthrough begins on the page, and On Walkthrough Pre End fires just before it ends. Add them in the page's settings under Interactions. See Loading States & Triggers.

Example — open a drawer before the first tooltip

On the walkthrough's target page, add the On Walkthrough Pre Start trigger.
Add Control Walkthrough with Method Acknowledge Pre-Start as the first action, so the tour waits. The tour waits only 1 second for Acknowledge or Decline before it starts anyway.
Add the actions that prepare the page, for example Control Drawer to open the drawer the first step points at.
End with Control Walkthrough set to Complete Pre-Start. The tour then begins. The tour waits up to 10 seconds for this call.

Control Step Action

The Control Step action moves a running tour forward or back one step. Wire it to the Next and Back buttons inside a step's message to build step navigation.

Method	What it does	Edge case
Next Step	Advances to the next step in the tour. If on the final step, completes the walkthrough.	Advancing past the final step ends the tour and marks it completed. There is no "stay on the last step."
Previous Step	Goes back to the previous step.	On the first step, the tour overlay closes without the tour being marked completed. Don't show a Back button on step 1 (use a run condition on hasPreviousStep).

Warning: One more Next Step from the final step completes the walkthrough — it does not loop or stay open. Label the final step's button Finish or Done rather than Next, so users understand that pressing it ends the tour.

Wiring Controls: Step-by-Step

Adding a Start Trigger

Add a "Take the tour" button to your page: Or use an existing element — a nav item, a help icon, a page load event.
Open its On Click event in the interaction panel: Select the element, go to Events, and open the On Click event (or On Load for a page load trigger).
Add the Control Walkthrough action: Choose Control Walkthrough from the action picker. Set Method to Start Walkthrough and choose the tour in Select Walkthrough.

Adding Next and Back Buttons Inside a Step

Add a button in the step's message canvas: In the walkthrough builder, with the step selected, add a Button block to the step's message content area. Label it Next (or Finish for the last step).
Open the button's On Click event: Select the button in the step's message canvas and open its interaction panel.
Add the Control Step action: Choose Control Step and set Method to Next Step. For a Back button, add a second button and set Method to Previous Step.

How a Tour Finishes

A tour finishes when the user advances past its last step. There is no "stay on the final step" — one more move forward from the end closes the walkthrough and marks the run completed. In the published app, the completion is recorded with a timestamp and a status.

Progress and Session Tracking

In the published app, each user's run of a walkthrough is tracked as a session. The session records:

Which step the user is currently on.
Which steps they have completed.
An overall status.

Status	Meaning
`in_progress`	The tour is currently running for this user.
`paused`	The tour was started, but the user left its target page before finishing. When the tour resumes, it continues from where the user left off.
`completed`	The user advanced past the final step.
`stopped`	The tour was ended early via `stopWalkthrough`.
`skipped`	The tour was skipped by the user.

These session records allow a tour to resume where the user left off and let you understand who has finished the tour.

Warning: Preview sessions in the builder and the builder itself run the tour visually but record nothing — no session, no completion, no resume. "Has this user seen the tour" logic only works for real end users of the published app.

Gotchas

Control Step does nothing without a running tour

The Control Step action only moves through a tour that is actively running. If no walkthrough is playing, firing Control Step does nothing — it will not start a tour. Always pair it with a Control Walkthrough action that starts the tour first.

Starting a tour stops any running one

startWalkthrough always ends the currently active tour before launching the selected one. Two tours never run simultaneously. If a user is mid-way through Tour A and a trigger fires to start Tour B, Tour A is cancelled and Tour B starts.

startWalkthrough without an ID does nothing

If Method is Start Walkthrough but no walkthrough is chosen in Select Walkthrough, or the bound value is empty at fire time, the action logs a console error and does nothing — no tour launches, no visible error. Always check that Select Walkthrough has a value before firing.

Start Walkthrough needs an Active, published walkthrough

Start Walkthrough only launches a walkthrough that is Active and has been published at least once. Otherwise nothing happens and no error is shown.

The start action must run on the walkthrough's Target Page. A page loads only its own walkthrough, so a Start Walkthrough action for a tour that belongs to another page does nothing, with no error. To run a tour that belongs elsewhere, navigate to its Target Page first and start it from that page's load event.

Example — First-visit onboarding on page load

You want a tour to start automatically the first time a user visits a page:

In the walkthrough builder, open Settings → Launch Triggers and leave Enable Launch Triggers on.
Keep Set Display Frequency at Only Once, so each user sees the tour once.
Set the walkthrough to Active and publish the app.

You don't need an On Load event or your own "has completed the tour" check — Only Once already keeps the tour from repeating for the same user.

Walkthroughs Overview — what walkthroughs are and the Walkthroughs manager tab.
Building a Walkthrough — the builder where step buttons are added, and the full Settings reference.
Steps & Targeting — how to configure a step's message, including adding buttons.
Loading States & Triggers — the On Walkthrough Pre Start and On Walkthrough Pre End page triggers.
Events & Actions Overview — the full action catalogue.

Controlling a Walkthrough