API Reference

Alerting

Destinations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Webhooks

List webhooks

client.alerting.destinations.webhooks.list(WebhookListParams { account_id } params, RequestOptionsoptions?): SinglePage<Webhooks { id, created_at, last_failure, 5 more } >

GET/accounts/{account_id}/alerting/v3/destinations/webhooks

Get a webhook

client.alerting.destinations.webhooks.get(stringwebhookId, WebhookGetParams { account_id } params, RequestOptionsoptions?): Webhooks { id, created_at, last_failure, 5 more }

GET/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

Create a webhook

client.alerting.destinations.webhooks.create(WebhookCreateParams { account_id, name, url, secret } params, RequestOptionsoptions?): WebhookCreateResponse { id }

POST/accounts/{account_id}/alerting/v3/destinations/webhooks

Update a webhook

client.alerting.destinations.webhooks.update(stringwebhookId, WebhookUpdateParams { account_id, name, url, secret } params, RequestOptionsoptions?): WebhookUpdateResponse { id }

PUT/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

Delete a webhook

client.alerting.destinations.webhooks.delete(stringwebhookId, WebhookDeleteParams { account_id } params, RequestOptionsoptions?): WebhookDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

ModelsExpand Collapse

Webhooks { id, created_at, last_failure, 5 more }

id?: string

The unique identifier of a webhook

maxLength32

created_at?: string

Timestamp of when the webhook destination was created.

formatdate-time

last_failure?: string

Timestamp of the last time an attempt to dispatch a notification to this webhook failed.

formatdate-time

last_success?: string

Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.

formatdate-time

name?: string

The name of the webhook destination. This will be included in the request body when you receive a webhook notification.

secret?: string

Optional secret that will be passed in the cf-webhook-auth header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.

type?: "datadog" | "discord" | "feishu" | 5 more

Type of webhook endpoint.

One of the following:

"datadog"

"discord"

"feishu"

"gchat"

"generic"

"opsgenie"

"slack"

"splunk"

url?: string

The POST endpoint to call when dispatching a notification.

WebhookCreateResponse { id }

id?: string

UUID

maxLength32

WebhookUpdateResponse { id }

id?: string

UUID

maxLength32

WebhookDeleteResponse { errors, messages, success }

errors: Array<Error>

message: string

code?: number

minimum1000

messages: Array<Message>

message: string

code?: number

minimum1000

success: true

Whether the API call was successful