Webhook
Webhook para escuta de requisições.
Last updated
Was this helpful?
Webhook para escuta de requisições.
Last updated
Was this helpful?
Um webhook para escuta de requisições é como uma caixa de correio inteligente que recebe notificações de outros sistemas. Ao invés de você ir buscar as informações, elas são entregues diretamente na sua "porta".
Exemplo:
Imagine que você tem um sistema de atendimento ao cliente. Você pode configurar um webhook para receber notificações de um sistema de pagamentos. Quando um pagamento for realizado, o sistema de pagamento envia uma notificação para o seu sistema de atendimento, permitindo que seus atendentes saibam, por exemplo, que o cliente realizou o pagamento.
Na parte superior direita da página existe um botão de alternância com as seguintes configurações: se azul, o modo de produção do webhook estará ativado; se cinza, o modo de teste do webhook estará ativado.
Em modo de teste, as requisições processadas e mapeadas não serão registradas no servidor. Esse modo serve justamente para testar as requisições e ajudar a configurar o webhook de escuta.
O link do webhook é como o endereço da sua casa. É para esse endereço que outros mensageiros (sistemas) irão enviar informações ou pacotes. Esse link é exclusivo e precisa ser compartilhado com os sistemas que vão enviar dados para você. Pense nele como a referência para o entregador saber onde deixar o pacote.
Para copiar o link do webhook e disponibilizá-lo para que seja usado na configuração do webhook de envio de requisição de outros sistemas, basta clicar no botão "Copiar".
Alternativamente, outra opção seria, na página inicial do gerenciamento, clicar no botão "Copiar link".
Esse campo é como uma caixa de entrada de pacotes em modo de teste. Imagine que você queira ver os pacotes que chegam antes de abri-los ou processá-los. Quando o sistema está em modo de teste, qualquer requisição enviada para o link do webhook será exibida aqui para visualização. Ele mostra exatamente o que está dentro do pacote (a estrutura dos dados) sem que o sistema processe a informação.
Cada requisição realizada pelo outro sistema ao webhook de escuta é listada na caixa de seleção de requisições de teste com uma numeração crescente a partir do número um, sendo o 1 a primeira requisição, o 2 a segunda, o 3 a terceira e assim sucessivamente:
Ao selecionar uma das requisições, será mostrada a requisição selecionada com suas chaves e valores:
Uma vez selecionada a requisição desejada, o mapeamento das requisições, que será os passos seguintes, irá apresentar as propriedades da requisição selecionada.
Este campo define o "tipo" de pacote que você aceita e processa, dependendo do que ele deve manipular.
Contato: Esse tipo de webhook é para pacotes que manipulam informações dos contatos, a saber: variáveis de campos customizáveis e de campos de sistema (nome, telefone, ...). Imagine que ele lida com dados de clientes ou leads, como quando você recebe o cadastro de um novo cliente.
Sistema: Este é como um pacote de ferramentas que vai manipular variáveis globais, como variáveis de banco de dados.
Há duas opções para serem selecionadas: Contato e Sistema.
Ao selecionar o tipo de webhook Contato, haverá a opção, em seguida, de Buscar ou Criar um Contato, além de realizar o mapeamento das propriedades. Em ambos os casos, as caixas de seleção de Campos apresentarão a listagem de Campos Customizáveis e de Campos de Sistema.
Ao selecionar o tipo de webhook Sistema, haverá a opção, em seguida, de realizar o mapeamento das propriedades. A caixa de seleção de Campos apresentará a listagem de variáveis do Banco de Dados.
Esse campo é como uma rotina de identificação ou busca no seu sistema. É como se você tivesse uma lista de contatos e, quando chega um novo pacote (requisição), o sistema verifica a lista para ver se aquele contato já está registrado ou precisa ser criado.
Como funciona: O sistema usa as informações da requisição (como nome, telefone etc.) para procurar o contato certo. Se ele encontrar uma correspondência, usará aquele contato.
Exemplo de uso: Se você está recebendo uma requisição que inclui o telefone de um cliente, o sistema pode buscar por esse telefone. Se o telefone não existe no sistema, ele cria um novo contato automaticamente.
Quando há mais de uma condição salva, a análise ocorre em ordem de importância, ou seja, na sequência em que as condições foram cadastradas. O processo segue a seguinte lógica:
A primeira condição é analisada:
Se nenhum contato for encontrado e o telefone estiver mapeado, um novo contato será criado. Caso contrário, um erro será retornado.
Se for encontrado um único contato, ele será selecionado.
Se forem encontrados vários contatos, a análise segue para a segunda condição.
A segunda condição é analisada:
Se nenhum contato for encontrado, ou se não houver uma segunda condição, será retornado erro.
Se for encontrado um único contato, ele será selecionado.
Se forem encontrados vários contatos, a análise segue para a terceira condição.
O processo continua seguindo essa lógica até que um único contato seja identificado ou um erro seja retornado por não ter sido possível individualizar o contato.
Exemplo: Se a primeira condição for o e-mail e forem encontrados cinco contatos, a segunda condição (por exemplo, telefone) será aplicada para filtrar entre esses cinco quais possuem o telefone informado. Esse processo continua até que reste apenas um contato ou até que um erro seja retornado.
Selecione um campo customizável ou de sistema que será buscado.
O sistema irá varrer esse campo nos contatos a fim de encontrar uma correspondência com a propriedade selecionada.
Esse campo controla o que o sistema faz se o contato já estiver registrado.
Se marcado "Pausar a automação", é como colocar uma "trava" no processamento da requisição. O sistema não fará o mapeamento das propriedades, nem executará o fluxo de automação. É útil, por exemplo, para casos em que você quer atualizar apenas se o contato for novo (não existente).
Esse campo define quais informações do pacote (requisição) correspondem a campos no seu sistema. Imagine que você tem pacotes com informações de clientes (como nome, telefone, e-mail). O mapeamento instrui o sistema a qual campo deve guardar cada uma dessas informações para que sejam corretamente registradas.
Para mapear uma propriedade, na caixa de seleção de campo, selecione o campo de sistema onde serão salvos os valores das propriedades.
Feito isso, selecione qual será a propriedade salva no campo selecionado.
O campo de sistema do lead será atualizado apenas se o campo não for telefone, OU se for telefone e estiver vazio, OU se o lead acabou de ser criado, OU se a conversa não é do canal WhatsApp. Isso para não atualizar o telefone em leads já existentes.
Por fim, clique em "Salvar propriedade".
O Fluxo de Automação é como uma sequência de ações que acontece automaticamente após o recebimento da requisição. É como se, após o pacote ser aberto e registrado, um sistema de notificação fosse acionado para realizar algumas tarefas.
Na caixa de seleção de fluxo, selecione um fluxo de automação.
Se um fluxo de automação não for selecionado, nada irá acontecer após o recebimento e processamento das requisições; se for selecionado, será executado o que foi configurado no fluxo.
Na caixa de seleção de Fluxo não aparecerão os fluxos da página Fluxos de Conversa, mas, sim, os fluxos de automação configurados na página Fluxos de automação.
Exemplo de uso: Imagine que você recebeu uma requisição de um pagamento realizado. O fluxo de automação pode ser configurado para enviar automaticamente uma mensagem ao cliente confirmando o pagamento.
O potencial de uso do fluxo de automação é infinito. Você pode, por exemplo, configurar automações para várias situações, como atualizações de dados, notificações de compra, envio de mensagens de boas-vindas, entre outros.
Depois, dentre as opções listadas decorrentes da , selecione a propriedade que possua o valor que deseja buscar dentro do campo selecionado.
