notifications

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

Send a real test message to a destination.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Donde va el ID de tu organización

Este endpoint acepta org_id como parámetro de consulta. Omítelo y la llamada abarcará todo tu subárbol de inquilinos; envíalo para acotar la llamada a una sola organización.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`connection_id (path)`	`string`	Sí	—
`org_id (query)`	`string`	No	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…

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`verified`	`boolean`	No	—
`awaiting_confirmation`	`boolean`	No	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`	No	⛔⛔ 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`	No	Safe to display - never contains a credential.