Skip to main content

Triggering Tours with URL Parameters

Launch tours automatically using URL links. Learn how to use Candu's built-in tour parameter for email campaigns, help docs, and cross-page experiences.

Deborah Ramírez avatar
Written by Deborah Ramírez
Updated today

URL parameters let you launch tours automatically when users click a link. This is perfect for:

  • Email campaigns: Send users directly to a page and show the tour automatically

  • Help documentation: Link from support articles to guided walkthroughs

  • Cross-page triggering: Start a tour on Page B from a button on Page A

  • Onboarding sequences: String together experiences across multiple pages

How to Trigger Tours with URL Parameters

URL parameters let you trigger tours on different pages than where a button lives. For example, you have a "Learn More" button on your dashboard that should start a tour on your projects page.

Candu has a special parameter that automatically launches any published tour. Add canduTour=[YOUR-SLUG] to any URL, and the tour will start automatically when users visit that URL.

  1. Open your tour in the editor

  2. Go to Settings > General tab

  3. Look for the "Slug" field

  4. Copy the slug (example: dashboard-onboarding-tour)

Construct Your URL

Add #canduTour=[YOUR-SLUG] to our URL. Candu supports both ? and # for compatibility with different URL routing approaches. Both formats work:

Hash format:

https://yourapp.com/page#canduTour=dashboard-onboarding-tour

Search parameter format:

https://yourapp.com/page?canduTour=dashboard-onboarding-tour

And that's it! You can now use this URL anywhere, including Candu CTAs. When users click the link, they'll land on the page and the tour will start automatically.

Important: Some single-page applications may "swallow" or remove URL parameters during route changes, preventing your tour from triggering.

The same parameter approach works for other Candu content:

  • Modals: #canduModal=[YOUR-SLUG]

  • Hotspots: #canduHotspot=[YOUR-SLUG]

Did this answer your question?