Skip to main content

Tour settings

Tour url​

The most important setting for a tour is the url. You have to define a url for each tour, to tell on which website and page it should appear on

Dynamic urls​

Sometimes you might have an url that changes, for example, per user. Produktly supports dynamic urls, you just have to mark the parts of the url that are dynamic by enclosing them in these brackets {}. You can also define multiple dynamic parts of the url.

For example, if you have an url like https://example.com/users/321, and the 321 might change, you would enter https://example.com/users/{321} to the tour url.

Tour start​

This configures when the tour should be started. There are three options:

  • Star tour immediately: This will start the tour immediately when the page is loaded.
  • Start tour minified: This will show a beacon on the bottom-right corner of the website, with the "Start tour" text. The user can then decide if and when they want to start the tour. They just simply click the "Start tour" and then the tour will start
  • Start tour manually: If you only want to start the tour manually with code, you can select this option. This means that the tour won't show up anywhere, unless your start it with window.Produktly.startTour({tourId: tourId}). See more at Start tour with code

Tour trigger​

This further configures when the tour should be triggere. There are two options:

  • Once for user: The tour will be shown only once for each user. So when the user finishes the tour they will no longer see it
  • Always: The tour will always show up for every user, regardless of if they have already completed it or not

Save user progress​

This configures if each user's tour progress is saved.

If this is set to "Yes", the tour progress will be saved. So if for example user starts the tour and advances to step 3, then leaves the page and visits it again after some time, the tour will be started on the step 3.

The other option is to set it to "No". In which case the tour will always start from the first step, even if user already started the tour earlier.

Element highlight timeout​

When using the highlight step type, the tour will try to find that element for the time specific in this timeout setting. So if you set it e.g. 5 seconds, the tour will try to find that element for 5 seconds, and then either skip or default to showing a static modal. All websites/webapps are different, so this is useful for making sure the experience stays smooth and engaging.