Webhooks

This document outlines the APIs that your platform must implement to be called by the CRM, enabling various features to be fulfilled.

Sync Bonuses:

This will be the GET API to return the list of all the available bonuses with the below structure:

GET 'https://{YOU_API_URL}' \ #e.g. https://api.brand.com/bonus/list
--header 'x-api-key: API-KEY-PROVIDED-BY-YOU' \
--header 'Accept: application/json' \
--header Content-Type: application/json' \

‍

Your response must be an array of bonuses with the below data structure:

[
  {
    "bonus_name": "200 Free Spins",
    "bonus_id": "abc"
  }
]

‍

Credit Bonus:

This webhook allows us to call your system to allocate a bonus to a player.

POST 'https://{YOU_API_URL}' \ #e.g. https://api.brand.com/bonus/credit
--header 'x-api-key: API-KEY-PROVIDED-BY-YOU' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "player_id": "123",
    "bonus_id": "abc"
}'

‍

Player Details:

The GET API provides full player details to be synced in the CRM. This can include any fields you see appropriate for your use cases, including balances (real, bonus, etc)

GET 'https://{YOU_API_URL}' \ #e.g. https://api.brand.com/player
--header 'x-api-key: API-KEY-PROVIDED-BY-YOU' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \

‍

Your response must be a json similar to the /profile API of the Tracker Module:

{
    "profile_id": "NUX PLAYER ID",
    "first_name": "SMS Body",
    "last_name": "+18765432178",
    "email": "+18765432178",
    "phone": "+18765432178",
    ...
}