Tour Links

Tour links are great for sharing your tours in different contexts for example you could include a link to a tours in emails, your documentation or chat apps. While in most cases you can use the link provided by HelpHero as is, this doc details some cases where you may need to tweak the link.

Query String Parameters

In some cases you may want a tour to start on a page with certain query string parameters. The URL Match does not support adding query string parameters as this is handled using Funnels. However you can append your query string parameters directly to the tour link provided by the HelpHero Editor.

For example lets say you want your tour to start on /examples/demo/home/?settings=1

You can append this to the end of the tour link https://hlp.sh/t/Fv6n4/RY3Ln5ejfjL?settings=1

URL Match Variables

URLs can often contain dynamic parts such as generated IDs, user names, categories, etc. We can introduce a variable to represent these dynamic segments of a URL.
For example:/examples/demo/order-history/#/edit/{order_id}

To redirect the tour link to a specific order ID you can append ?~order_id=10003 to the end of the tour link https://hlp.sh/t/Fv6n4/5iHOJVlWT9h?~order_id=10003

This same technique can be use to redirect the tour link to a specific subdomain. For example if you have a URL Match that contains your domain://{customer}.mysite.com/somepage
To redirect the tour link to a specific customer you can append ?~customer=amazon to the end of the tour link.

Relative URL

If you have multiple domains you want your tours link to run on. You can modify the URL to be relative to the site that the link is click on from. Note that this is an advanced usecase and generally we recommend using a URL Variable instead. Using this technique means the link will only work when clicked on from within the site. Altering the tour link in this way means it can no longer be bookmarked or shared via email or pasted directly into the browser.

For example if you have a URL link https://hlp.sh/t/Fv6n4/RY3Ln5ejfjL

Replace the emphasised part of tour link with a + https://hlp.sh/t/+/RY3Ln5ejfjL