Update a webhook endpoint

PATCH 
/api/v1/workspaces/:workspace_id/webhook_endpoints/:id

Updates an existing webhook endpoint. event_type is immutable and silently ignored if present in the request body. Only the OAuth application that created the endpoint may update it: an endpoint created by another application of the same workspace is visible on GET but returns 403 here. Endpoints created from the Scribee web interface belong to no application and are managed from the web interface only - they return 403 for every OAuth application, whichever one calls.

Request

Responses

200

The webhook endpoint was updated and is returned with its new attribute values. event_type is immutable: if present in the request body it is silently ignored.

401

The request is missing a bearer token, or the token is invalid or expired.

403

The OAuth application's token is valid, but the application has no access grant for the requested workspace, or no such workspace exists.

404

No webhook endpoint with this id exists in this workspace.

422

The webhook_endpoint payload failed validation - url must use https, and category_id may only be set on an event type fan-out can route by category. The includes rule differs here from the one on create - it is checked only when you send a different value, so an endpoint that already stores an include its event type no longer allows keeps updating, and clearing includes is always accepted. Sending a new one is what is refused. The response body lists each invalid attribute and the reason under errors.