2.8. Integração Webhook
Antes do passo a passo para criação de Webhooks, saiba seu significado:
Os Webhooks são as respostas ou retornos de chamada HTTP estabelecidos em cada conta. Essas ocorrências são acionadas quando uma ação (temos como exemplo a criação de mensagens) acontece. Você pode gerar mais de um Webhook para uma conta. Ok?
Então, agora que você já sabe o que são os Webhooks, vamos para a criação:
Clique em ‘Configurações’ (conforme demarcamos na imagem com o número 01) e depois em ‘Integrações’ (conforme demarcamos na imagem com o número 02). Veja abaixo:
Você irá para a página abaixo. Clique em ‘Configurar’ para Webhooks.
Agora clique no botão verde ‘Adicionar novo Webhooks’, conforme tela abaixo:
Será exibido um painel central (conforme imagem abaixo).
Insira a URL para qual a requisição POST deve ser encaminhada.
Depois, selecione os eventos (ou ocorrências) que deseja se inscrever. A opção permite que você ouça apenas os eventos relevantes na Evolvy.
Por fim, clique no botão azul “Criar webhook”.
A Evolvy enviará uma solicitação POST com a seguinte carga útil aos URLs configurados para várias atualizações acontecendo em sua conta.
Um exemplo de carga útil do Webhook:
Ocorrências (eventos) de Webhook com suporte na Evolvy:
A Evolvy publica várias ocorrências nos terminais configurados de Webhook. Se você deseja configurar um Webhook, aprenda aqui com a gente!
Cada ocorrência tem sua estrutura de carga útil com base no tipo de modelo em que está atuando. Veja a ocorrência a seguir, que descreve os principais objetos que usamos na Evolvy e seus atributos.
Objetos
Uma ocorrência (evento) pode conter qualquer um dos objetos a seguir como uma carga útil.
Os diferentes tipos de objetos suportados na Evolvy são os seguintes:
Conta
A seguinte carga será retornada para uma conta.
Caixa de entrada
A seguinte carga será retornada para uma caixa de entrada.
Contato
A seguinte carga útil será retornada para um contato.
Do utilizador
A seguinte carga será retornada para um agente/administrador.
Conversação
A seguinte carga será retornada para uma conversa.
Mensagem
Um exemplo de carga útil do Webhook:
Ocorrências de Webhook
A Evolvy suporta as seguintes ocorrências (eventos) de Webhook abaixo. Você pode assiná-las enquanto configura um Webhook no painel ou usando a API.
conversa_criada
Essa ocorrência será acionada quando uma nova conversa for criada na conta. A carga útil para a ocorrência é a seguinte:
conversa_atualizada
Essa ocorrência será acionada quando houver alteração em algum dos atributos da conversa.
conversa_status_alterado
Essa ocorrência será acionada quando o status da conversa for modificado.
Observação: se você estiver usando APIs de bot de agente, ao invés de Webhooks, esse evento ainda não será compatível.
mensagem_criada
Essa ocorrência será acionada quando uma mensagem for criada em uma conversa. A carga útil para a ocorrência é a seguinte:
mensagem_atualizada
Essa ocorrência será acionada quando uma mensagem for atualizada em uma conversa. A carga útil para a ocorrência é a seguinte:
webwidget_triggered
Essa ocorrência será acionada quando o usuário final abrir o widget de Chat ao Vivo.
