Update a webhook

PATCH/webhooks/{webhook_id}

Update a webhook, including status transitions (pause/resume/re-enable).

Path Parameters

webhook_id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

PATCH body. status covers pause/resume/re-enable (only active and paused are accepted; disabled is set by the system). Re-enabling clears disabled_reason and the failure streak.

name?string

Length1 <= length <= 255

url?string

Lengthlength <= 2048

events?array<string>

Items1 <= items

status?WebhookStatusUpdate

Status values a client may PATCH. disabled is system-only.

Value in

"active"
"paused"

headers?

Custom request headers. Omit to keep the current set; an empty map clears them. A blank value keeps that header's stored value; to remove a header, send the map without its name.

format?WebhookFormat

How events are encoded in the request body.

Value in

"single"
"array"
"ndjson"

max_events?integer

Formatint32

Range1 <= value <= 100

template?string

Go text/template for the delivered body; empty clears it, back to the default envelope. It must render valid JSON against vars.

Lengthlength <= 8192

condition?string

CEL expression an event must satisfy to be delivered; empty clears it, back to delivering every subscribed event.

Lengthlength <= 1024

destination?string

The destination this webhook is set up for, such as slack; empty clears it. A label for display only.

Lengthlength <= 64

vars?

Template variables. Omit to keep the current set; an empty map clears them. A blank value keeps that variable's stored value; to remove a variable, send the map without its name.

Response Body

`application/json`

curl -X PATCH "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "url": "string",  "events": [    "string"  ],  "status": "active",  "disabled_reason": "circuit_breaker",  "failing_since": "2019-08-24T14:15:22Z",  "last_delivery_status": "pending",  "last_delivery_at": "2019-08-24T14:15:22Z",  "format": "single",  "max_events": 0,  "has_custom_headers": true,  "header_keys": [    "string"  ],  "template": "string",  "condition": "string",  "destination": "string",  "var_keys": [    "string"  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Update a webhook

Path Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`