Skip to main content
PATCH
Update a webhook

Authorizations

X-API-Key
string
header
required

Path Parameters

webhook_id
string
required

Body

application/json

Partial-update body for a webhook — only the fields you send are changed. mode and provider are immutable after creation. Sending an explicit null for definition_id, description, or enabled is rejected with 422; input_template, dispatch_retry, and rate_limit may be cleared with null.

definition_id
string | null
description
string | null
Required string length: 1 - 200
input_template
Input Template · object | null
dispatch_retry
Dispatch Retry · object | null
rate_limit
integer | null
Required range: x > 0
enabled
boolean | null

Response

Successful Response

A webhook configuration. Never includes the signing secret — that is returned exactly once at creation (and on rotation).

id
string
required
definition_id
string
required
org_id
string
required
description
string
required
mode
string
required
provider
string
required
input_template
Input Template · object | null
required
dispatch_retry
Dispatch Retry · object | null
required
rate_limit
integer | null
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required