Skip to main content
PUT
Update a webhook
Requires scope: manage:webhooks — see Required scopes. Replaces the configuration of an existing webhook.
This is a full replacement, not a partial patch. Send every field you want to keep — including authenticationMethod with its secret, since secrets are never returned by a read and so cannot be carried over implicitly.
Use this to rotate an API key or basic-auth password.

Authorizations

Path Parameters

webhookId
string
required

Unique webhook identifier

Body

application/json

Replaces an existing webhook's configuration. Same shape and validation as registration — a full replacement, not a partial patch.

url
string<uri>
required

Absolute https:// endpoint the webhook delivers to

Maximum string length: 2048
authenticationMethod
object
required

Authentication applied to outbound webhook deliveries, discriminated by type. Secret fields (apiKey, password) are accepted on input and omitted from every read response.

name
string | null
Maximum string length: 255

Response

Webhook updated

success
boolean

Indicates whether the request was successful

result
object

A registered webhook. Authentication secrets are omitted from this representation.