Skip to main content
PATCH
Update a webhook endpoint
Updates the URL, description, events, workspaces or activation of an endpoint. Send only the fields you want to change. Re-enabling an endpoint that was disabled for failures clears its failure state. Integration webhooks require an active Business, Agency Business or Enterprise plan. Changing an endpoint also requires an API token with write access enabled by an Owner or Manager. See Integration webhooks and Writing data.
string
required
Bearer token for your team.
string
required
The ETag from Get a webhook endpoint, including its quotes. Use * to write unconditionally.
string
required
Endpoint identifier.
string
Public HTTPS URL, at most 2048 characters.
string | null
Free description, at most 200 characters, or null to clear it.
string[]
Complete replacement list of event types, at least one.
string[]
Complete replacement list of at most 100 workspaces. An empty array receives the events of every workspace.
boolean
false pauses delivery; true resumes it.
Supply at least one field.

Response

Returns 200, the new ETag and the endpoint, with the fields described in List webhook endpoints.

Synthetic request and response

This example assumes the ETag you last read is "0".

Errors

See Error codes for authentication, plan, idempotency and server errors. A token without write access returns 403 API_KEY_READ_ONLY. On 429, honor Retry-After. If the write limiter is unavailable or writes are suspended, the request returns 503 SERVICE_UNAVAILABLE and nothing changes.