notifications
POST /v1/notification-connections
Connect a destination.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде org_id мәнін қабылдайды. Оны бос қалдырсаңыз, шақыру бүкіл жалға алушы тармағын қамтиды; шақыруды бір ұйымға шектеу үшін оны жіберіңіз.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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> }'Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
org_id (query) | string | Жоқ | 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… |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
kind | string<email, slack, telegram, webhook> | Иә | SMS and push are deliberately absent - both were rejected. Offering a kind nobody can use is a placeholder with a dropdown. |
label | string | Иә | — |
target | string | Иә | The NON-secret half - an address, a channel name, a chat id. |
credential | string | Жоқ | 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 | Жоқ | 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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
id | string | Жоқ | — |
kind | string<email, slack, telegram, webhook> | Жоқ | — |
label | string | Жоқ | — |
target | string | Жоқ | — |
personal | boolean | Жоқ | — |
verified | boolean | Жоқ | 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 | Жоқ | — |
checked_at | string | Жоқ | 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 | Жоқ | 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 | Жоқ | — |
verify_error_code | string<their_endpoint_refused, their_endpoint_unreachable, their_credential_rejected, their_recipient_refused, not_configured, our_fault, could_not_check, > | Жоқ | 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> | Жоқ | ⚖️ 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 | Жоқ | When a real notification was last DELIVERED here, as against verified. |
last_failure_at | string | Жоқ | — |
last_delivery_error | string | Жоқ | 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, > | Жоқ | 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 | Жоқ | 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 | Жоқ | 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 | Жоқ | — |
routes | object | Жоқ | The FULL grid for this connection, one boolean per notification topic. |