Una sección importante de la API de Zenvia Conversion fue construida con el propósito de notificar a otros sistemas cuando ocurren determinados eventos dentro de la plataforma.

La API se encarga de notificar a otros sistemas a través de un pedido (request) HTTP POST a una URL registrada, y envía en el contenido (body) del pedido/request la información relacionada al evento. Está técnica es conocida usualmente como: Webhook.

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

•  Cuando un prospect es creado en Zenvia Conversion (a partir de recibir y validar un lead).

•  Cuando un quote es actualizado y su estado es modificado.

•  Cuando una Interaction es resuelta por un asesor.

Registro y uso de las notificaciones      

Una vez obtenida la API Key para acceder a la API de Zenvia Conversion, podrás registrar una nueva subscripción (subscription) a determinados eventos (topics), y podrá especificar una URL donde quiere ser notificado (callbackURL). Todo esto, directamente desde la sección Notifications de la API.

A partir del momento que se registra la subscripción, cada vez que el evento (Topic) ocurra dentro de la Plataforma, Zenvia Conversion notificará a la URL de retorno registrada a través de una operación (request) HTTP POST.

Puedes consultar o eliminar las subscripciones disponibles en cualquier momento, directamente desde la API de Notifications.

Recuerda que para poder obtener acceso a la API, necesitas una API Key.