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 implementing verification by including a query parameter, such as token=your-random-token, in the URL you provide. When we make the request to your endpoint, we will use the exact url, including any query parameters. You will then be able to verify the query parameter in your webhook handler.

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