API documentation
1 endpoint
Event catalogue
The list of every event type you can subscribe to.
Endpoint names and descriptions come from the OpenAPI contract, in English — they cannot drift from the API.
Start in test mode
You create your test key in the portal as soon as your account is activated.
In plain English
Declare and monitor the addresses that receive those notifications.
When to use it
When choosing your subscription list, and any time you wonder whether an event exists.
How to integrate it
- 1Read the catalogue before coding your event list rather than guessing it.
GET200
List every subscribable webhook event type
Returns the canonical dotted event names accepted by enabledEvents and sent back in the Chari-Event-Type delivery header. Pass emittedOnly=true to keep only the events this release actually publishes.
| Field | Type | In | Required | Description |
|---|---|---|---|---|
emittedOnly | boolean | query | Optional |
Make your first test-mode call
Create your account, generate your test key in the portal and send your first request today — or talk to an integrator.
- Free, no commitment
- Test mode from sign-up
- No approval to wait for