Get the Event Catalog

GET /notifications/event-catalog

Get Event Catalog

cURL

curl --request GET \
  --url https://api.example.com/notifications/event-catalog \
  --header 'Authorization: Bearer <token>'

200

{}

Any authenticated request with an active organization can call this — no manage scope required, since this only lists what’s subscribable. Returns the subscribable slice of the notification registry, straight from event_catalog() — the same source of truth the delivery pipeline uses, so this list never drifts from what actually fires. Events marked always_send in the registry (operational alerts like feedback owner/assignee notices, which ignore per-user preferences) are excluded, since a toggle for them would do nothing.

Auth

No CRM scope is checked here — an active organization on the token is the only requirement, and its absence is the sole cause of a 403.

Response

Field	Type	Description
events	array of event objects	See below.
events[].event_type	string	Stable identifier, e.g. "deal.stage_changed". Pass this as event_type to Emit a Notification Event.
events[].category	string	Grouping key for organizing subscribable events, e.g. "deals".
events[].label	string	Short human-readable name.
events[].description	string	One-line explanation of when the event fires.
events[].default_in_app	boolean	Whether the in-app feed is on by default for this event.
events[].default_cadence	string	Default email cadence: "off", "immediate", or "digest".

Errors

Status	Cause
403 Forbidden	No active organization on the token.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

The response is of type Response Get Event Catalog Notifications Event Catalog Get · object.