Skip to main content

Tournament Events

These events track tournament activity including creation, registration, player progress, and completion.

Related Documentation

OnTournamentCreated

Triggered when a new tournament is created.

When it fires:

  • Tournament created via Backoffice
  • Tournament created via API
FieldTypeDescription
objectIdintegerTournament ID
tournamentIdintegerTournament ID

Example:

{
"objectId": 180408,
"tournamentId": 180408
}

OnTournamentStateChanged

Triggered when a tournament changes status.

When it fires:

  • Tournament transitions between states (announced → registering → running → done, etc.)
FieldTypeDescription
tournamentIdintegerTournament ID
tournamentStateintegerNew state code (see below)
isPrizePaidbooleantrue if prizes have been paid

Tournament State Codes

CodeStateDescription
87WaitForAnnounceCreated but not visible to players
65AnnouncedVisible but registration not open
71RegisteringRegistration open
83SeatingPlayers being seated
82RunningTournament in progress
67CancelledTournament cancelled
68DoneTournament completed
85UnfinishedTournament ended without completion

Example:

{
"params": {
"tournamentId": 23423,
"tournamentState": 82,
"isPrizePaid": false
}
}

OnTournamentCompleted

Triggered when a tournament finishes. Contains complete participant list with fees and results.

When it fires:

  • Tournament reaches Done state
  • All prizes calculated
FieldTypeDescription
objectIdintegerTournament ID
tournamentIdintegerTournament ID
lateRegFinishedStampstringLate registration end time
switchToSharePrizeDistributionbooleanWhether shared prize distribution was used
usedSharedPrizeTypeintegerPrize split type (see below)
moneyTypeintegerCurrency code
sharedPrizeCalculatedOnCompleteAfterAddonPauseByTDbooleanPrize calculated after add-on pause
feeListarrayArray of participant fee records

Shared Prize Type Codes

CodeTypeDescription
95NoneNo shared prize
80PlayerDecisionPlayers chose to split
69EqualEqual distribution
83StakeStack-based distribution
73ICMICM-based distribution

Fee List Entry

Each entry in feeList contains:

FieldTypeDescription
playerIdintegerInternal player ID
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
skinIdintegerPlayer's skin ID
playerEntryIdxintegerEntry number
buyInintegerBuy-in amount
entryFeeintegerEntry fee amount
numberRebuyintegerNumber of rebuys
rebuyFeeintegerTotal rebuy fees
numberAddonintegerNumber of add-ons
addonFeeintegerTotal add-on fees
extraBuyInintegerTotal extra buy-ins
levelintegerBlind level reached
placeFromintegerFinishing position (low)
placeTointegerFinishing position (high)
isSharePrizebooleanPlayer agreed to prize split
sharedPrizeTypeintegerPlayer's split preference

Example:

{
"params": {
"objectId": 81622,
"tournamentId": 81622,
"lateRegFinishedStamp": "2024-01-15 14:30:00",
"switchToSharePrizeDistribution": false,
"usedSharedPrizeType": 95,
"moneyType": 80,
"feeList": [
{
"playerId": 12,
"externalId": "123412344",
"externalSystemCode": "434",
"skinId": 2,
"buyIn": 1000,
"entryFee": 100,
"numberRebuy": 1,
"rebuyFee": 100,
"numberAddon": 0,
"addonFee": 0,
"level": 8,
"placeFrom": 1,
"placeTo": 1
}
]
}
}

OnTournamentPlayerSeatedDown

Triggered when a player is seated at a tournament table.

When it fires:

  • Initial seating when tournament starts
  • Reseating during table balancing
FieldTypeDescription
tournamentIdintegerTournament ID
tournamentNamestringTournament name
tournamentTypeintegerTournament type code
tableIdintegerTournament table ID
playerIdintegerUser ID
objectIdintegerUser ID
playerEntryIdxintegerEntry number
skinIdintegerUser's skin ID
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
playerInTournamentIdintegerTournament session ID
firstSeatingbooleantrue if initial seating before games start
externalSessionIdstringExternal session identifier

Tournament Type Codes

CodeTypeDescription
-1ttAnyAny type (used for filtering)
83ttScheduledStarts at specific time
71ttSitAndGoStarts when enough players register
77ttManualStarted manually by creator

Example:

{
"params": {
"tournamentId": 36124574,
"tournamentName": "SnG headsup",
"tournamentType": 71,
"tableId": 37496730,
"playerId": 13296,
"playerEntryIdx": 0,
"skinId": 2,
"externalId": "EXT123",
"playerInTournamentId": 36010919,
"firstSeating": true
}
}

OnTournamentPlayerRegisterResult

Triggered when a player successfully registers for a tournament.

When it fires:

  • Successful tournament registration (any payment method)
FieldTypeDescription
playerIdintegerPlayer ID
tournamentIdintegerTournament ID
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
skinIdintegerUser's skin ID
registeringTypestringRegistration method code
ticketIdintegerTicket ID (if paid by ticket)
externalSessionIdstringExternal session identifier

Registration Type Codes

CodeTypeDescription
95UnknownUnknown method
87WithoutPaymentFree registration
77ByMoneyPaid with balance
84ByTicketPaid with ticket
83BySatelliteWon satellite seat

Example:

{
"params": {
"playerId": 81622,
"tournamentId": 3423,
"externalId": "83688319",
"externalSystemCode": "test",
"skinId": 0,
"registeringType": "M",
"ticketId": 0
}
}

OnPlayerUnregisteredFromTournament

Triggered when a player unregisters from a tournament.

When it fires:

  • Player cancels tournament registration before it starts
FieldTypeDescription
object_idintegerUser ID
playerIdintegerUser ID
tournamentIdintegerTournament ID
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
skinIdintegerUser's skin ID
externalSessionIdstringExternal session identifier

Example:

{
"params": {
"object_id": 81622,
"playerId": 81622,
"tournamentId": 23423,
"externalId": "751632",
"externalSystemCode": "default",
"skinId": 0
}
}

OnPlayerLeftTournament

Triggered when a player is eliminated from a tournament.

When it fires:

  • Player busts out of tournament
  • Player disconnects and times out
FieldTypeDescription
tournamentIdintegerTournament ID
playerIdintegerUser ID
object_idintegerUser ID
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
skinIdintegerUser's skin ID
playerEntryIdxintegerEntry number
placeFromintegerFinishing position (low)
placeTointegerFinishing position (high)
prizePlaceintegerPrize position (if any)
mainPrizeAmountintegerMain prize won (in cents)
levelintegerBlind level reached
playerInTournamentIdintegerTournament session ID
schemeIdintegerDeprecated
externalSessionIdstringExternal session identifier

Example:

{
"params": {
"tournamentId": 23423,
"playerId": 81622,
"externalId": "751632",
"externalSystemCode": "default",
"playerEntryIdx": 1,
"placeFrom": 5,
"placeTo": 5,
"prizePlace": 0,
"mainPrizeAmount": 0,
"level": 12,
"playerInTournamentId": 1002
}
}

OnPlayerWinInTournament

Triggered when a player wins a tournament prize.

When it fires:

  • Player finishes in a paid position
  • Prize is awarded (cash or ticket)
FieldTypeDescription
objectIdintegerInternal message ID
playerIdintegerUser ID
tournamentIdintegerTournament ID
tournamentNamestringTournament name
placeFromintegerFinishing position (low)
placeTointegerFinishing position (high)
amountintegerPrize amount (in cents)
moneyTypeintegerCurrency code
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
skinIdintegerUser's skin ID
wonTicketinteger1 = won ticket, 0 = cash prize
externalSessionIdstringExternal session identifier

Example:

{
"params": {
"objectId": 104,
"playerId": 81622,
"tournamentId": 23423,
"tournamentName": "Sunday Special",
"placeFrom": 1,
"placeTo": 1,
"amount": 50000,
"moneyType": 80,
"externalId": "23",
"externalSystemCode": "default",
"wonTicket": 0
}
}

OnPlayerRebuyOrAddonMaked

Triggered when a player purchases a rebuy or add-on.

When it fires:

  • Player completes rebuy purchase
  • Player completes add-on purchase
FieldTypeDescription
tournamentIdintegerTournament ID
playerIdintegerPlayer ID
playerEntryIdxintegerEntry number
typeintegerOperation type code
chipsCostintegerChips added to prize pool
feeintegerFee paid to poker room
usedGrantTicketIdintegerTicket used (0 = cash payment)
skinIdintegerUser's skin ID

Operation Type Codes

CodeTypeDescription
0emtUnknownUnknown
82emtRebuyStandard rebuy
50emtRebuy2xDouble rebuy
65emtAddonAdd-on

Example:

{
"params": {
"tournamentId": 1234,
"playerId": 789,
"playerEntryIdx": 0,
"type": 82,
"chipsCost": 500,
"fee": 10,
"usedGrantTicketId": 0,
"skinId": 0
}
}

OnPlayerTournamentTicketUpdated

Triggered when a tournament ticket status changes.

When it fires:

  • Ticket issued to player
  • Ticket used for registration
  • Ticket returned (unregistration or tournament cancelled)
  • Ticket expired/reverted
FieldTypeDescription
playerIdintegerUser ID
externalIdstringExternal system player ID
externalSystemCodestringExternal system code
skinIdintegerUser's skin ID
tournamentIdintegerRelated tournament ID
ticketIdintegerTicket ID
ticketValueintegerTicket value (in cents)
creditReasonintegerReason ticket was credited
debitReasonintegerReason ticket was debited
externalSessionIdstringExternal session identifier

Ticket Reason Codes

CodeReasonDescription
95UnknownDefault/unknown
65AdminCreated by administrator
84TournamentPrizeWon in tournament
82AfterRegistrationAuto-issued after registration
85UseUsed for tournament registration
66RevertReturned after expiry or cancellation

Example:

{
"params": {
"playerId": 81622,
"externalId": "EXT123",
"externalSystemCode": "default",
"skinId": 0,
"tournamentId": 5678,
"ticketId": 1234,
"ticketValue": 1000,
"creditReason": 84,
"debitReason": 95
}
}