CustomerId.
The game id is
ActivityId in these payloads, sent as a string. Game attempt events carry the same id as GameId, an integer.Field reference
| Event | Raised when |
|---|---|
| Game Created | A game is created |
| Game Updated | A game’s settings change |
| Game Published | A game is published |
| Game Stopped | A game is stopped |
| Game Deleted | A game is deleted |
Schemas
- Game Created
- Game Updated
- Game Published
- Game Stopped
- Game Deleted
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$defs": {
"Reward": {
"type": "object",
"properties": {
"Id": { "type": ["string", "null"] },
"ExternalId": { "type": ["string", "null"] },
"TotalCoupons": { "type": ["integer", "null"] }
}
},
"CustomReward": {
"type": "object",
"properties": {
"Id": { "type": ["string", "null"] },
"Title": { "type": ["string", "null"] },
"TotalRewards": { "type": "integer" },
"BonusAmount": { "type": ["number", "null"] }
}
}
},
"properties": {
"EventId": { "type": "string" },
"ActivityId": { "type": "string" },
"UnifiedCampaignId": { "type": ["string", "null"] },
"CreatedAt": { "type": "string", "format": "date-time" },
"Name": { "type": ["string", "null"] },
"Url": { "type": ["string", "null"], "format": "uri" },
"StartDate": { "type": "string", "format": "date-time" },
"EndDate": { "type": "string", "format": "date-time" },
"Rewards": { "type": ["array", "null"], "items": { "$ref": "#/$defs/Reward" } },
"CustomRewards": { "type": ["array", "null"], "items": { "$ref": "#/$defs/CustomReward" } },
"BonusRewards": { "type": ["array", "null"], "items": { "$ref": "#/$defs/CustomReward" } },
"Priority": { "type": ["integer", "null"] },
"MaxAllowedAttemptsPerDay": { "type": ["integer", "null"] },
"MaxAllowedAttempts": { "type": ["integer", "null"] },
"MaxAllowedWins": { "type": ["integer", "null"] },
"WinRate": { "type": ["integer", "null"] },
"DaysForPickup": { "type": ["integer", "null"] },
"PickUpEndDate": { "type": ["string", "null"], "format": "date-time" },
"SegmentationType": { "type": "string", "enum": ["Unsegmented", "Segmented", "Triggered"] },
"AudienceIds": { "type": ["array", "null"], "items": { "type": "string" } },
"IsSilentStopped": { "type": ["boolean", "null"] },
"Author": { "type": ["string", "null"] },
"WinAlgorithmType": { "type": "string", "enum": ["QueueBased", "TimeBased"] },
"AmountOfPrizes": { "type": ["integer", "null"] },
"TimeUnit": { "type": ["string", "null"], "enum": ["None", "Day", "Week", "Month", "Year", null] },
"TimeUnitBetweenGameAttemptsIssued": { "type": ["integer", "null"] },
"ValidForDays": { "type": ["integer", "null"] },
"DrawType": { "type": "string", "enum": ["Instant", "Lottery"] }
}
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"$defs": {
"Reward": {
"type": "object",
"properties": {
"Id": { "type": ["string", "null"] },
"ExternalId": { "type": ["string", "null"] },
"TotalCoupons": { "type": ["integer", "null"] }
}
},
"CustomReward": {
"type": "object",
"properties": {
"Id": { "type": ["string", "null"] },
"Title": { "type": ["string", "null"] },
"TotalRewards": { "type": "integer" },
"BonusAmount": { "type": ["number", "null"] }
}
}
},
"properties": {
"EventId": { "type": "string" },
"ActivityId": { "type": "string" },
"UnifiedCampaignId": { "type": ["string", "null"] },
"Name": { "type": ["string", "null"] },
"Url": { "type": ["string", "null"], "format": "uri" },
"StartDate": { "type": "string", "format": "date-time" },
"EndDate": { "type": "string", "format": "date-time" },
"Rewards": { "type": ["array", "null"], "items": { "$ref": "#/$defs/Reward" } },
"CustomRewards": { "type": ["array", "null"], "items": { "$ref": "#/$defs/CustomReward" } },
"Priority": { "type": ["integer", "null"] },
"MaxAllowedAttemptsPerDay": { "type": ["integer", "null"] },
"MaxAllowedAttempts": { "type": ["integer", "null"] },
"MaxAllowedWins": { "type": ["integer", "null"] },
"WinRate": { "type": ["integer", "null"] },
"DaysForPickup": { "type": ["integer", "null"] },
"PickUpEndDate": { "type": ["string", "null"], "format": "date-time" },
"SegmentationType": { "type": "string", "enum": ["Unsegmented", "Segmented", "Triggered"] },
"AudienceIds": { "type": ["array", "null"], "items": { "type": "string" } },
"IsSilentStopped": { "type": ["boolean", "null"] },
"WinAlgorithmType": { "type": "string", "enum": ["QueueBased", "TimeBased"] },
"AmountOfPrizes": { "type": ["integer", "null"] },
"TimeUnit": { "type": ["string", "null"], "enum": ["None", "Day", "Week", "Month", "Year", null] },
"TimeUnitBetweenGameAttemptsIssued": { "type": ["integer", "null"] },
"ValidForDays": { "type": ["integer", "null"] },
"DrawType": { "type": "string", "enum": ["Instant", "Lottery"] },
"ModifiedDate": { "type": "string", "format": "date-time" },
"ModifiedBy": { "type": ["string", "null"] }
}
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"EventId": { "type": "string" },
"ActivityId": { "type": "string" },
"UnifiedCampaignId": { "type": ["string", "null"] },
"PublishedBy": { "type": ["string", "null"] },
"PublishedAt": { "type": "string", "format": "date-time" }
}
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"EventId": { "type": "string" },
"ActivityId": { "type": "string" },
"UnifiedCampaignId": { "type": ["string", "null"] },
"StoppedBy": { "type": ["string", "null"] },
"StoppedAt": { "type": "string", "format": "date-time" }
}
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"EventId": { "type": "string" },
"ActivityId": { "type": "string" },
"UnifiedCampaignId": { "type": ["string", "null"] },
"DeletedBy": { "type": ["string", "null"] },
"DeletedAt": { "type": "string", "format": "date-time" }
}
}
API reference
Endpoint documentation: Games.Related
- Game attempt events — a customer’s attempts at the game.
- Campaign events — the campaigns that hold games.
- OutboundAPI connection — how these events reach an endpoint in your system.