notifications

POST `/v1/notification-connections/{connection_id}/verify`

Send a real test message to a destination.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X POST https://api.zinndigital.com/v1/notification-connections/{connection_id}/verify \
  -H "Authorization: Bearer zdk_live_…"

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

Sends an actual message and records what happened. It does not check that the destination looks plausible; nothing may be routed to a connection until this has succeeded.

Paraméterek

Név	Típus	Kötelező	Mi ez
`connection_id (path)`	`string`	Igen	—
`org_id (query)`	`string`	Nem	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…

Válasz

Név	Típus	Kötelező	Mi ez
`verified`	`boolean`	Nem	—
`awaiting_confirmation`	`boolean`	Nem	An e-mail destination has been sent its confirmation link and is waiting for the recipient to click it. Not verified, and not a failure.
`unknown`	`boolean`	Nem	⛔⛔ We could not CHECK - which is not the same as it failed, and until W39-AM this response could not say the difference. Both were `verified: false`, so a credential-store bli…
`error`	`string`	Nem	Safe to display - never contains a credential.