--- title: "Prerequisites" slug: "prerequisites" updated: 2026-11-04T16:49:51Z published: 2026-11-04T16:49:51Z canonical: "docs.xtremepush.com/prerequisites" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ![](https://cdn.document360.io/b056e88b-f6c1-4bd2-b5b8-08e9336a17c9/Images/Documentation/9fb3be2062c4917f49f34a19becbd6b5f2f19e252e77f666f03fe3fa45b41d34-1(1).png?sv=2026-02-06&spr=https&st=2026-11-22T18%3A11%3A42Z&se=2026-11-22T19%3A11%3A42Z&sr=b&sp=r&sig=GiE5o6bnmUuzdmPGVCkG3qyyLtnvIWbW4DEPFEQzA04%3D) 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](https://docs.xtremepush.com/docs/manage-loyalty-attributes-1). 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. > [!NOTE] > **Note** > > 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. > [!NOTE] > Note > > 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. > [!TIP] > **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](/documentation/docs/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](/documentation/docs/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](https://docs.xtremepush.com/docs/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](/documentation/docs/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](/documentation/docs/manage-loyalty-events-1) for more details. - **Scheduled Events**: These are timed events that you can configure in the Loyalty plugin. See *Scheduled Events* under [Manage Loyalty Events](/documentation/docs/manage-loyalty-events-1) 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](/documentation/docs/manage-loyalty-events-1) 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. > [!TIP] > 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](/documentation/docs/reward-rules) or [Configure Quests](/documentation/docs/quests). **User Profiles** The Loyalty Hub uses the User ID recorded in the **User Profiles** tab to map users from the Xtremepush CDP to the Loyalty Hub. When the Loyalty Hub adds a user to your loyalty program, it records them in the **All Users** tab and imports their custom attributes from the Xtremepush CDP. Once a user is added, their events and attribute changes can trigger reward rules, progress quests and leaderboards, and move the user between levels. There are two ways the Loyalty Hub can add users. Your program uses default registration unless you request widget-only registration. - **Default registration**: A user is added when the Loyalty Hub receives their first custom event or attribute change, or when they first open the loyalty widget, whichever comes first. Custom events, such as bets, deposits, and logins, and attribute changes come from your website, app, or other systems, not from the widget. This means a user can be added, earn rewards, and appear on leaderboards without ever opening the widget. - **Widget-only registration**: A user is added only when they first open the loyalty widget. Use this to keep users who never open the widget out of your loyalty program. The Loyalty Hub ignores custom events and attribute changes sent before the user opens the widget, and these never count towards quests, levels, leaderboards, or rewards. Users already in the **All Users** tab are not affected. The widget-only registration is not available on every project. To enable it, contact your Account Manager. **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](/documentation/docs/manage-user-authentication) and [Load the Widget](/documentation/docs/load-the-widget).