Skip to main content
POST
Create event (POST)

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
click_id
string
required

Click UUID to attribute the event to.

type
enum<string>
required

Event type code. Values: dep=Deposit, wdr=Withdrawal, bon=Bonus, bet=Bet, win=Win, ftd=First Deposit, reg=Registration, qftd=Qualified FTD, trd=Trade, pft=Profit, bal=Balance, ver=Verification, chb=Chargeback, rak=Rake, adj=Adjustment, ngr=NGR, psf=PSF, ctf=CTF, tax=Tax, bng=Bingo, ggr=GGR, brf=Brf, rev=Revenue, spr=Spread, fdep=Failed Deposit, depatt=Deposit Attempt.

Available options:
dep,
wdr,
bon,
bet,
win,
ftd,
reg,
qftd,
trd,
pft,
bal,
ver,
chb,
rak,
adj,
ngr,
psf,
ctf,
tax,
bng,
ggr,
brf,
rev,
spr,
fdep,
depatt
amount
number

Event monetary value.

currency
string

Currency code (ISO 4217). Defaults to platform currency.

adv_order_id
string

Advertiser order ID.

adv_user_id
string

Advertiser user ID.

adv_track_id
string

Advertiser tracking ID.

adv_param1
string

Custom advertiser parameter 1.

adv_param2
string

Custom advertiser parameter 2.

adv_param3
string

Custom advertiser parameter 3.

adv_param4
string

Custom advertiser parameter 4.

adv_param5
string

Custom advertiser parameter 5.

aff_param1
string

Custom affiliate parameter 1.

aff_param2
string

Custom affiliate parameter 2.

aff_param3
string

Custom affiliate parameter 3.

aff_param4
string

Custom affiliate parameter 4.

aff_param5
string

Custom affiliate parameter 5.

sub_id1
string

Sub-affiliate tracking ID 1.

sub_id2
string

Sub-affiliate tracking ID 2.

sub_id3
string

Sub-affiliate tracking ID 3.

sub_id4
string

Sub-affiliate tracking ID 4.

sub_id5
string

Sub-affiliate tracking ID 5.

promo_code
string

Promo code to associate with the event.

country
string

ISO 3166-1 alpha-2 country code override.

qty
integer

Event quantity (default 1).

event_id
string

External event identifier for deduplication.

product
string

Product key (gaming verticals).

timestamp
string

Event timestamp (UTC). Format: YYYY-MM-DD HH:MM:SS.

Response

Event created.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
Example:

"Event transaction has been added"

info
object