Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Webhooks

Update a webhook

Applies a partial update to the supplied webhook. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted webhook after the update. Returns 400 webhook_not_found if the id does not exist.

put/v6/webhooks/{webhook_id}

Path parameters

webhook_idstring required

The id of the webhook to be updated.

Request body

component_idsstring[]
tagsstring[]

Example request

{
  "client_key_id": "handlebars@buildtime:{{clientKeyId}}",
  "default_method": "handlebars@buildtime:{{defaultMethod}}",
  "description": "handlebars@buildtime:{{description}}",
  "enabled": "handlebars@buildtime:{{enabled}}",
  "name": "handlebars@buildtime:{{name}}",
  "request": "handlebars@buildtime:{{request}}",
  "response_body_handler": "handlebars@buildtime:{{responseBodyHandler}}",
  "response_handler": "handlebars@buildtime:{{responseHandler}}",
  "url": "handlebars@buildtime:{{url}}"
}

Response

Updated webhook.

OR
OR
OR

Example response

{
  "client_key_id": "handlebars@buildtime:{{clientKeyId}}",
  "created_at": "2025-10-24T02:00:00-07:00",
  "default_method": "handlebars@buildtime:{{defaultMethod}}",
  "description": "handlebars@buildtime:{{description}}",
  "enabled": "handlebars@buildtime:{{enabled}}",
  "name": "handlebars@buildtime:{{name}}",
  "request": "handlebars@buildtime:{{request}}",
  "response_handler": "handlebars@buildtime:{{responseHandler}}",
  "retry_intervals": [
    "PT42S"
  ],
  "updated_at": "2025-10-24T02:00:00-07:00",
  "url": "handlebars@buildtime:{{url}}"
}