Bonus Engine

Xtremepush supports integration with bonus engines, allowing you to surface and assign promotions directly from CRM campaigns and journeys. Where integration requirements are met, standard configurations can typically be completed within a few days, excluding lead time.

For full technical detail, see the Bonus Engine Integration Guide.

1. How it works

The standard integration pattern requires two API capabilities from your bonus engine: one endpoint to retrieve a list of active promotions, and one endpoint to allocate a promotion to a user. Where supported, de-allocation (removing a bonus from a user) is handled through the same single endpoint. Separate endpoints for allocation and de-allocation are not supported.

Xtremepush supports dynamic assignment, meaning bonus values can be fixed or derived from player attributes or triggering event properties.

2. Integration requirements

For a standard configuration to be possible, the following must be in place:

Supported authentication methods:

• Bearer token

• Header token

• Username and password

• OpenID

• OAuth

API requirements:

• JSON format requests and responses with minimal nesting

• An endpoint to retrieve a list of active promotions or bonus types

• A single endpoint to allocate (and optionally de-allocate) bonuses for users

Core endpoint patterns — at least one of the following must be supported:

• Retrieve a list of active bonuses ➡️  allocate bonus ID X to customer ID Y

• Retrieve a list of bonus types ➡️ allocate a bonus of type X with value Y to customer ID Z

What we need from you (as an OpenAPI spec with examples where possible):

• API documentation for your bonus engine

• Confirmation of the authentication method in use

• The base URL for the API endpoints

• Full details of all fields required when assigning or removing a bonus

3. Bespoke integrations

Where a bonus engine has an unsupported authentication method, a different communication protocol (for example, JSON-RPC or XML), or a complex request/response format, Xtremepush can build a bespoke integration where practical. This carries additional lead time and may incur setup and maintenance costs.

4. Existing third-party integrations

Xtremepush has pre-built integrations with the following providers:

If your provider is not listed, integration is still possible provided the API requirements above are met.

5. Use of promotions in campaigns

Once configured, promotion options appear directly within campaign setup. Promotions can be linked to campaigns in two locations: in campaign setup and via a promotion node within a multi-stage journey.