Sign in

v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB

Update a webhook endpoint

patch/v1/webhook-endpoints/{endpoint_id}

Path parameters

endpoint_idstring required
Example:whe_9ZtRcXw3nByK5pVqMaEfJs

The endpoint_id must be a prefixed ID (e.g. whe_9ZtRcXw3nByK5pVqMaEfJs).

Request body

namestring
urlstring uri
event_typesWebhookEventType[]
headersobject
timeout_msinteger
enabledboolean

Response

Webhook endpoint updated successfully.

idstring required
namestring required
urlstring uri required
enabledboolean required
event_typesWebhookEventType[] required
headersobject
timeout_msinteger required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "whe_9ZtRcXw3nByK5pVqMaEfJs"
}