notifications
POST /v1/notification-connections
Connect a destination.
Authentication
Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.
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 POST https://api.zinndigital.com/v1/notification-connections \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "kind": <string<email, slack, telegram, webhook>>, "label": <string>, "target": <string> }'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
Adds a destination. Many of the same kind are supported and expected - two Telegram chats, three Slack channels, an accountant's e-mail that belongs to no platform user. A new connection is NOT usable until it has been verified: it must send a real test message first. A destination that has only been typed correctly has not been shown to work, and this whole surface exists because two channels sat configured and silent.
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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
kind | string<email, slack, telegram, webhook> | Yes | SMS and push are deliberately absent - both were rejected. Offering a kind nobody can use is a placeholder with a dropdown. |
label | string | Yes | — |
target | string | Yes | The NON-secret half - an address, a channel name, a chat id. |
credential | string | No | The credential itself - a Slack incoming-webhook URL, or a Telegram bot token. Required for those two kinds and refused for the others: a webhook's signing secret is ours to mint… |
personal | boolean | No | true = this is MY destination and only my own matrix addresses it. The owning user is the authenticated principal, never a value in this body. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | No | — |
kind | string<email, slack, telegram, webhook> | No | — |
label | string | No | — |
target | string | No | — |
personal | boolean | No | — |
verified | boolean | No | Until this is true nothing is routed here. For a machine destination it becomes true when a real test message has been delivered; for an e-mail address it becomes true only when… |
verified_at | string | No | — |
checked_at | string | No | When we last managed to LOOK, as against verified_at which is when we last PROVED it works. One field cannot answer both: without the pair, "we have not been able to reach your… |
awaiting_confirmation | boolean | No | An e-mail destination that has been sent its confirmation link and is waiting for the recipient. Neither verified nor failed - a third state, and showing it as "not verified"… |
verify_error | string | No | — |
verify_error_code | string<their_endpoint_refused, their_endpoint_unreachable, their_credential_rejected, their_recipient_refused, not_configured, our_fault, could_not_check, > | No | The TRANSLATABLE half of verify_error. That sentence is authored English and this payload is rendered in 57 other languages, so a German customer was shown a translated wrapper… |
health | string<healthy, idle, failing, unverified> | No | ⚖️ Owner, 2026-09-03 - "can you get something to check that is set up and working properly please". verified answers did this EVER work; this answers is it working NOW,… |
last_delivery_at | string | No | When a real notification was last DELIVERED here, as against verified. |
last_failure_at | string | No | — |
last_delivery_error | string | No | Why the last delivery failed, in copy WE authored, chosen from a closed table by what failed and where it was going (engine.notifications.failure_copy). It is never the… |
last_delivery_error_code | string<their_endpoint_refused, their_endpoint_unreachable, their_credential_rejected, their_recipient_refused, not_configured, our_fault, could_not_check, > | No | The translatable half of last_delivery_error, on the same contract as verify_error_code. Classified by the adapter at the seam that knew what happened, never re-derived… |
consecutive_failures | integer | No | Reset to 0 by any success, so a destination that recovers stops reporting itself broken with nobody pressing anything. failing is three in a row - one 502 from somebody's own… |
signing_secret | string | No | Webhook destinations only, and returned ONCE on create. Use it to verify the X-Zinn-Signature header. There is no endpoint that will show it again - one would turn a read of the… |
signing_secret_notice | string | No | — |
routes | object | No | The FULL grid for this connection, one boolean per notification topic. |