List subscribable event keys

GET /api/v1/admin/webhooks/event-catalog prm_notifications_manage

Every event an endpoint may subscribe to, with its category. The create and update endpoints validate the events array against exactly this set, so read it before writing one. Static for the life of the release, so fetch it once and cache it.

At a glance

Authentication: Staff token or session
Requires permission: prm_notifications_manage Manage notification channels & templates

Request

curl -X GET "$BASE/api/v1/admin/webhooks/event-catalog" \
  -H "Authorization: Bearer $XR_TOKEN"

Response 200 OK

{
  "data": [
    { "key": "user.created", "category": "lifecycle" },
    { "key": "user.disconnected", "category": "lifecycle" },
    { "key": "usage.threshold", "category": "usage" }
  ],
  "meta": { "page": 1, "page_size": 3, "total": 3, "has_next": false }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us