WebhooksEvent catalogRewards
event.ticket.collection-settled
Version 1 of the event.ticket.collection-settled webhook event.
The event.ticket.collection-settled event.
| Event type | event.ticket.collection-settled |
| Schema version | 1 |
| Routing key | event.event.ticket.collection-settled.v1 |
| Produced by | Reward Management |
| Schema | urn:defendr:contract:reward:ticket-collection-settled:1 |
data fields
| Field | Type | Required | Description |
|---|---|---|---|
accountId | string | yes | |
orderId | string | yes | |
eventId | string | yes | |
playerId | string | yes | |
amount | integer | yes | |
currency | string | yes | |
state | "pending", "succeeded", "failed", "reversal-pending", "reversed", "recovery-required" | yes | |
phase | "collecting", "reversing" | yes | |
revision | integer | yes |
Some fields are required only in particular states. The JSON Schema below is authoritative.
Example delivery
Signed with the example secret whsec_placeholder_example_webhooks_signing_secret, so you can check your verifier against it. See Verifying signatures.
POST /your/webhook/endpoint HTTP/1.1
content-type: application/json
webhook-id: whd_00000000-0000-4000-8000-000000000008
webhook-timestamp: 1800000000
webhook-signature: v1,AiAXwiHt0jsZr6m0iNlhAYdnw9PLZRH9fJiFyBvibjo=
tanitar-event-type: event.ticket.collection-settled
tanitar-schema-version: 1
tanitar-delivery-attempt: 1
{"messageId":"evt_00000000-0000-4000-8000-000000000008","kind":"event","type":"event.ticket.collection-settled","schemaVersion":1,"occurredAt":"2027-01-15T10:00:00.000Z","producer":"reward-management-service","accountId":"acc_11111111-1111-4111-8111-111111111111","correlationId":"corr_00000000-0000-4000-8000-000000000008","data":{"accountId":"acc_example","orderId":"ticket_order_aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa","eventId":"event_example","playerId":"player_example","amount":1,"currency":"usd","state":"pending","phase":"collecting","revision":1}}The same body, formatted:
{
"messageId": "evt_00000000-0000-4000-8000-000000000008",
"kind": "event",
"type": "event.ticket.collection-settled",
"schemaVersion": 1,
"occurredAt": "2027-01-15T10:00:00.000Z",
"producer": "reward-management-service",
"accountId": "acc_11111111-1111-4111-8111-111111111111",
"correlationId": "corr_00000000-0000-4000-8000-000000000008",
"data": {
"accountId": "acc_example",
"orderId": "ticket_order_aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"eventId": "event_example",
"playerId": "player_example",
"amount": 1,
"currency": "usd",
"state": "pending",
"phase": "collecting",
"revision": 1
}
}JSON Schema
urn:defendr:contract:reward:ticket-collection-settled:1
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:defendr:contract:reward:ticket-collection-settled:1",
"type": "object",
"additionalProperties": false,
"required": [
"accountId",
"orderId",
"eventId",
"playerId",
"amount",
"currency",
"state",
"phase",
"revision"
],
"properties": {
"accountId": {
"type": "string",
"minLength": 1
},
"orderId": {
"type": "string",
"minLength": 1
},
"eventId": {
"type": "string",
"minLength": 1
},
"playerId": {
"type": "string",
"minLength": 1
},
"amount": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"currency": {
"type": "string",
"pattern": "^[a-z]{3}$"
},
"state": {
"enum": [
"pending",
"succeeded",
"failed",
"reversal-pending",
"reversed",
"recovery-required"
]
},
"phase": {
"enum": [
"collecting",
"reversing"
]
},
"revision": {
"type": "integer",
"minimum": 1
}
}
}