Skip to main content
Triggering Tours

How to trigger a Candu Tour on page load, from clicking other Candu content or from Javascript

Flora Sanders avatar
Written by Flora Sanders
Updated over 5 months ago

Now that you've created your Tour, it's time to decide whether you want the Tour to automatically show to your users when they land on the page or whether you want them to opt into the experience!

Triggering Tours can be done one of three ways:

Triggering Tours from page load

If you want the Tour to display on the page load automatically, hit Publish > then you have two options:

  1. Click 'Use Placement' to target the URL used for the Snapshot. Clicking 'Use Placement' will launch your content immediately.

  2. Click 'here' to customize your placement. This will take you to the Settings/Placements tab where you can add your own rules, then hit Publish and choose which segment/s you want to make live.

GIF showing adding a placement

If you want the Tour to be triggered on Candu CTA click or programmatically triggered, you can...

  1. Hit Publish

  2. Choose with segment/s you want to publish.

  3. Click "Publish without a placement for Tigger Content & Change Content" to push your Tour live without a placement:

GIF showing the publish without placement journey

Triggering Tours from Candu CTAs

If you want to create an opt-in experience, e.g. a contextual help CTA that triggers a Tour or an Overlay with an option to begin a Tour:

Example of live Inline Candu content, which triggers a Tour

You'll need to create your Inline or Overlay experience, with a CTA to start a Tour. Select that CTA and head to the Interactions tab, where you'll add the 'Trigger Tour' action:

Screenshot showing the Inline content that will Trigger your Tour

Select your published Tour from the dropdown:

Screenshot showing the Trigger Tour drop down in the Interactions tab

Test out your content in the wild - the Tour should reappear whenever that CTA is clicked and begin from Step 1:

GIF showing click to trigger Tours

Triggering Tours programmatically

Now, that your Tour is published, you can check out our developer docs on triggering Candu Tours programmatically from Javascript ➡️

Did this answer your question?