Skip to main content

On-Air guests added

Webhook 

One or more guests were added to an On-Air event.

Event name: onair.guest.added

Required scope: onair:read

Delivered inside the standard event envelope; the schema below shows the full delivery body with this event's payload under data.

Filter on webhook.subscribe. Omit filter to receive guest additions for every On-Air event.

{
"url": "https://example.com/hooks/onair",
"event": "onair.guest.added",
"filter": { "eventId": "9f1c2d3e-4a5b-6c7d-8e9f-0a1b2c3d4e5f" }
}

Request

Responses

Return a 200 status to indicate that the data was received successfully