notifications
GET /v1/notification-connections
Connected destinations and the routing matrix.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/notification-connections \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Every destination this organisation has connected - e-mail addresses, Slack channels, Telegram chats - with the full grid of which notification types go to each. The grid is returned COMPLETE rather than as the stored deviations. Only the cells a human switched OFF are persisted (absence means enabled), so a client that had to infer "everything not listed is on" would be re-implementing that default - and two implementations of one decision is how a customer ends up on a ladder nobody chose.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
connections | NotificationConnection[] | No | — |
topics | object[] | No | The routing units. TOPICS, not notification types - the matrix used to address a type enum that no notification template declares, so no cell of it could ever have addressed a m… |