---
title: Destinations
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Alerting](https://developers.cloudflare.com/api/typescript/resources/alerting)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Destinations

#### DestinationsEligible

##### [Get delivery mechanism eligibility](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/eligible/methods/get)

client.alerting.destinations.eligible.get(EligibleGetParams { account\_id } params, RequestOptionsoptions?): [EligibleGetResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.eligible%20%3E%20%28model%29%20eligible%5Fget%5Fresponse%20%3E%20%28schema%29) { eligible, ready, type } 

GET/accounts/{account\_id}/alerting/v3/destinations/eligible

##### ModelsExpand Collapse 

EligibleGetResponse \= Record<string, Array<Item\>\>

eligible?: boolean

Determines whether or not the account is eligible for the delivery mechanism.

ready?: boolean

Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.

type?: "email" | "pagerduty" | "webhook"

Determines type of delivery mechanism.

One of the following:

"email"

"pagerduty"

"webhook"

#### DestinationsPagerduty

##### [List PagerDuty services](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/pagerduty/methods/get)

client.alerting.destinations.pagerduty.get(PagerdutyGetParams { account\_id } params, RequestOptionsoptions?): SinglePage<[Pagerduty](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.pagerduty%20%3E%20%28model%29%20pagerduty%20%3E%20%28schema%29) { id, name } \>

GET/accounts/{account\_id}/alerting/v3/destinations/pagerduty

##### [Create PagerDuty integration token](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/pagerduty/methods/create)

client.alerting.destinations.pagerduty.create(PagerdutyCreateParams { account\_id } params, RequestOptionsoptions?): [PagerdutyCreateResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.pagerduty%20%3E%20%28model%29%20pagerduty%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id } 

POST/accounts/{account\_id}/alerting/v3/destinations/pagerduty/connect

##### [Delete PagerDuty Services](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/pagerduty/methods/delete)

client.alerting.destinations.pagerduty.delete(PagerdutyDeleteParams { account\_id } params, RequestOptionsoptions?): [PagerdutyDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.pagerduty%20%3E%20%28model%29%20pagerduty%5Fdelete%5Fresponse%20%3E%20%28schema%29) { errors, messages, success } 

DELETE/accounts/{account\_id}/alerting/v3/destinations/pagerduty

##### [Connect PagerDuty](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/pagerduty/methods/link)

client.alerting.destinations.pagerduty.link(stringtokenID, PagerdutyLinkParams { account\_id } params, RequestOptionsoptions?): [PagerdutyLinkResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.pagerduty%20%3E%20%28model%29%20pagerduty%5Flink%5Fresponse%20%3E%20%28schema%29) { id } 

GET/accounts/{account\_id}/alerting/v3/destinations/pagerduty/connect/{token\_id}

##### ModelsExpand Collapse 

Pagerduty { id, name } 

id?: string

UUID

maxLength32

name?: string

The name of the pagerduty service.

PagerdutyCreateResponse { id } 

id?: string

token in form of UUID

maxLength32

PagerdutyDeleteResponse { 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

PagerdutyLinkResponse { id } 

id?: string

UUID

maxLength32

#### DestinationsWebhooks

##### [List webhooks](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/webhooks/methods/list)

client.alerting.destinations.webhooks.list(WebhookListParams { account\_id } params, RequestOptionsoptions?): SinglePage<[Webhooks](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.webhooks%20%3E%20%28model%29%20webhooks%20%3E%20%28schema%29) { id, created\_at, last\_failure, 5 more } \>

GET/accounts/{account\_id}/alerting/v3/destinations/webhooks

##### [Get a webhook](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/webhooks/methods/get)

client.alerting.destinations.webhooks.get(stringwebhookID, WebhookGetParams { account\_id } params, RequestOptionsoptions?): [Webhooks](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.webhooks%20%3E%20%28model%29%20webhooks%20%3E%20%28schema%29) { id, created\_at, last\_failure, 5 more } 

GET/accounts/{account\_id}/alerting/v3/destinations/webhooks/{webhook\_id}

##### [Create a webhook](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/webhooks/methods/create)

client.alerting.destinations.webhooks.create(WebhookCreateParams { account\_id, name, url, secret } params, RequestOptionsoptions?): [WebhookCreateResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.webhooks%20%3E%20%28model%29%20webhook%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id } 

POST/accounts/{account\_id}/alerting/v3/destinations/webhooks

##### [Update a webhook](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/webhooks/methods/update)

client.alerting.destinations.webhooks.update(stringwebhookID, WebhookUpdateParams { account\_id, name, url, secret } params, RequestOptionsoptions?): [WebhookUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.webhooks%20%3E%20%28model%29%20webhook%5Fupdate%5Fresponse%20%3E%20%28schema%29) { id } 

PUT/accounts/{account\_id}/alerting/v3/destinations/webhooks/{webhook\_id}

##### [Delete a webhook](https://developers.cloudflare.com/api/typescript/resources/alerting/subresources/destinations/subresources/webhooks/methods/delete)

client.alerting.destinations.webhooks.delete(stringwebhookID, WebhookDeleteParams { account\_id } params, RequestOptionsoptions?): [WebhookDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/alerting#%28resource%29%20alerting.destinations.webhooks%20%3E%20%28model%29%20webhook%5Fdelete%5Fresponse%20%3E%20%28schema%29) { 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