Webhooks
Update or pause a webhook
Changes an endpoint's url, description or events, or switches it on or off with enabled. Send only the fields to change. A list of events replaces the whole list.
Requires: desk.admin scope, workspace owner or admin.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Path Parameters
id*string
The webhook's id (a UUID).
Request Body
application/json
Response
OK
Example
{ "webhook": { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "url": "https://example.com/file", "description": "example", "events": [ "example" ], "enabled": false, "secret_prefix": "example", "created_by": "example", "created_at": "2026-10-14T08:30:00Z", "updated_at": "2026-10-14T08:30:00Z", "last_delivery": { "status": "open", "at": "example" } }}FieldTypeDescription
webhookrequiredobjectidrequiredstringurlrequiredstringdescriptionrequiredstringeventsrequiredstring[]enabledrequiredbooleanTrue to switch it on, false to switch it off.secret_prefixrequiredstringcreated_bystring | nullcreated_atrequiredstringupdated_atrequiredstringlast_deliveryrequiredanystatusrequiredstringThe status to set.atrequiredstringcurl -X PATCH "https://api.sautidesk.com/v1/desk/webhooks/string" \ -H "Content-Type: application/json" \ -d '{ "enabled": false }'