Update a webhook endpoint

PATCH/v1/webhooks/{id}

Changes the endpoint's URL, events, description or whether it is enabled. 404 for an endpoint you cannot see.

Path Parameters

id*Id

The webhook endpoint's id.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The endpoint fields to change; a field you leave out keeps its value.

url?|

Where the events are sent, as POST requests. Must be https:// (400 otherwise).

events?array<>|

The event types to send, at least one. Replaces the current list.

description?|

Your note about the endpoint. null clears it.

enabled?|

false stops sending events to the endpoint; true resumes.

Response Body

`application/json`

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

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "url": "string",  "description": "string",  "events": [    "model.ready"  ],  "enabled": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "error": {    "code": "string",    "message": "string",    "details": null  }}

Update a webhook endpoint

Path Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`