Webhook Event Catalogue

GET/api/webhooks/events

The authoritative list of names a webhook can subscribe to. It is derived from the REST resource surface of this RISE installation, so it always matches the resources that really exist: every writable resource contributes <resource>.created, <resource>.updated and <resource>.deleted.

Three subscription shapes are accepted: the exact event name (invoices.created), the resource wildcard (invoices.*, every event of that resource) and the global wildcard (*, every event of every resource). The read-only activity log resource emits nothing, since it is itself an audit trail of the other resources.

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area
curl -X GET "https://yoursite.com/api/webhooks/events" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
{
  "total_events": 102,
  "wildcard": "*",
  "resource_wildcard": "<resource>.*",
  "signature_header": "X-Rise-Signature",
  "groups": {
    "clients": {
      "clients.created": "Client created",
      "clients.updated": "Client updated",
      "clients.deleted": "Client deleted",
      "clients.*": "Every client event"
    },
    "invoices": {
      "invoices.created": "Invoice created",
      "invoices.updated": "Invoice updated",
      "invoices.deleted": "Invoice deleted",
      "invoices.*": "Every invoice event"
    }
  }
}
MethodGET
Path/api/webhooks/events
GroupWebhooks
Sincev1.0.0
Defined inRestApi/Controllers/WebhooksController.php