List webhooks

Gets a list of all configured webhook destinations.

application/json

Body

result

required

Any of

allOf {2}

array[object (webhooks) {8}]

allOf {2}

One of

array[object (webhooks) {8}]

object

created_at

string <date-time>

webhooks_components-schemas-created_at

read-onlyoptional

Timestamp of when the webhook destination was created.

Example:

2020-10-26T18:25:04.532316Z

string

uuid

read-onlyoptional

UUID

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

last_failure

string <date-time>

last_failure

read-onlyoptional

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

Example:

2020-10-26T18:25:04.532316Z

last_success

string <date-time>

last_success

read-onlyoptional

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

Example:

2020-10-26T18:25:04.532316Z

name

string

webhooks_components-schemas-name

optional

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

Example:

Slack Webhook

secret

string

schemas-secret

optional

Optional secret that will be passed in the cf-webhook-auth header when dispatching a webhook notification. Secrets are not returned in any API response body.

type

enum<string>

webhooks_components-schemas-type

optional

Type of webhook endpoint.

Allowed values:

slackgenericgchat

Example:

slack

url

string

webhooks_components-schemas-url

optional

The POST endpoint to call when dispatching a notification.

Example:

https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "created_at": "2020-10-26T18:25:04.532316Z",
            "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
            "last_failure": "2020-10-26T18:25:04.532316Z",
            "last_success": "2020-10-26T18:25:04.532316Z",
            "name": "Slack Webhook",
            "secret": "string",
            "type": "slack",
            "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses