API Reference

Realtime Kit

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

Fetch all webhooks details

GET/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Add a webhook

POST/accounts/{account_id}/realtime/kit/{app_id}/webhooks

Fetch details of a webhook

GET/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Replace a webhook

PUT/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Edit a webhook

PATCH/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Delete a webhook

DELETE/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

ModelsExpand Collapse

WebhookGetWebhooksResponse = object { data, success }

data: array of object { id, created_at, enabled, 4 more }

id: string

ID of the webhook

formatuuid

created_at: string

Timestamp when this webhook was created

formatdate-time

enabled: boolean

Set to true if the webhook is active

events: array of "meeting.started" or "meeting.ended" or "meeting.participantJoined" or 6 more

Events this webhook will send updates for

One of the following:

"meeting.started"

"meeting.ended"

"meeting.participantJoined"

"meeting.participantLeft"

"meeting.chatSynced"

"recording.statusUpdate"

"livestreaming.statusUpdate"

"meeting.transcript"

"meeting.summary"

name: string

Name of the webhook

updated_at: string

Timestamp when this webhook was updated

formatdate-time

url: string

URL the webhook will send events to

formaturi

success: boolean

WebhookCreateWebhookResponse = object { data, success }

data: object { id, created_at, enabled, 4 more }

id: string

ID of the webhook

formatuuid

created_at: string

Timestamp when this webhook was created

formatdate-time

enabled: boolean

Set to true if the webhook is active

events: array of "meeting.started" or "meeting.ended" or "meeting.participantJoined" or 6 more

Events this webhook will send updates for

One of the following:

"meeting.started"

"meeting.ended"

"meeting.participantJoined"

"meeting.participantLeft"

"meeting.chatSynced"

"recording.statusUpdate"

"livestreaming.statusUpdate"

"meeting.transcript"

"meeting.summary"

name: string

Name of the webhook

updated_at: string

Timestamp when this webhook was updated

formatdate-time

url: string

URL the webhook will send events to

formaturi

success: boolean

WebhookGetWebhookByIDResponse = object { data, success }

data: object { id, created_at, enabled, 4 more }

id: string

ID of the webhook

formatuuid

created_at: string

Timestamp when this webhook was created

formatdate-time

enabled: boolean

Set to true if the webhook is active

events: array of "meeting.started" or "meeting.ended" or "meeting.participantJoined" or 6 more

Events this webhook will send updates for

One of the following:

"meeting.started"

"meeting.ended"

"meeting.participantJoined"

"meeting.participantLeft"

"meeting.chatSynced"

"recording.statusUpdate"

"livestreaming.statusUpdate"

"meeting.transcript"

"meeting.summary"

name: string

Name of the webhook

updated_at: string

Timestamp when this webhook was updated

formatdate-time

url: string

URL the webhook will send events to

formaturi

success: boolean

WebhookReplaceWebhookResponse = object { data, success }

data: object { id, created_at, enabled, 4 more }

id: string

ID of the webhook

formatuuid

created_at: string

Timestamp when this webhook was created

formatdate-time

enabled: boolean

Set to true if the webhook is active

events: array of "meeting.started" or "meeting.ended" or "meeting.participantJoined" or 6 more

Events this webhook will send updates for

One of the following:

"meeting.started"

"meeting.ended"

"meeting.participantJoined"

"meeting.participantLeft"

"meeting.chatSynced"

"recording.statusUpdate"

"livestreaming.statusUpdate"

"meeting.transcript"

"meeting.summary"

name: string

Name of the webhook

updated_at: string

Timestamp when this webhook was updated

formatdate-time

url: string

URL the webhook will send events to

formaturi

success: boolean

WebhookEditWebhookResponse = object { data, success }

data: object { id, created_at, enabled, 4 more }

id: string

ID of the webhook

formatuuid

created_at: string

Timestamp when this webhook was created

formatdate-time

enabled: boolean

Set to true if the webhook is active

events: array of "meeting.started" or "meeting.ended" or "meeting.participantJoined" or 6 more

Events this webhook will send updates for

One of the following:

"meeting.started"

"meeting.ended"

"meeting.participantJoined"

"meeting.participantLeft"

"meeting.chatSynced"

"recording.statusUpdate"

"livestreaming.statusUpdate"

"meeting.transcript"

"meeting.summary"

name: string

Name of the webhook

updated_at: string

Timestamp when this webhook was updated

formatdate-time

url: string

URL the webhook will send events to

formaturi

success: boolean

WebhookDeleteWebhookResponse = object { data, success }

data: object { id, created_at, enabled, 4 more }

id: string

ID of the webhook

formatuuid

created_at: string

Timestamp when this webhook was created

formatdate-time

enabled: boolean

Set to true if the webhook is active

events: array of "meeting.started" or "meeting.ended" or "meeting.participantJoined" or 6 more

Events this webhook will send updates for

One of the following:

"meeting.started"

"meeting.ended"

"meeting.participantJoined"

"meeting.participantLeft"

"meeting.chatSynced"

"recording.statusUpdate"

"livestreaming.statusUpdate"

"meeting.transcript"

"meeting.summary"

name: string

Name of the webhook

updated_at: string

Timestamp when this webhook was updated

formatdate-time

url: string

URL the webhook will send events to

formaturi

success: boolean