---
title: Destinations
---

[Skip to content](#_top)

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

[Alerting](https://developers.cloudflare.com/api/python/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/python/resources/alerting/subresources/destinations/subresources/eligible/methods/get)

alerting.destinations.eligible.get(EligibleGetParams\*\*kwargs) -> [EligibleGetResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)>)

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

##### ModelsExpand Collapse

<details>

<summary>

Dict\[str, List\[EligibleGetResponseItem]]

</summary>

eligible: Optional\[bool]

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

<a href="#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(items)%20%3E%20(property)%20eligible">Link to this property</a>

ready: Optional\[bool]

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

<a href="#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(items)%20%3E%20(property)%20ready">Link to this property</a>

<details>

<summary>

type: Optional\[Literal\["email", "pagerduty", "webhook"]]

Determines type of delivery mechanism.

</summary>

One of the following:

"email"

<a href="#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"pagerduty"

<a href="#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

"webhook"

<a href="#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%202">Link to this property</a>

</details>

<a href="#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.eligible%20%3E%20(model)%20eligible_get_response%20%3E%20(schema)>)

#### DestinationsPagerduty

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

alerting.destinations.pagerduty.get(PagerdutyGetParams\*\*kwargs) -> SyncSinglePage\[[Pagerduty](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty%20%3E%20(schema)>)]

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

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

alerting.destinations.pagerduty.create(PagerdutyCreateParams\*\*kwargs) -> [PagerdutyCreateResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_create_response%20%3E%20(schema)>)

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

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

alerting.destinations.pagerduty.delete(PagerdutyDeleteParams\*\*kwargs) -> [PagerdutyDeleteResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)>)

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

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

alerting.destinations.pagerduty.link(strtoken\_id, PagerdutyLinkParams\*\*kwargs) -> [PagerdutyLinkResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_link_response%20%3E%20(schema)>)

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

##### ModelsExpand Collapse

<details>

<summary>

class Pagerduty: …

</summary>

id: Optional\[str]

UUID

maxLength32

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

name: Optional\[str]

The name of the pagerduty service.

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty%20%3E%20(schema)>)

<details>

<summary>

class PagerdutyCreateResponse: …

</summary>

id: Optional\[str]

token in form of UUID

maxLength32

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_create_response%20%3E%20(schema)>)

<details>

<summary>

class PagerdutyDeleteResponse: …

</summary>

<details>

<summary>

errors: List\[Error]

</summary>

message: str

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

code: Optional\[int]

minimum1000

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

</details>

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors">Link to this property</a>

<details>

<summary>

messages: List\[Message]

</summary>

message: str

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

code: Optional\[int]

minimum1000

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

</details>

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages">Link to this property</a>

success: Literal\[true]

Whether the API call was successful

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_delete_response%20%3E%20(schema)>)

<details>

<summary>

class PagerdutyLinkResponse: …

</summary>

id: Optional\[str]

UUID

maxLength32

<a href="#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_link_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.pagerduty%20%3E%20(model)%20pagerduty_link_response%20%3E%20(schema)>)

#### DestinationsWebhooks

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

alerting.destinations.webhooks.list(WebhookListParams\*\*kwargs) -> SyncSinglePage\[[Webhooks](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)>)]

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

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

alerting.destinations.webhooks.get(strwebhook\_id, WebhookGetParams\*\*kwargs) -> [Webhooks](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)>)

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

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

alerting.destinations.webhooks.create(WebhookCreateParams\*\*kwargs) -> [WebhookCreateResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_create_response%20%3E%20(schema)>)

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

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

alerting.destinations.webhooks.update(strwebhook\_id, WebhookUpdateParams\*\*kwargs) -> [WebhookUpdateResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_update_response%20%3E%20(schema)>)

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

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

alerting.destinations.webhooks.delete(strwebhook\_id, WebhookDeleteParams\*\*kwargs) -> [WebhookDeleteResponse](<https://developers.cloudflare.com/api/python/resources/alerting#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)>)

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

##### ModelsExpand Collapse

<details>

<summary>

class Webhooks: …

</summary>

id: Optional\[str]

The unique identifier of a webhook

maxLength32

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created\_at: Optional\[datetime]

Timestamp of when the webhook destination was created.

formatdate-time

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20created_at">Link to this property</a>

last\_failure: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20last_failure">Link to this property</a>

last\_success: Optional\[datetime]

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

formatdate-time

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20last_success">Link to this property</a>

name: Optional\[str]

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

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

secret: Optional\[str]

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

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20secret">Link to this property</a>

<details>

<summary>

type: Optional\[Literal\["datadog", "discord", "feishu", 5 more]]

Type of webhook endpoint.

</summary>

One of the following:

"datadog"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"discord"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

"feishu"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%202">Link to this property</a>

"gchat"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%203">Link to this property</a>

"generic"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%204">Link to this property</a>

"opsgenie"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%205">Link to this property</a>

"slack"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%206">Link to this property</a>

"splunk"

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%207">Link to this property</a>

</details>

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20type">Link to this property</a>

url: Optional\[str]

The POST endpoint to call when dispatching a notification.

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)%20%3E%20(property)%20url">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhooks%20%3E%20(schema)>)

<details>

<summary>

class WebhookCreateResponse: …

</summary>

id: Optional\[str]

UUID

maxLength32

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_create_response%20%3E%20(schema)>)

<details>

<summary>

class WebhookUpdateResponse: …

</summary>

id: Optional\[str]

UUID

maxLength32

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_update_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_update_response%20%3E%20(schema)>)

<details>

<summary>

class WebhookDeleteResponse: …

</summary>

<details>

<summary>

errors: List\[Error]

</summary>

message: str

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

code: Optional\[int]

minimum1000

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

</details>

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20errors">Link to this property</a>

<details>

<summary>

messages: List\[Message]

</summary>

message: str

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20message">Link to this property</a>

code: Optional\[int]

minimum1000

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages%20%3E%20(items)%20%3E%20(property)%20code">Link to this property</a>

</details>

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20messages">Link to this property</a>

success: Literal\[true]

Whether the API call was successful

<a href="#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)%20%3E%20(property)%20success">Link to this property</a>

</details>

[Link to this property](<#(resource)%20alerting.destinations.webhooks%20%3E%20(model)%20webhook_delete_response%20%3E%20(schema)>)