v.1.3

iGaming Events and Attributes

Player events and attributes.

This documents lists the events and attributes sent by our partner platforms to optimise player revenue and business visibility. We suggest to call a /profile call after some of the events which are marked with an asterisk (*).

Admin Deposit*

Deposit transactions made by admin staff to top up a player or a streamer's balance.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Admin Deposit"
admin	String	FALSE	Admin user's email address
amount	Numeric	FALSE	Deposit amount
currency	String	FALSE	Amount's currency
deposit_count	Numeric	FALSE	Total number of deposits by the admin
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
payment_id	String	FALSE	Unique payment identifier

* We recommend to call the update profile endpoint after this event to update the player details to the latest state. Including player's balance and deposit count (if you want to count Admin Deposits as player deposits)

Admin Withdrawal*

Withdrawal transactions made by admin staff to top up a player or a streamer's balance.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Admin Withdrawal"
admin	String	FALSE	Admin user's email address
amount	Numeric	FALSE	Withdrawal amount
currency	String	FALSE	Amount's currency
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
withdrawal_count	Numeric	FALSE	Total number of withdrawals by the player
payment_id	String	FALSE	Unique payment identifier

Bet*

Gaming or sports wager events capture betting transaction data with comprehensive tracking for stake management and game analytics.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player's identifier in your system
event	String	FALSE	"Bet"
amount	Numeric	FALSE	Bet amount
bonus_wager_amount	Numeric	FALSE	Wagered bonus amount
currency	String	FALSE	Amount's currency
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
product	String	FALSE	"Casino" or "Sports"
game_name	String	FALSE	Game's name
vendor_name	String	FALSE	Game provider's name
urm_user_agent	String	FALSE	Player's user agent
urm_ip	String	FALSE	Player's IP address

* We recommend to call the update profile endpoint after this event to update the player details to the latest state. Including player's balance.

Win*

Win events capture winning transaction data with comprehensive attributes to track net revenue.

attribute_name	attribute_type	is_array	Value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Win"
amount	Numeric	FALSE	Win amount
bonus_wager_amount	Numeric	FALSE	Wagered bonus amount
currency	String	FALSE	Amount's currency
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
game_name	String	FALSE	Game's name
product	String	FALSE	"Casino" or "Sports"
vendor_name	String	FALSE	Game provider's name
urm_user_agent	String	FALSE	Player's user agent
urm_ip	String	FALSE	Player's IP address

* We recommend to call the update profile endpoint after this event to update the player details to the latest state. Including player's balance.

Bonus*

Promotional reward events track bonus events for when the bonus is created for the player, completed by the player or cancelled.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Bonus"
amount	Numeric	FALSE	Bonus amount
bonus_code	String	FALSE	Bonus identifier in your system
bonus_name	String	FALSE	Bonus name in your system
bonus_turned_real	Numeric	FALSE	Amount of bonus turned to real money
currency	String	FALSE	Amount's currency
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
product	String	FALSE	"Casino" or "Sports"
status	String	FALSE	"Created", "Completed" or "Cancelled"
type	String	FALSE	Type of bonus that changed its status
urm_user_agent	String	FALSE	Player's user agent
urm_ip	String	FALSE	Player's IP address

* We recommend to call the update profile endpoint after this event to update the player details to the latest state. Including player's balance.

Credit*

A deposit event made by the player with comprehensive payment details attributes.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player's identifier in your system
event	String	FALSE	"Credit"
amount	Numeric	FALSE	Bet amount
currency	String	FALSE	Amount's currency
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
game_name	String	FALSE	Game's name
status	String	FALSE	"Requested" or "Approved" or "Rejected"
vendor_name	String	FALSE	Game provider's name
deposit_count	Numeric	FALSE	Total number of deposits by the player
urm_user_agent	String	FALSE	Player's user agent
urm_ip	String	FALSE	Player's IP address
payment_id	String	FALSE	Unique payment identifier

* We recommend to call the update profile endpoint after this event to update the player details to the latest state. Including player's balance and deposit count.

Debit

A withdraw event made by the player with comprehensive payment details attributes.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Debit"
amount	Numeric	FALSE	Debit amount
currency	String	FALSE	Amount's currency
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency, no need to send if single currency
status	String	FALSE	"Requested" or "Approved" or "Rejected"
vendor_name	String	FALSE	Payment processor's name
withdrawal_count	Numeric	FALSE	Total number of withdrawals by the player
urm_user_agent	String	FALSE	Player's user agent
urm_ip	String	FALSE	Player's IP address
payment_id	String	FALSE	Unique payment identifier

* We recommend to call the update profile endpoint after this event to update the player details to the latest state. Including player's balance and withdrawal count.

Email Confirmation*

Player email confirmation event sent when the player's email address is verified by the player or admin.

attribute_name	attribute_type	is_array	Value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Email Confirmation"
email_confirmed	Boolean	FALSE	true

* We recommend to call the update profile endpoint after this event to update the player details to the latest state including email confirmation fields.

KYC Verification*

Know Your Customer (KYC) verification event and the consequent profile attribute sync.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"KYC Verification"
kyc_verified_address	Boolean	FALSE	true
kyc_verified_email	Boolean	FALSE	true
kyc_verified_id_document	Boolean	FALSE	true
kyc_verified_phone	Boolean	FALSE	true
kyc_verified_selfie	Boolean	FALSE	true

‍
* We recommend to call the update profile endpoint after this event to update the player details to the latest state including KYC data.

Login*

User login events with authentication details.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Login"
method	String	FALSE	email

* We recommend to call the update profile endpoint after this event to update the player details to the latest state.

Password Reset*

Password reset feature request/completed by the user or admin.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Password Reset"
password_reset	Boolean	FALSE	true

* We recommend to call the update profile endpoint after this event to update the player details to the latest state.

Profile Update*

Profile update event performed by the player or admin staff.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Profile Update"
address	String	FALSE	player's address
birth_date	DateTime	FALSE	player's birth date
city	String	FALSE	player's city
country	String	FALSE	player's country
currency	String	FALSE	player's currency
email	String	FALSE	player's email
first_name	String	FALSE	player's first name
last_name	String	FALSE	player's last name
is_blocked	Boolean	FALSE	is the player blocked
is_excluded	Boolean	FALSE	is the player excluded
language	String	FALSE	player's language
phone	String	FALSE	player's phone
postal_code	String	FALSE	player's postal code
registration_date	DateTime	FALSE	player's registration date
sex	String	FALSE	player's gender
username	String	FALSE	player's username, no need to send if username is the same as email.
verified_at	DateTime	FALSE	player's verified date
deposit_count	Number	FALSE	total number of deposits by the player
withdrawal_count	Number	FALSE	total number of withdrawals by the player
cash_balance	Number	FALSE	player's cash balance
bonus_balance	Number	FALSE	player's bonus balance

‍
* We recommend to call the update profile endpoint after this event to update the player details to the latest state.

Sign up*

User registration event followed by the profile update.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Sign up"
address	String	FALSE	player's address
birth_date	DateTime	FALSE	player's birth date
city	String	FALSE	player's city
country	String	FALSE	player's country
currency	String	FALSE	player's currency
email	String	FALSE	player's email
first_name	String	FALSE	player's first name
last_name	String	FALSE	player's last name
is_blocked	Boolean	FALSE	is the player blocked
is_excluded	Boolean	FALSE	is the player excluded
language	String	FALSE	player's language
phone	String	FALSE	player's phone number
postal_code	String	FALSE	player's postal code
registration_date	DateTime	FALSE	player's registration date
sex	String	FALSE	player's gender
username	String	FALSE	player's username, no need to send if username is the same as email.
verified_at	DateTime	FALSE	player's verified date

* We recommend to call the update profile endpoint after this event to update the player details to the latest state.

Update Consents*

Consent updates for opting-in or out from email, sms, push, mail and other communication channels.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Update Consents"
opted_in_email	Boolean	FALSE	true
opted_in_postMail	Boolean	FALSE	true
opted_in_pushNotification	Boolean	FALSE	true
opted_in_siteNotification	Boolean	FALSE	true
opted_in_sms	Boolean	FALSE	true
opted_in_telephone	Boolean	FALSE	true

* We recommend to call the update profile endpoint after this event to update the player details to the latest state including consent data.

Update Blocks*

User blocking event requested by the player or admin for block, self exclusion or other temporary activities.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Update Blocks"
is_blocked	Boolean	FALSE	true
is_excluded	Boolean	FALSE	true

* We recommend to call the update profile endpoint after this event to update the player details to the latest state including block data.

Sportsbook*

Sports wager events capture bet placement and settlement transactions with selection-level detail for stake management and sports analytics. Bet placements are sent with type "Bet" and settlements with type "Settlement". The activity_id_reference attribute on a settlement links back to the original bet's activity_id.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
event	String	FALSE	"Sportsbook"
type	String	FALSE	"Bet" for bet placement or "Settlement" for bet settlement
status	String	FALSE	"Approved" or "Rollback"
timestamp	DateTime	FALSE	Event time with +00:00
origin	String	FALSE	Operator domain
amount	Numeric	FALSE	Total bet stake for type "Bet", total payout for type "Settlement" (0 for lost bets). Equals wager_amount + bonus_wager_amount + locked_wager_amount
wager_amount	Numeric	FALSE	Real money portion of the bet or payout
bonus_wager_amount	Numeric	FALSE	Bonus balance portion of the bet or payout
locked_wager_amount	Numeric	FALSE	Locked money portion of the bet or payout
currency	String	FALSE	Amount's currency. Settlements are sent in the same currency as the original bet
exchange_rate	Numeric	FALSE	The exchange rate of the currency to the main currency at the moment of the transaction, no need to send if single currency
bet_type	String	FALSE	"Single", "Multi" or "System"
odds	Numeric	FALSE	Combined betting odds. For settlements: original bet odds, dynamic cashout odds when is_cashout is true, or 1.0 for Cancelled/Refunded
is_cashout	Boolean	FALSE	true if the settlement is a cashout, always false for type "Bet"
settlement_type	String	FALSE	"Won", "Lost", "HalfWon", "HalfLost", "Cancelled" or "Refunded". Sent for type "Settlement" only
activity_id	String	FALSE	Unique activity identifier
activity_id_reference	String	FALSE	The original bet's activity_id. Sent for type "Settlement" only
user_bonus_id	String	FALSE	Active bonus ID or "0"
balance_before	Numeric	FALSE	Player's real money balance before the transaction
balance_after	Numeric	FALSE	Player's real money balance after the transaction
reference_bet_amount	Numeric	FALSE	Original total stake of the bet. Sent for type "Settlement" only
reference_bet_real_amount	Numeric	FALSE	Original real money stake. Sent for type "Settlement" only
reference_bet_bonus_amount	Numeric	FALSE	Original bonus stake. Sent for type "Settlement" only
reference_bet_locked_amount	Numeric	FALSE	Original locked amount. Sent for type "Settlement" only
reference_bet_exchange_rate	Numeric	FALSE	Original exchange rate at the moment of the bet. Sent for type "Settlement" only
device_type	String	FALSE	"Desktop", "Mobile" or "Tablet"
bets	Object	TRUE	Array of bet selection objects, see the bets attributes below. Empty for settlements

‍

Each item in the bets array contains the following attributes:

attribute_name	attribute_type	is_array	value
event_name	String	FALSE	Match or event title
tournament_name	String	FALSE	League or tournament name
sports_name	String	FALSE	Sport type
match_start	DateTime	FALSE	Event start time with +00:00
market	String	FALSE	Market name
odds	Numeric	FALSE	Selection odds
is_live	Boolean	FALSE	true if live/in-play, false if pre-match
is_free_bet	Boolean	FALSE	true if free bet
is_risk_free_bet	Boolean	FALSE	true if risk-free bet
outcomes	Object	TRUE	Array of outcome objects, see the outcomes attributes below

‍

Each item in the outcomes array contains the following attributes:

attribute_name	attribute_type	is_array	value
criterion_name	String	FALSE	Market or outcome category, e.g. "Match Result" or "Correct Score"
outcome_label	String	FALSE	Player's chosen outcome, e.g. "Home Win" or "2-1"

* We recommend to call the update profile endpoint after this event to update the player details to the latest state including block data.

Update Profile

This is not an event, this is a /profile or /profiles call to update the players details to the latest state.

attribute_name	attribute_type	is_array	value
app_id	String	FALSE	Your provided app_id
profile_id	String	FALSE	Player identifier in your system
address	String	FALSE	player's address
birth_date	DateTime	FALSE	player's birth date
city	String	FALSE	player's city
country	String	FALSE	player's country
currency	String	FALSE	player's currency
email	String	FALSE	player's email
first_name	String	FALSE	player's first name
last_name	String	FALSE	player's last name
is_blocked	Boolean	FALSE	is the player blocked
is_excluded	Boolean	FALSE	is the player excluded
language	String	FALSE	player's language
phone_number	String	FALSE	player's phone number
postal_code	String	FALSE	player's postal code
registration_date	DateTime	FALSE	player's registration date
sex	String	FALSE	player's gender
username	String	FALSE	player's username, no need to send if username is the same as email.
verified_at	DateTime	FALSE	player's verified date
urm_aff_tag	String	FALSE	player's affiliate id
deposit_count	Number	FALSE	total number of deposits by the player
withdrawal_count	Number	FALSE	total number of withdrawals by the player
cash_balance	Number	FALSE	player's cash balance.
bonus_balance	Number	FALSE	player's bonus balance