Webhook - Pass Topics [Beta]
Beta
Please note that it is a Beta feature.
Cleeng Webhooks
Webhooks are notifications that Cleeng sends out to subscribed broadcasters about certain events occurring in the platform. The events are sent in the form of a POST request made to specified endpoints with a JSON payload as its body.
The body of the request consists of three constant fields:
broadcasterId
β the ID of the broadcaster that the webhooks is sent for,
topic
β the name of the topic that the webhook is sent about,
data
β topic-specific payload about the event.
Available Pass Topics
passCreated
Trigger:
The event is triggered whenever a new pass is created.
{
"broadcasterId": 111222333,
"topic": "passCreated",
"data": {
"passId": "123456789"
"offerId": "P987654321_US",
"customerId": 123123123,
"customerEmail": "[email protected]",
"active": true,
"expirationDate": "2019-11-07T19:55:41Z",
"customerExternalId": "321321321"
}
}
passExpirationChanged
Trigger:
The event is triggered whenever a pass expiration date is changed.
{
"broadcasterId": 111222333,
"topic": "passExpirationChanged",
"data": {
"passId": "123456789",
"offerId": "P987654321_US",
"customerId": 123123123,
"customerExternalId": "ext-123",
"customerEmail": "[email protected]",
"previousExpirationDate": "2019-11-04T19:55:41Z",
"expirationDate": "2019-11-07T19:55:41Z"
}
}
passTerminated
Trigger:
The event is triggered whenever a pass is terminated.
{
"broadcasterId": 111222333,
"topic": "passTerminated",
"data": {
"passId": "123456789",
"offerId": "P987654321_US",
"customerId": 123123123,
"customerEmail": "[email protected]",
"customerExternalId": "321321321"
}
}
Updated about 1 month ago