Personalization Tokens

Premium Feature

Personalization Tokens are available on Business plans and up

Personalization Tokens allow you to set customer attributes in your app code and use these values on the paywall.

A common use case is: setting a customer firstName value and referencing in the paywall copy

Turning on Personalization Tokens

1. Click into the Capabilities tab

2. Find 'Personalization Tokens'

3. Click 'Add'

You will see a new button appear in the preview bar for managing and previewing custom variables.

Defining Personalization Tokens

You will need to tell the paywall which attributes you will be setting in the code

1. Click the button in the preview bar to manage personalization tokens.

2. Click 'Add Personalization Token'

   
3. Provide a short identifier for the variable. Identifiers must be alpha-numeric without spaces. (Example: instead of "First Name", use firstName)

4. Provide an example value for the variable. This will be used to help preview your paywall. (Example: "Joe")

5. Click 'Add'

   

Now this variable can be used in any text input on the paywall.

Using Personalization Tokens in Text Component

1. Add or edit a Title Text or Body Text component

2. Click the ➕ icon and select the defined variable for use in the content

   

Handling Empty Data

By default, the app will not populate a text component if the data referenced is missing. So if the app did not set a personalization token, any text using this value won't appear on the paywall which could result in a missing title.

If you want to handle this more gracefully, use Conditions.

1. Click into the Title Text component

2. Change the default Content to a graceful default value

   
3. In the Conditions tab, add a Condition for 'When Personalization Token 'firstName' is set'

   
4. Update the Text value inside this Condition to use the custom variable

   

Now, if the firstName custom attribute is not set by the app, the paywall will read 'Welcome'. Otherwise it will use the custom value 'Welcome Joe'

You can preview this state by clearing Personalization Tokens in the Preview bar.

Previewing

To preview, use the Personalization Token previewer in the preview bar and add a value for this variable.

Setting Personalization Tokens

Developer Task

To send personalization tokens to the paywall, your developers must setCustomAttributes in the app code.

setCustomerAttributeSDK Reference

clearCustomerAttributeSDK Reference