Update a webhook subscription

Read the existing subscription first and retain its URL. Every update requires a non-empty url, even if only status or eventTypes is changing. V3 status values are strings: Enabled, Disabled or Defective; V2 creation uses numeric status values.

Update a webhook subscription. PUT /api/ext/v3/webhooks/{id}.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, webhooks:write. API access tokens may satisfy a listed scope through the configured scope hierarchy; OIDC tokens are checked against their scope claims. Legacy JWT authentication does not use this scope check. Authentication, role, tenant, and applicable feature or plan checks still apply. For HTTP 403, check the credential type, applicable scopes, roles, and workspace access; 403 does not always mean a missing scope. Authentication/authorization failures do not guarantee a JSON response body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Webhook ID.

Body Params
uri
required
eventTypes
array of strings
eventTypes
string
enum
Allowed:
Responses

400

Webhook URL is required, the URL is unsafe, or the supplied event types are invalid or unavailable.

403

Authorization failed. Check the Permissions section for the credential-specific scope rules, and check roles and workspace access. The response may have no body; do not require a JSON error envelope.

404

No webhook subscription was found for the supplied id.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json