Prerequisites

Overview of the loyalty setup requirements and the data flow between Xtremepush CDP and Loyalty Hub.

Before you use the Loyalty Hub, ensure the following are configured in the Xtremepush Customer Data Platform (CDP):

Attributes
Events
User Profiles
Bonus engine Integration (Optional)

You must use the Xtremepush SDK version from March 2026 onwards to embed the loyalty widget on your application or website.

The image below shows how data flows from the Xtremepush Customer Data Platform to the Loyalty Hub.

Data flow between Xtremepush CDP and Loyalty Hub

Attributes

There are two types of attributes you can use in the Loyalty Hub:

Standard and custom attributes from the Xtremepush CDP. These are available under Data > Data Manager > Attributes and tags
Standard loyalty attributes that are preset in the Loyalty Hub. For a full list of these attributes, see Manage Loyalty Attributes.

To use any custom attributes in the Loyalty Hub, you must first configure them in the Xtremepush CDP. After loyalty is enabled on your project, these attributes are available to use in the Loyalty Hub.

📘
The standard preset loyalty attributes do not currently reflect in Xtremepush Data Manager. This means that any changes to these attribute values for each user are only recorded in the Loyalty Hub.

📘
The supported attribute types in the Loyalty Hub are number, string, boolean, and array of strings. This means that Date attributes created in Data Manager are mapped to a string attribute type in the Loyalty Hub. And Integer attributes are mapped to the number attribute type.

👍
Where attributes are used in Loyalty Hub
In the Loyalty Hub, attributes are used for the following:

Create user segments. The user segments you create in Xtremepush under Data > Audiences do not appear in the loyalty widget. To specify user eligibility for your loyalty features, you must configure user segments in the Loyalty Hub. See Configure Loyalty User Segments for more information.

Specifying user eligibility for your loyalty features. When configuring loyalty features like quests, you can also specify user eligibility by creating User Restriction logic using attributes. For example, if you configure a reward rule that provides users 100 tokens for a deposit. For this reward rule, you can specify that only users with a total_deposit attribute of greater than 1000 are eligible without creating a segment.

Triggers Achievements, which are loyalty features that award users when their attribute values change. For example, a High Roller Achievement that is awarded to users whose total_deposit is over 5000. For more information, see Achievements.

Configuring levels, which are tiers in your loyalty features. Users progress through these levels based on changes to their user attributes. For example, users with a total_deposit value of 500 are on a Bronze level and those with a total value of 1000 on a Silver level. For more information, see Levels.

Awarding Game Element rewards. Game elements are a reward type in your loyalty features that allow you to modify the user attribute values. For more information, see Game Elements under Dynamic Rewards.

Events

There are four types of events you can use in the Loyalty Hub.

Custom events configured in the Xtremepush CDP. These are available under Data > Data Manager > Events. To use any custom events in the Loyalty Hub, you must first configure them in the Xtremepush CDP. After loyalty is enabled on your project, these events can be used in the Loyalty Hub.
Loyalty-specific events: These are events that are either preset or configurable in the Loyalty Hub:
- Internal Events: These are the preset internal events generated when users interact with your Loyalty Widget. See Internal Events under Manage Loyalty Events for more details.
- Scheduled Events: These are timed events that you can configure in the Loyalty plugin. See Scheduled Events under Manage Loyalty Events for more details.
- User Attribute Events: These are the preset user attribute events that are triggered every time a user’s attribute value changes. See User Attribute Events under Manage Loyalty Events for more details.

Custom events you configure in the Xtremepush CDP are available in the Loyalty Hub. Similarly, any Internal Events from the Loyalty Hub are recorded for each user under User Profile> Events in the Xtremepush CDP.

👍
Where events are used in Loyalty Hub
In the Loyalty Hub, these events are used to trigger loyalty as quests, reward rules, and perks. For more information, see Configure Reward Rules or Configure Quests.

User Profiles

The User ID recorded in the User Profiles tab is used to map users from the Xtremepush CDP to the Loyalty Hub.

Existing Users on Website/App

The following sequence describes how the Loyalty Hub identifies existing users:

A user interacts with your loyalty widget for the first time.
The Loyalty Hub identifies their specific User ID.
The user is then automatically recorded in the All Users tab in the Loyalty Hub

New Users on Website/App

The following sequence describes how new users are mapped to the Xtremepush CDP and the Loyalty Hub:

A user logs in to your application or website
The Xtremepush SDK records the user and creates a new profile under User Profiles.
The user interacts with your loyalty widget for the first time.
The Loyalty Hub identifies their specific User ID.
The user is then automatically recorded in the All Users tab within the Loyalty Hub

Bonus Engine Integration (Optional)

You can assign rewards from your bonus engine integration. Loyalty features, like quests and reward rules, allow you to include built in rewards like tokens or external rewards such as promotions from your bonus engine.

After loyalty is enabled on your project, you can select rewards from your bonus engine integration using the Promotions reward option when configuring a loyalty features.

SDK Requirements

You must use the Xtremepush SDK version from March 2026 onwards to load the loyalty widget and manage user authentication. For more information, see Manage User Authentication and Load the Widget.

Updated about 5 hours ago