Guide personalization allows you to incorporate visitor and account Pendo metadata in text building blocks for mobile guides. 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. Use a guide content property to add a variable to your guide copy. These variables automatically pull in metadata from the Pendo visitor or account, or you can add fallback text if no metadata is available.
Requirements
- Mobile guides on SDK 2.14 or greater
- Guide Creator or Content Editor user roles
Use a guide content property
A guide content property is a coded variable that's replaced by the visitor or account metadata value when the guide displays. For example, Hi, <%=visitor.agent.familyname%> displays as Hi, Jane Doe when visitor.agent.name = "Jane Doe".
Use fallback text as a default value when a visitor or account doesn't have a value for that metadata. For example, Hi, <%=visitor.agent.familyname%> 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) can't be used for guide personalization.
Guide content properties can be used in any text-building block or poll questions. Properties are added in the Guide Content section of the Edit Text modal.
To personalize your guide using a guide content property:
- In the left-side menu, go to Guides > Guides.
- In the Guides list, in the All Apps list, select Mobile Apps to filter the list to show guides for your mobile app and select a guide. Alternatively, select Create guide and create a guide for your mobile app by selecting your mobile app and layout in the Guides page.
- Select Manage in my app to open the Visual Design Studio.
- In the Text building block, select the Edit button to open the Edit Text modal.
- Under Guide Content, select the Select a property dropdown.
- 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.
- Add any required 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 isn't required. Leave the field blank and the variable code is removed automatically with nothing in its place.
- Select Done to save text changes.
- Use View Step Design or Test Full Guide with Activation to test the guide and make sure you see the personalized property on your device.
To verify the property appears 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 is available. If needed, you can update visitor and account metadata during the session by using the dedicated APIs setVisitorData and setAccountData.