Bonus
The bonus event will give you the ability to see actual bonus costs associated to your campaigns. It will also allow you to trigger activities on bonus status changes, e.g. if it's lost too quickly.
REST API
RabbitMQ Connector
Kafka Connector
⬆️ POST /v1/integration/bonus
RabbitMQ Message Properties
key | value |
type | BONUS |
The type is expected as a property (but not in the payload) of the RabbitMQ Message. Any header will be ignored.
Kafka Message Headers
key | value |
type | BONUS |
Request
It's important that only one event is sent when the status of the bonus is changed.
Multiple events of the same status will result in the segmentation data being incorrect.
When sending 'free spins' bonuses, we expect the first bonus event to be sent once the free spins rounds have been completed and with the correlating "amount" that was won.
If you wish to send data when the free spins has been issued, you might send this as a 'Custom Event'.
Key | Type | Required? | Accepted Values | Description |
amount | float | Yes | N/A | Bonus amount |
bonus_code | string | No | N/A | Bonus code |
bonus_id | string | Yes | N/A | Bonus id |
bonus_turned_real | float | No | N/A | Bonus amount turned to real money:
If wagering is finished. |
currency | string | Yes | Format: ISO 4217 e.g. "EUR" | Currency |
exchange_rate | float | Yes | e.g. 0.1 | The exchange rate at the timestamp |
locked_amount | float | No | N/A | Bonus amount locked to wagering |
meta | N/A | No | N/A | If meta data is required to be sent |
origin | string | Yes | e.g. www.brand.com | N/A |
product | string | Yes | "Casino",
"Sportsbook",
"Lotto",
"Poker" | Product type |
required_wagering_amount | float | No | N/A | Required wagering amount of bonus |
status | string | Yes | "Pending",
"Created",
"Ongoing",
"Completed",
"AutoCompleted",
"Forfeited",
"Expired",
"Lost",
"Reversed" | Bonus status |
timestamp | string | Yes | Format: RFC3339 2015-03-02T8:27:58.10Z | Timestamp |
type | string | Yes | "NoDeposit",
"WelcomeBonus",
"CashbackBonus",
"ReloadBonus", "WagerFree",
"FreeSpins", "RiskFreeBet", "Undefined" | Bonus type |
user_bonus_id | string | Yes | N/A | User bonus id |
user_id | string | Yes | N/A | User id |
Status descriptions
Status | Description |
Pending | When a bonus has been given to the player but not yet been claimed. |
Created | When the bonus has been claimed and the funds are added to the player’s account. |
Ongoing | When wagering has started by the user. e.g. player places the first bet with the bonus funds.
*This event can be sent multiple times to track how the player progresses with the wagering requirement. |
Completed | If the wagering requirement is fulfilled and the bonus funds are turned into real funds. |
AutoCompleted | If your system automatically removes the bonus with a general setting.
e.g. Bonuses are autocompleted if the balance reaches under €0.10 |
Forfeited | If the bonus has been forfeited. |
Expired | If the validity period of the bonus has expired. |
Lost | If the player has run out of bonus balance. |
Reversed | When a previously active bonus has been credited back to the player’s account, usually when there’s a canceled withdrawal. |