Hola, Humans. ¿En qué podemos ayudarte?

Notificaciones & WebHooks
2 min
Creado por KM en 23/02/2023 11:33
Actualizado por Karine Moreira en 05/07/2024 11:25

La API de Zenvia Conversion tiene una sección importante para notificar a otros sistemas cuando ciertos eventos ocurren dentro de la plataforma.

La API notifica a otros sistemas a través de una solicitud HTTP POST a una URL registrada, enviando en el cuerpo de la solicitud la información relacionada con el evento. Esta técnica es conocida como Webhook.

Actualmente, los eventos (conocidos como Topics) que pueden ser reportados a una URL registrada son:

  • Creación de un prospecto en Zenvia Conversion (después de recibir y validar un lead)

  • Actualización de un quote con cambio de estado

  • Resolución de una interacción por un consultor

Registro y Uso de las Notificaciones

Para registrar notificaciones, siga estos pasos:

  1. Obtener la API Key para acceder a la API de Zenvia Conversion.

  2. Registrar una nueva suscripción para eventos específicos (topics) y especificar una URL para notificaciones (callbackURL), todo directamente en la sección Notifications de la API.

  3. Una vez que la suscripción esté registrada, cada vez que ocurra el evento en la plataforma, Zenvia Conversion notificará a la URL registrada a través de una solicitud HTTP POST.

Puede verificar o eliminar suscripciones disponibles en cualquier momento directamente en la API de notifications.

Requisitos

Recuerde que necesita una API Key para acceder a la API.