SautiDesk
SautiDesk API
Webhooks

List subscribable webhook events

GET
/v1/desk/webhooks/events

Lists every event type a webhook can subscribe to, grouped by category, with a line on what each means. Use it to build a picker or to check a name before subscribing.

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

Response

OK

Example

{  "categories": [    {      "key": "example-value",      "label": "Amina Wanjiru",      "events": [        {          "type": "billing",          "description": "example",          "resource": "example"        }      ]    }  ]}
FieldTypeDescription
categoriesrequiredobject[]
keyrequiredstring
labelrequiredstringA short name to recognise it by.
eventsrequiredobject[]
typerequiredstring
descriptionrequiredstring
resourcerequiredstring
curl -X GET "https://api.sautidesk.com/v1/desk/webhooks/events"