Receive Call Events
Receive webhooks whenever a participant joins a call or the active speaker changes.
Setup
To start receiving Call Event webhook events, specify the URL in the real_time_media.webhook_call_events_destination_url parameter in the Create Bot endpoint.
Verification
We recommend verifying that the webhooks that your application receives are genuinely from our servers. You can validate webhooks by creating a workspace secret which will append headers your application can use to cryptographically ensure the legitimacy of received webhooks.
Retry Policy
Call Event webhook deliveries use the following retry policy:
- Retry conditions: Network errors, request timeouts, and HTTP
5xxresponses. - Delivery attempts: Up to 5 attempts total per event, consisting of the initial attempt and up to 4 retries.
- Retry interval: A fixed 3-second delay between attempts.
- Timeouts: A 5-second connection timeout and a 10-second overall request timeout.
- Non-retryable responses: HTTP
4xxresponses are not retried. For example, returning429causes the event to be dropped, while returning503triggers a retry. - Dropping behavior: After the fifth failed delivery attempt, the event is dropped.
This policy applies specifically to v1.10 Call Events configured usingreal_time_media.webhook_call_events_destination_url. It differs from the v1.11 Real-Time Webhook Endpoint retry policy.
Event Payload
This webhook is sent when new participant events occur in the meeting.
{
"event": "bot.participant_join",
"data": {
"bot_id": string,
"participant_id": number,
"created_at": string
}
}| Event | Description |
|---|---|
bot.participant_join | A new participant has joined the call |
bot.participant_leave | A participant has left the call |
bot.active_speaker_notify | The active speaker changed |
bot.participant_screen_on | A participant has started sharing their screen |
bot.participant_screen_off | A participant has stopped sharing their screen |
bot.participant_in_waiting_room | A participant has entered the waiting room |
Updated 8 days ago
Did this page help you?
