notifications
POST /v1/notification-connections
Connect a destination.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
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… |
अनुरोध बॉडी
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
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. |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
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. |