Guide Personalization

Overview

Guide personalization allows you to incorporate visitor and account Pendo metadata in text building blocks in mobile guides or code blocks in web guides. Select a guide content property to add a variable in your guide copy. These variables automatically pull in metadata from the Pendo visitor or account, or fallback text if no metadata is available. For example, you can use guide personalization to greet your users with their name during onboarding, confirm user information in a modal, or include their role or status as a dynamic part of in-app training.

guidepersonalization.png

 

Requirements

  • Mobile guides on SDK 2.14 or greater
  • Web guides in code blocks
  • Guide Creator, or Content Editor user roles

Using a guide content property

A guide content property is a coded variable that is replaced by the visitor or account metadata value when the guide displays. For example, Hi, <%=visitor.agent.name%> displays as Hi, Jane Doe when visitor.agent.name = "Jane Doe".

Use fallback text as a default value when a visitor or account does not have a value for that metadata. For example, Hi, <%=visitor.agent.name%> displays as Hi, earliest of adopters when the fallback text field is set to "earliest of adopters".

Only visitor and account metadata passed to Pendo during the mobile session is available as a property. Data stored in Pendo which was passed in a previous session or from integrations (Salesforce/segment.io/etc) cannot be used for guide personalization.

 

Mobile guides

Guide content properties can be used in any text building block, including text building blocks and poll questions. Properties are added in the General section of the Edit Text modal with other text editing.

1. Click on the "Select a property" dropdown.

propertydropdown.png

 

2. Select the property you want to include in the guide. The coded variable is added in-line at the text cursor. You can use as many properties as you want.

Propertycopy.png

 

3. Add fallback text. This text is used when the visitor or account metadata doesn't have a value to avoid confusing gaps in your copy. Fallback text is not required. Leave the field blank and the variable code will be removed automatically with nothing in its place.

Fallbacktext.png

 

4. Click Done to save text changes.

mobileguidedone.png

 

5. Test the guide. Use View Step Design or Test Full Guide with Activation and make sure you see the personalized property on your device.

PreviewGuide.png

 

Frequently Asked Questions

How can I guarantee data will display?

To verify the property will appear when needed, make sure the property you want to show in the guide is sent prior to guide activation during the same session. Data passed during initialization will be available. If needed, you can update visitor and account metadata during the session by using the dedicated APIs setVisitorData and setAccountData.