Get Event Catalog
curl --request GET \
--url https://api.example.com/notifications/event-catalog \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/notifications/event-catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/notifications/event-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/notifications/event-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/notifications/event-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/notifications/event-catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/notifications/event-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{}Notifications
Get the Event Catalog
GET
/
notifications
/
event-catalog
Get Event Catalog
curl --request GET \
--url https://api.example.com/notifications/event-catalog \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/notifications/event-catalog"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/notifications/event-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/notifications/event-catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/notifications/event-catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/notifications/event-catalog")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/notifications/event-catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{}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 a403.
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
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.