Starting Tours

HelpHero Tours can be started in any combination of the following ways:

Auto Start

Tours that have auto start enabled will begin automatically when a user visits a URL for the very first time. This is useful for welcome tours or explaining new functionality. You can enable this setting per tour from the HelpHero editor.

On Demand

Tours with on demand enabled will appear in the HelpHero launcher. The launcher icon will show on a page when there is one or more relevant tours that match the current URL. Users can then use the launcher to activate the tour whenever they wish. You can enable this setting per tour from the HelpHero editor.

You can share a link to a particular tour. This is great for initiating your tours from outside of your app. For example by using a link your tours can be included in emails, your documentation or in chat apps. Links are also a great way to test tours by sharing them with your colleagues before enabling them for your users. Tours can always be started from a link regardless of how auto start and on demand are configured.

Intercom Messenger

If you are using Intercom you can display your tours from both the Intercom Messenger Home and Intercom Messenger Conversations. Learn more about integrating with Intercom

Javascript API

Tours can be started from your own code via the HelpHero Javascript API. This is useful for more advanced use cases where you need greater control of when tours start. For example you may want to start a tour on a click to a particular element for example:

<a href="#" onclick="HelpHero.startTour('<TOUR_ID>')">Start Tour</a>

Or you may want to start tours in respond to an event in your system. Tours can always be started from the Javascript API regardless of how auto start and on demand are configured.

Where do I find the ID of a Tour?

If you want to start a Tour via the Javascript API you will need it's ID. You can get the tour ID of any tour you create from the HelpHero Editor.