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 5xx responses.
  • 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 4xx responses are not retried. For example, returning 429 causes the event to be dropped, while returning 503 triggers a retry.
  • Dropping behavior: After the fifth failed delivery attempt, the event is dropped.
🚧

This policy applies specifically to v1.10 Call Events configured using real_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
  }
}
EventDescription
bot.participant_joinA new participant has joined the call
bot.participant_leaveA participant has left the call
bot.active_speaker_notifyThe active speaker changed
bot.participant_screen_onA participant has started sharing their screen
bot.participant_screen_offA participant has stopped sharing their screen
bot.participant_in_waiting_roomA participant has entered the waiting room

Did this page help you?