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

client.realtimeKit.webhooks.getWebhooks(stringappId, WebhookGetWebhooksParams { account_id } params, RequestOptionsoptions?): WebhookGetWebhooksResponse { data, success }

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

Add a webhook

client.realtimeKit.webhooks.createWebhook(stringappId, WebhookCreateWebhookParams { account_id, events, name, 2 more } params, RequestOptionsoptions?): WebhookCreateWebhookResponse { data, success }

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

Fetch details of a webhook

client.realtimeKit.webhooks.getWebhookById(stringappId, stringwebhookId, WebhookGetWebhookByIDParams { account_id } params, RequestOptionsoptions?): WebhookGetWebhookByIDResponse { data, success }

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

Replace a webhook

client.realtimeKit.webhooks.replaceWebhook(stringappId, stringwebhookId, WebhookReplaceWebhookParams { account_id, events, name, 2 more } params, RequestOptionsoptions?): WebhookReplaceWebhookResponse { data, success }

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

Edit a webhook

client.realtimeKit.webhooks.editWebhook(stringappId, stringwebhookId, WebhookEditWebhookParams { account_id, enabled, events, 2 more } params, RequestOptionsoptions?): WebhookEditWebhookResponse { data, success }

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

Delete a webhook

client.realtimeKit.webhooks.deleteWebhook(stringappId, stringwebhookId, WebhookDeleteWebhookParams { account_id } params, RequestOptionsoptions?): WebhookDeleteWebhookResponse { data, success }

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

ModelsExpand Collapse

WebhookGetWebhooksResponse { data, success }

data: Array<Data>

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<"meeting.started" | "meeting.ended" | "meeting.participantJoined" | 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 { data, success }

data: Data { 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<"meeting.started" | "meeting.ended" | "meeting.participantJoined" | 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 { data, success }

data: Data { 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<"meeting.started" | "meeting.ended" | "meeting.participantJoined" | 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 { data, success }

data: Data { 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<"meeting.started" | "meeting.ended" | "meeting.participantJoined" | 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 { data, success }

data: Data { 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<"meeting.started" | "meeting.ended" | "meeting.participantJoined" | 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 { data, success }

data: Data { 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<"meeting.started" | "meeting.ended" | "meeting.participantJoined" | 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