🔗Webhooks

Suri ativamente conecta-se a serviço externo informando eventos importantes

Precisa ser informado de quando um evento importante acontecer na Suri? Webhook pode ser sua solução. Com eles, seu serviço externo (API, CRM, etc.) ficam informados sempre que determinada ação acontecer.

Habilitando

Em seu Portal com acesso de administrador, acesse a página de Configurações, na aba Geral e procure por "Webhook". Preencha o campo com a URL do serviço no qual você deseja receber eventos e em seguida clique em Salvar.

Ao clicar no botão de Salvar desta tela, faremos uma chamada do tipo GET para a URL informada no campo. Esperamos receber uma resposta de status 200 e um corpo contendo unicamente o Identificador do chatbot em questão (o mesmo que aparece no primeiro campo da tela). Fazemos isso por uma questão de segurança, um handshake com seu serviço.

Ao salvar o endpoint, todos os eventos serão enviados para mesma URL na forma de requisição POST, cujo corpo da requisição é o dado referente ao tipo do evento. Confira os modelos de cada evento em nossa documentação do Postman.

Tipos de Webhook

Enviamos os seguintes eventos:

• Novo contato: quando uma pessoa fala pela primeira vez com seu chatbot através de algum dos canais conectados (WhatsApp, Instagram, etc.). Bem útil para quantificar novos leads, por exemplo;

• Troca de fila: quando um contato passa de uma fila do chatbot para outra. Por exemplo, quando sai do "Automático" para "Esperando atendimento" ao solicitar atendimento humano;

• Finalização de atendimento: quando um agente humano encerra atendimento com um contato;

• Mensagem recebida: quando um contato envia uma mensagem para o chatbot. Esse webhook é interessante quando você precisa espelhar as mensagens para um serviço externo ou para mapear mensagens de contatos que estão em um fluxo específico (por exemplo, quando a Suri solicita CPF do contato e ele responde).

Note: como todos os webhooks são enviados para o mesmo endpoint, é necessário realizar um tratamento no serviço de destino, para que ele consiga identificar os eventos desejados. Para isso consulte a documentação e fique atento no atributo type, que identifica corretamente o tipo de evento que seu serviço está recebendo.