DocsGetting started

Core concepts

Sites, walkthroughs, steps, the launcher, the welcome card and views — the vocabulary used everywhere else.

Site

A site is one website or app you want tours on. Every site has a platform — Web, iOS App, Android App or React Native — and a unique site key (it looks like sk_ab12cd34ef) that the embed script or SDK uses to fetch that site’s tours. Styles are set per site, so every tour on a site shares the same look.

Web sites have a domain; app sites have a package or bundle ID (for example com.mycompany.myapp).

Walkthrough (tour)

A walkthrough — we use “tour” and “walkthrough” interchangeably — belongs to one site and loads on the pages (or app screens) that match its page path. It has a list of steps, an optional welcome card, an optional splash carousel, launch settings and display conditions. A walkthrough is either active (live) or inactive.

Step

A step is one stop on the tour: a title, a short description and a target. On the web the target is a CSS selector; in apps it’s an identifier you attach to a view in code. While a step is showing, its target is spotlighted, a beacon marks it, and a tooltip card shows the text with Prev / Next buttons and progress dots.

Launcher

The launcher is the floating button that opens a tour. On the web you can place it in any corner or edge centre; in apps it sits bottom-left or bottom-right. It can start minimised as a small tab on the edge of the screen. Its label, icon and colours are configurable.

Welcome card

The welcome card introduces a tour before it starts: an emoji, a title, a short message, a call-to-action button (“Yes, show me around!”) and a dismiss link (“Don’t show again”). You can turn it off so the launcher starts the tour directly.

An optional set of intro slides — image, logo, title, description — shown before the tour. Included on the More and Too Many plans.

Views

A view is counted each time a tour is presented to a visitor (the guide_shown event). Your plan includes a number of views per calendar month, shared across all your sites. See how views are counted.

Visitor memory

Tooltip Tour doesn’t identify your visitors. On the web, things like “has dismissed this tour” or “has seen it three times” are remembered in the visitor’s own browser storage; the apps keep the same on the device. Clearing browser data, or visiting on another device, starts fresh. Details in the embed reference.

Something missing or unclear? Tell us and we’ll fix the page.