Skip to content
Cloudflare API
Start here
API Reference
Realtime Kit
Webhooks

Edit a webhook

realtime_kit.webhooks.edit_webhook(strwebhook_id, WebhookEditWebhookParams**kwargs) -> WebhookEditWebhookResponse
PATCH/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Edits the webhook details for the given webhook ID.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Realtime AdminRealtime
ParametersExpand Collapse
account_id: str

The account identifier tag.

maxLength32
app_id: str

The app identifier tag.

webhook_id: str
formatuuid
enabled: Optional[bool]
events: Optional[List[Literal["meeting.started", "meeting.ended", "meeting.participantJoined", 6 more]]]

Events that the webhook will get triggered by

One of the following:
"meeting.started"
"meeting.ended"
"meeting.participantJoined"
"meeting.participantLeft"
"recording.statusUpdate"
"livestreaming.statusUpdate"
"meeting.chatSynced"
"meeting.transcript"
"meeting.summary"
name: Optional[str]

Name of the webhook

url: Optional[str]

URL the webhook will send events to

formaturi
ReturnsExpand Collapse
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

Edit a webhook

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.edit_webhook(
    webhook_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="14a396e7-ca44-4937-bf1f-050a69118543",
)
print(response.data)
{
  "data": {
    "created_at": "2023-07-15T07:08:26.634Z",
    "enabled": true,
    "events": [
      "meeting.started"
    ],
    "id": "b6e0fd13-d7f4-4122-9ad5-7994b35d24b8",
    "name": "My Webhook",
    "updated_at": "2023-07-15T07:08:26.634Z",
    "url": "https://example.com/webhook"
  },
  "success": true
}
{
  "error": {
    "code": 400,
    "message": "BAD_REQUEST: \"id\" must be a valid GUID"
  },
  "success": false
}
"{\n  \"message\": \"Unauthorized\"\n}\n"
Returns Examples
{
  "data": {
    "created_at": "2023-07-15T07:08:26.634Z",
    "enabled": true,
    "events": [
      "meeting.started"
    ],
    "id": "b6e0fd13-d7f4-4122-9ad5-7994b35d24b8",
    "name": "My Webhook",
    "updated_at": "2023-07-15T07:08:26.634Z",
    "url": "https://example.com/webhook"
  },
  "success": true
}
{
  "error": {
    "code": 400,
    "message": "BAD_REQUEST: \"id\" must be a valid GUID"
  },
  "success": false
}
"{\n  \"message\": \"Unauthorized\"\n}\n"