Update a webhook

PUT

https://api.cloudflare.com/client/v4/accounts/{identifier}/alerting/v3/destinations/webhooks/{uuid}

Last modified:2022-12-16 13:48:34

Update a webhook destination.

Request

Path Params

uuid

string

required

identifier

string

required

Body Params application/json

name

string

required

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

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.

url

string

required

The POST endpoint to call when dispatching a notification.

Example:

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

Example

{
    "name": "Slack Webhook",
    "secret": "string",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//alerting/v3/destinations/webhooks/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Slack Webhook",
    "secret": "string",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
}'

Responses

🟢200Update a webhook response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
    },
    "success": true
}

🟢200Update a webhook response failure

Modified at 2022-12-16 13:48:34

Get a webhook

List Invitations