Documentation

Tours

Understanding tour structure and configuration

What is a Tour?

A tour is a guided walkthrough of your application. It consists of multiple steps, each highlighting a specific element on your page with a tooltip explaining its purpose or how to use it.

1

Steps

Individual highlights in your tour

2

Targeting

When and where tours appear

3

Appearance

How your tour looks

Tour Properties

Namestring

A descriptive name for your tour (e.g., 'Onboarding Tour')

Descriptionstring

Optional description explaining the tour's purpose

Statusdraft | active | paused

Controls whether the tour is visible to users

Target URLstring

The page URL where this tour should run

Tour Lifecycle

Draft
Active
Paused
Draft

Tour is being built. Not visible to users.

Active

Tour is live and visible to users based on targeting rules.

Paused

Tour is temporarily hidden but can be reactivated.

Next: Tour Steps

Learn how to create and configure individual steps

Continue