--- title: Add a webhook --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Realtime Kit](https://developers.cloudflare.com/api/python/resources/realtime_kit) [Webhooks](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/webhooks) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Add a webhook realtime\_kit.webhooks.create\_webhook(strapp\_id, WebhookCreateWebhookParams\*\*kwargs) -> [WebhookCreateWebhookResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/webhooks Adds a new webhook to an App. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` ##### Accepted Permissions (at least one required) `Realtime Admin``Realtime` ##### ParametersExpand Collapse account\_id: str The account identifier tag. maxLength32 [Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(method)%20create_webhook%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) app\_id: str The app identifier tag. [Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(method)%20create_webhook%20%3E%20(params)%20default%20%3E%20(param)%20app_id%20%3E%20(schema)>)

events: List\[Literal\["meeting.started", "meeting.ended", "meeting.participantJoined", 6 more]] Events that this webhook will get triggered by

One of the following: "meeting.started" Link to this property "meeting.ended" Link to this property "meeting.participantJoined" Link to this property "meeting.participantLeft" Link to this property "meeting.chatSynced" Link to this property "recording.statusUpdate" Link to this property "livestreaming.statusUpdate" Link to this property "meeting.transcript" Link to this property "meeting.summary" Link to this property

[Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(method)%20create_webhook%20%3E%20(params)%20default%20%3E%20(param)%20events%20%3E%20(schema)>) name: str Name of the webhook [Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(method)%20create_webhook%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>) url: str URL this webhook will send events to formaturi [Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(method)%20create_webhook%20%3E%20(params)%20default%20%3E%20(param)%20url%20%3E%20(schema)>) enabled: Optional\[[bool]()] Set whether or not the webhook should be active when created [Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(method)%20create_webhook%20%3E%20(params)%20default%20%3E%20(param)%20enabled%20%3E%20(schema)>) ##### ReturnsExpand Collapse

class WebhookCreateWebhookResponse: …

data: Data

id: str ID of the webhook formatuuid Link to this property created\_at: datetime Timestamp when this webhook was created formatdate-time Link to this property enabled: bool Set to true if the webhook is active Link to this property

events: List\[Literal\["meeting.started", "meeting.ended", "meeting.participantJoined", 6 more]] Events this webhook will send updates for

Link to this property name: str Name of the webhook Link to this property updated\_at: datetime Timestamp when this webhook was updated formatdate-time Link to this property url: str URL the webhook will send events to formaturi Link to this property

Link to this property success: bool Link to this property

[Link to this property](<#(resource)%20realtime_kit.webhooks%20%3E%20(model)%20webhook_create_webhook_response%20%3E%20(schema)>) ### Add a webhook Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.realtime_kit.webhooks.create_webhook( app_id="14a396e7-ca44-4937-bf1f-050a69118543", account_id="023e105f4ecef8ad9ca31a8372d0c353", events=["meeting.started", "meeting.ended", "meeting.participantJoined", "meeting.participantLeft", "meeting.chatSynced", "recording.statusUpdate", "livestreaming.statusUpdate", "meeting.transcript", "meeting.summary"], name="All events webhook", url="https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e", ) print(response.data) ``` 200 example 401 example ``` { "data": { "id": "0d1f069d-43bb-489a-ad8c-7eb95592ba8e", "created_at": "2022-05-28T07:01:53.075Z", "enabled": true, "events": [ "meeting.started", "meeting.ended", "meeting.participantJoined", "meeting.participantLeft", "meeting.chatSynced", "recording.statusUpdate", "livestreaming.statusUpdate", "meeting.transcript", "meeting.summary" ], "name": "All events webhook", "updated_at": "2022-05-28T07:01:53.075Z", "url": "https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e" }, "success": true } ``` ``` "{\n message: \"Unauthorized\"\n}\n" ``` ##### Returns Examples 200 example 401 example ``` { "data": { "id": "0d1f069d-43bb-489a-ad8c-7eb95592ba8e", "created_at": "2022-05-28T07:01:53.075Z", "enabled": true, "events": [ "meeting.started", "meeting.ended", "meeting.participantJoined", "meeting.participantLeft", "meeting.chatSynced", "recording.statusUpdate", "livestreaming.statusUpdate", "meeting.transcript", "meeting.summary" ], "name": "All events webhook", "updated_at": "2022-05-28T07:01:53.075Z", "url": "https://webhook.site/b23a5bbd-c7b0-4ced-a9e2-78ae7889897e" }, "success": true } ``` ``` "{\n message: \"Unauthorized\"\n}\n" ```