Create a guide permalink

Last updated:

Note: This article is relevant for Visual Design Studio and Classic Designer.

A permalink (permanent link) is a web address that leads to a specific web page and is designed remain unchanged over time. You can use permalinks when creating a guide. The permalink is embedded in the guide steps so that you can launch a guide at a specific step for a user who has already seen part of the guide. For example, if a user has already seen step 1 and step 2 of a guide, manually add a permalink to take them to a specific step, such as step 3.

Copy permalink string

This section details how to access and copy the permalink string in the Visual Design Studio and the Classic designer. After copying the permalink from either of the designers, you can then add it to the page URL.

Visual Design Studio

After creating a guide:

  1. Set the status to Public and navigate to the guide's details page in the Settings tab.
  2. In the top-right corner, select the ellipsis (...) and then select Permalinks.

    permalinks.png
  3. In the Permalinks dialog, copy the link of the required step and add it to the URL of the specific step. The string looks something like ?pendo=123123123123. This string is the unique identifier for the guide or step you're on.

    specify_step_permalinks.png

Classic designer

After creating a guide through the normal guide creation process:

  1. Set the guide status to Public.
  2. Navigate to the guide's details page.
  3. Copy the string in the Permalink field. The string looks something like
    ?pendo=123123123123. This string is the unique identifier for the guide you're on.
permalink2.png

Display criteria

Guide permalinks are subject to standard guide visibility restrictions:

  • The visitor is included in the guide segment.
  • The Page matches the location of the first (or only) step of the guide.
  • The matched element is visible (if applicable).
  • The scheduled date is in range (if applicable).
  • The guide is set to Staged or Public status.

If the visitor doesn't meet the criteria required, then the guide doesn't display, even if a permalink URL is used.

Note: The permalink overrides the activation type of your guide. For example, if your guide has Automatic activation and a visitor has already seen the guide and selects the permalink, they will see the guide again.

Login redirects

If your app drops parameters on login, and your user isn't logged in when they select the link, the guide doesn't appear, as they haven't yet been identified by Pendo. In this case, you can ask your users to ensure they're logged in before selecting the link.

Dynamic URLs

If your app has URLs that contain IDs that change from user to user or session to session, then this feature is difficult to use on those URLs as you can't create a URL that can be shared with all users.

For example, let’s say you have a Page for reports that has a URL of: https://app.acme.com/report/4820829203/details

This example URL included the dynamic user ID of 4820829203. You can create and use a permalink for an individual user to share with them, but can't create a permalink to share with all of your users in that situation.

For this scenario, we suggest you start a guide at a place in the app that doesn't have the dynamic URL, such as: https://app.acme.com/reportListand then use the walkthrough guide with the permalink to walk the user to their own specific report detail Page.

Was this article helpful?
7 out of 16 found this helpful