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

A API é responsável por notificar outros sistemas por meio de uma solicitação (request) HTTP POST a um URL registrado, e envia o conteúdo (body) do pedido / request a informação relacionada ao evento. Essa técnica é geralmente conhecida como: Webhook.

Atualmente, os eventos (conhecidos como Topics) que podem ser relatados em um URL registrado são:

  • Quando um prospect é criado em Sirena (depois de receber e validar um lead).
  • Quando um quote é atualizado e seu status é modificado.
  • Quando uma interação é resolvida por um assessor.

Registro e uso das notificações

Depois de obter a API Key para acessar a API de Sirena, você pode registrar uma nova assinatura (subscription) a determinados eventos (topics) e especificar um URL onde deseja ser notificado (callbackURL). Tudo isso diretamente da seção Notifications da API.

A partir do momento em que a assinatura é registrada, cada vez que o evento (Topic) ocorrer dentro da Plataforma,Sirena notificará o URL de retorno registrado através de uma operação (request).HTTP POST 

Você pode verificar ou remover as assinaturas disponíveis a qualquer momento, diretamente na API de notifications

Lembre-se de que, para obter acesso à API, você precisa de uma API Key. Você pode ver como acessá-la entrando em Autenticação & API Keys .

Encontrou a sua resposta?