Use dynamic URLs in guide buttons

You can create more flexible guide experiences by using relative URLs or dynamic web SDK metadata substitutions for the URL Link action in your guide buttons. This helps you send users to the right page in your app, even if the URLs have different subdomains or include user-specific values

Important: This functionality is only available for Web guides and isn't supported for Mobile guides.

Choose the appropriate option

Look at the URL that you plan to use and identify the part of the URL that is dynamic.

• If the subdomain changes but the path stays the same, use a relative URL.
• If the path or query parameters change based on the visitor or account, use web SDK metadata substitution.

Use a relative URL

Use a relative URL when your app runs on multiple subdomains, but shares the same path structure. For example, if you need to direct users to either  https://acme.testapp.com/features or https://omni.testapp.com/features, you could use the relative URL /features instead. 

1. Open your guide in the Visual Design Studio.
2. Select the guide button you want to configure.
3. Set the Action to URL Link.
4. In the URL field, enter the relative path /features 
   
5. Save and test your guide.

When clicked, the guide button automatically pulls in the user's current domain and adds the relative path. 

Use web SDK metadata substitution in guide buttons

Use guide personalization syntax to insert visitor or account-level metadata values directly into the URL. Only web SDk metadata is supported, and the metadata value must be available at the time the guide renders.

Review the available web SDK metadata

1. Open the Pendo Web SDK debugger in your browser.
2. Go to the Config tab.
3. Review the available Visitor ID, Account ID, and metadata values that are displayed. If you don't see the metadata field that you want to use, ask your developers to modify your Pendo installation:
   • Install script instructions
   • Browser extension instructions

Use web SDK metadata in the URL link

1. Open your guide in the Visual Design Studio.
2. Select the button you want to configure.
3. Set the Action to URL Link.

4. Using the guide personalization syntax structure below, modify it for the metadata field you want to reference: 
   
   {[visitor/account].[fieldName]|[optionalFallback]/}

   Example syntax	Expected result
   {visitor.id|1/}	Inserts the visitor ID value and uses the fallback value of '1' if the value is missing.
   {account.region|us/}	Inserts the account field 'region' with 'us' as the fallback value.
   {account.id/}	Inserts the account ID. No fallback value configured.

5. Combine this with the URL and put the final result in the URL field. For example: https://acme.com/{account.region|us/}/dashboard

   

6. Save and test your guide.