notifications
POST /v1/notification-connections/{connection_id}/verify
Send a real test message to a destination.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/notification-connections/{connection_id}/verify \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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ètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
connection_id (path) | string | Oui | — |
org_id (query) | string | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
verified | boolean | Non | — |
awaiting_confirmation | boolean | Non | 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 | Non | ⛔⛔ 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 | Non | Safe to display - never contains a credential. |