Notificações & WebHooks

Uma seção importante da API de Sirena foi construída com o propósito de notificar a outros sistemas quando ocorrerem determinados eventos dentro da plataforma.

A API se encarrega de notificar a outros sistemas através de um pedido (request) HTTP POST a uma URL registrada, e envia o conteúdo (body) do pedido/request a informação relacionada ao evento. Esta técnica é conhecida usualmente como WebHook.

Atualmente, os eventos (conhecidos como tópicos) que podem ser reportados a uma URL registrada são: 

  • Quando um Prospect é criado em Sirena (a partir de receber e validar um Lead)

  • Quando um Prospect é atualizado e seu estado é modificado

  • Quando uma interação é resolvido por um consultor.

Inscrição e Uso das Notificações

Uma vez obtida a API Key para acessar a API de Sirena, você poderá registrar uma nova inscrição (subscription) a determinados eventos (topics), e poderá especificar uma URL onde quiser ser notificado (callbackURL). Tudo isso diretamente da seção Notificações da API.

A partir do momento que se registra uma inscrição, cada vez que um evento ocorrer dentro da plataforma, Sirena notificará a URL de retorno registrada através de um pedido/request HTTP POST.

Pode consultar ou eliminar as inscrições disponívels a qualquer momento diretamente da Notificações de API.



Lembre-se que, para poder ter acesso a API, é necessário uma API Key. Se esse é o seu caso, recomendamos seguir em: Autentificação & API Keys