Walkthroughs Overview

What Are Walkthroughs?

A walkthrough is a guided product tour you build for your own app: an ordered sequence of steps that plays on top of your pages, pointing at real parts of the screen and explaining what they do. Each step is either a tooltip pinned to something on the page or a modal floating over it, and while a step is showing, the rest of the page sits behind a dimmed backdrop so attention lands where you aimed it.

You design the tour once in a dedicated walkthrough builder; every user of the published app can then be taken through it. Only one walkthrough runs at a time — starting a new one stops whatever tour was already running.

Note: Walkthroughs are a web app feature. The Walkthroughs tab and the walkthrough actions (Control Walkthrough, Control Step) are available for web apps only — not for mobile, Copilot or Display apps, modules or packages. See App Overview.

Common Use Cases

• First-time onboarding — walk new users through the most important features when they first sign in.

• Feature announcements — draw attention to a newly released capability and explain how to use it.

• Complex flow guidance — guide users through a multi-step process (e.g. creating a record, configuring settings) to reduce errors and support tickets.

• Role-based orientation — tailor tours to different user roles, highlighting tools relevant to each audience.

• Training & compliance — ensure all users complete a guided introduction to key parts of the app.

The Walkthroughs Tab

The Walkthroughs tab on your app's detail page lists every walkthrough you have built. If none exist yet, it shows the empty state: "No Walkthroughs Found — You haven't created any interactive walkthroughs for your app yet."

List Columns

The toolbar above the list also has Filter and Sort, and a hidden-columns control (for example, "4 hidden columns") where you choose which columns the list shows.

Row Actions

Click a row to open the walkthrough builder. Each row's ⋮ menu has two actions:

• Edit — rename the walkthrough or change its description. Target Page and Screen Variants are locked.

• Delete — permanently remove the walkthrough.

The Status column is read-only. To activate or deactivate a tour, use the Active/Inactive switch in the walkthrough builder header.

Creating a Walkthrough

Click Create Walkthrough to start building a new tour. The creation flow asks for:

1. Set the details: Give the walkthrough a descriptive Name (shown in the list) and an optional Description. Select the Target Page the tour will run on, and the Screen Variants (desktop, tablet, mobile) it applies to. These are locked after creation — the tour's steps are tied to the page and variant you choose here.

2. Choose a template: Pick a starting template — Tooltip Templates (steps anchored to page elements) or Modal Templates (floating overlay cards) — and click Create. The template becomes the new tour's default step layout.

3. Build the steps: The walkthrough builder opens. Add and configure each step. See Building a Walkthrough for the full builder reference.

Warning: Once you create a walkthrough, the Target Page and Screen Variants cannot be changed — the steps are tied to the page structure you chose. If you need a tour on a different page, create a new walkthrough for that page.

How Walkthroughs Work

Every walkthrough comes down to three pieces:

Controlling Walkthrough Status

Each walkthrough has an Active / Inactive status. You change it with the Active/Inactive switch in the walkthrough builder header; the Status column in the list only displays it. Use it to:

• Keep a tour Inactive while building and testing it — inactive tours will not run for real users, even if the app is published.

• Activate a tour when it is ready to go live for users.

• Deactivate a tour to stop showing it without deleting it — useful for seasonal tours or tours tied to a specific feature release.

Key Things to Know

Only one walkthrough runs at a time

Starting a new walkthrough stops whatever tour was already running. Design your flows so tours don't conflict — avoid situations where multiple start triggers could fire simultaneously.

Active tours start automatically

New walkthroughs have Launch Triggers on, so an Active tour starts by itself on its target page in the published app, once per user by default. To change this, open Settings → Launch Triggers in the walkthrough builder. Covered in Controlling a Walkthrough.

Steps block interaction by default

A step blocks clicks on the page and on the highlighted target by default. If a step says "now click Save", you have to turn on interaction for it — otherwise the tour asks for something it won't allow. Covered in full on the Steps & Targeting page.

Missing targets are silently skipped

A tooltip step whose target isn't on screen is skipped by default. A published tour can therefore show fewer steps than you built — for example a step targeting a block only visible to admins will be skipped for regular users. Configure the step's missing-target behavior if this is a concern. Covered in Steps & Targeting.

Progress is only recorded in the live app

Which step a user has reached, whether they finished — this is recorded only in the live published app, never in preview or in the builder. Test your tour visually in the builder, then confirm session tracking behavior in the live app.

In This Section