notifications

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

Send a real test message to a destination.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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.

Parameters

Naam	Type	Verplicht	Wat dit is
`connection_id (path)`	`string`	Ja	—
`org_id (query)`	`string`	Nee	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…

Reactie

Naam	Type	Verplicht	Wat dit is
`verified`	`boolean`	Nee	—
`awaiting_confirmation`	`boolean`	Nee	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`	Nee	⛔⛔ 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`	Nee	Safe to display - never contains a credential.