Trigger a tour by URL or event

Updated May 22, 2026

Product tours use exactly the same trigger engine as banners, messages, and surveys. You set a trigger event, optional page rules, and optional visitor conditions. Yaplet evaluates all of them and shows the tour only when everything matches.

Common trigger patterns for tours

Goal Trigger setup
Show once to brand-new users when they log in for the first time Trigger: Session start. Visitor condition: Session count = 1. Frequency: Show once per visitor.
Show when a user lands on a specific dashboard page for the first time Trigger: Page view. Page rule: URL contains /dashboard/feature-name. Frequency: Show once per visitor.
Launch the tour from a "Take the tour" button in your UI Trigger: Custom event (start-tour). Set to Always trigger to bypass the frequency cap — the tour re-runs every time the button is pressed.
Show only to users on the Pro plan who haven't used a feature yet Trigger: Session start or Custom event. Visitor condition: Plan = pro. Frequency: Show once per visitor.
Show after the user has been on the page for 10 seconds Trigger: Page view. Time on page: 10 seconds.

Triggering from a "Take the tour" button

The most powerful pattern for product tours is letting users re-launch them on demand. To do this:

  1. Add a button or link in your product UI labelled "Take the tour" or "Replay tutorial".
  2. On click, call Yaplet.trackEvent("start-tour-feature-name").
  3. In the tour's trigger settings, set the event to that exact event name and enable Always trigger.

This lets users who dismissed the tour by accident come back to it — and lets support point confused users to it ("just click 'Take the tour' in the top-right corner").

Delay before the first step

Add a delay (in seconds) to the trigger event to give the page time to fully render before the first step appears. This is especially useful for SPAs where the target DOM element loads after the navigation event — a 1–2 second delay usually prevents "element not found" fallbacks.

Full trigger documentation

For every condition type, operator, and AND/OR logic option, see Trigger rules. The frequency cap options are covered in Frequency caps.

What's next?

Check your tour's performance in Campaign analytics — impressions, completions, and per-step drop-off rates tell you which steps visitors are abandoning.

Did this article answer your question?