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

realtime_kit.webhooks.get_webhooks(strapp_id, WebhookGetWebhooksParams**kwargs) -> WebhookGetWebhooksResponse

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

Add a webhook

realtime_kit.webhooks.create_webhook(strapp_id, WebhookCreateWebhookParams**kwargs) -> WebhookCreateWebhookResponse

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

Fetch details of a webhook

realtime_kit.webhooks.get_webhook_by_id(strwebhook_id, WebhookGetWebhookByIDParams**kwargs) -> WebhookGetWebhookByIDResponse

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

Replace a webhook

realtime_kit.webhooks.replace_webhook(strwebhook_id, WebhookReplaceWebhookParams**kwargs) -> WebhookReplaceWebhookResponse

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

Edit a webhook

realtime_kit.webhooks.edit_webhook(strwebhook_id, WebhookEditWebhookParams**kwargs) -> WebhookEditWebhookResponse

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

Delete a webhook

realtime_kit.webhooks.delete_webhook(strwebhook_id, WebhookDeleteWebhookParams**kwargs) -> WebhookDeleteWebhookResponse

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

ModelsExpand Collapse

class WebhookGetWebhooksResponse: …

data: List[Data]

id: str

ID of the webhook

formatuuid

created_at: datetime

Timestamp when this webhook was created

formatdate-time

enabled: bool

Set to true if the webhook is active

events: List[Literal["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: str

Name of the webhook

updated_at: datetime

Timestamp when this webhook was updated

formatdate-time

url: str

URL the webhook will send events to

formaturi

success: bool

class WebhookCreateWebhookResponse: …

data: Data

id: str

ID of the webhook

formatuuid

created_at: datetime

Timestamp when this webhook was created

formatdate-time

enabled: bool

Set to true if the webhook is active

events: List[Literal["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: str

Name of the webhook

updated_at: datetime

Timestamp when this webhook was updated

formatdate-time

url: str

URL the webhook will send events to

formaturi

success: bool

class WebhookGetWebhookByIDResponse: …

data: Data

id: str

ID of the webhook

formatuuid

created_at: datetime

Timestamp when this webhook was created

formatdate-time

enabled: bool

Set to true if the webhook is active

events: List[Literal["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: str

Name of the webhook

updated_at: datetime

Timestamp when this webhook was updated

formatdate-time

url: str

URL the webhook will send events to

formaturi

success: bool

class WebhookReplaceWebhookResponse: …

data: Data

id: str

ID of the webhook

formatuuid

created_at: datetime

Timestamp when this webhook was created

formatdate-time

enabled: bool

Set to true if the webhook is active

events: List[Literal["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: str

Name of the webhook

updated_at: datetime

Timestamp when this webhook was updated

formatdate-time

url: str

URL the webhook will send events to

formaturi

success: bool

class WebhookEditWebhookResponse: …

data: Data

id: str

ID of the webhook

formatuuid

created_at: datetime

Timestamp when this webhook was created

formatdate-time

enabled: bool

Set to true if the webhook is active

events: List[Literal["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: str

Name of the webhook

updated_at: datetime

Timestamp when this webhook was updated

formatdate-time

url: str

URL the webhook will send events to

formaturi

success: bool

class WebhookDeleteWebhookResponse: …

data: Data

id: str

ID of the webhook

formatuuid

created_at: datetime

Timestamp when this webhook was created

formatdate-time

enabled: bool

Set to true if the webhook is active

events: List[Literal["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: str

Name of the webhook

updated_at: datetime

Timestamp when this webhook was updated

formatdate-time

url: str

URL the webhook will send events to

formaturi

success: bool