Como criar os fluxos para suas campanhas com Webhooks passo a passo
Neste artigo, explicaremos passo a passo como criar os fluxos para suas campanhas com Webhooks no Atom.
Criação de Fluxo com Webhooks
Primeiro, acessaremos nossa seção de Flowbuilder em Campanhas. Para isso, você irá ao menu lateral esquerdo > Campanhas > Fluxos > Criar Fluxo.
Em seguida, selecionaremos Criar Fluxo do Zero. Selecionamos o número do qual nossa campanha será enviada e ali entramos no Flowbuilder, onde começaremos a diagramar nossa campanha com Webhooks. Nosso gatilho neste caso será Webhook.
Para a configuração do Webhook, lembre-se de que você deverá ter o URL e os campos correspondentes à solicitação POST e, se forem necessários campos de informação adicionais, o campo exigido por padrão sempre será o campo “phone”.
Se você deseja adicionar campos adicionais de informação, pode fazê-lo clicando no ícone de “+” e ali pode adicioná-lo diretamente como mostrado a seguir, para depois adicioná-lo à solicitação do método POST que visualizamos acima. Tenha em mente que, se você não o criou previamente, deverá fazê-lo como se explica no seguinte artigo.
Suponhamos que, em seguida, realizaremos o envio de um template com informações específicas. Para poder enviar qualquer campanha, é necessário que você tenha previamente um template criado. Para isso, primeiro você deve conectar o componente template ao componente de Webhook, como mostramos a seguir:
Se você precisa criar um template, pode criá-lo em nossa seção de Configurações > Mensagens > Templates, ou também pode aproveitar a funcionalidade de Criar Templates dentro de Flowbuilder, como indicamos neste outro artigo.
Depois de escolher um template, você pode continuar adicionando os componentes que você considere para completar o fluxo. Para mais informações sobre os componentes de um fluxo, você pode ver este artigo.
Uma vez completado o fluxo de trabalho, copie os parâmetros de entrada do Webhook. Você pode fazê-lo de duas formas distintas:
Antes de publicar o fluxo de trabalho, faça duplo clique no componente Webhook e depois em “Mostrar solicitação POST” no painel direito. No detalhe da solicitação POST, você encontrará entre símbolos {} os parâmetros (tenha em mente que você deverá substituir os valores “Dados a enviar” pelo que corresponda).
Exemplo:
Outra opção que você tem para copiar os parâmetros de entrada uma vez que o fluxo tenha sido publicado e se encontre com estado ‘Ativo’, são os seguintes: Selecione o fluxo com webhook na tela de ‘Webhooks’ dentro do módulo de Campanhas e execute a ação ‘Ver fluxo’:
Selecione o fluxo com webhook na tela de ‘Webhooks’ dentro do módulo de Campanhas e execute a ação ‘Ver fluxo’:
No visualizador de fluxos de trabalho, clique no botão ‘Copiar campos de informação’ que se encontra dentro do componente webhook:
No visualizador de fluxos de trabalho, clique no botão ‘Copiar campos de informação’ que se encontra dentro do componente webhook:
Exemplo:
{
"phone": "",
"company_name": "",
"fecha_cita": "",
"monto": "",
"name": ""
}
Depois de finalizar a criação do fluxo de trabalho com webhook, salve-o e publique-o para que possa empregá-lo.
O componente webhook tem dois botões para agilizar sua posterior operação:
O botão 1 permite copiar a URL do webhook, enquanto que o botão 2 você pode empregá-lo para copiar os campos de informação em formato JSON.
Tenha em mente as seguintes informações a respeito dos parâmetros de um webhook ATOM.
Todo webhook ATOM tem, por padrão, como parâmetro de entrada obrigatório o número de telefone (phone) de destino das mensagens do fluxo.
O número de telefone (“phone“) deverá inseri-lo antepondo o sinal “+“ e o código de área do seu país, sem utilizar hífens ou espaços.
No entanto, se no fluxo são inseridos templates com seus próprios campos personalizados, todos eles passarão a ser parâmetros de entradas obrigatórios do webhook.
Por outro lado, Atom permite incluir outros parâmetros no webhook através dos campos personalizados, tal como se mostra a seguir:
Para visualizar os campos requeridos de um webhook:
Dirija-se ao editor de fluxos no módulo de Campanhas.
Clique no componente Webhook.
À direita da tela, será exibido um painel onde poderá visualizar os campos requeridos.
Realize testes do seu fluxo
Uma vez que você tenha um fluxo com webhook criado e publicado, você pode simular e avaliar sua execução. Para isso, será usado a ferramenta de testes de APIs denominada Postman.
A seguir, você verá o passo a passo para simular um fluxo com webhooks no Postman:
Vá ao módulo de Campanhas.
Clique no submódulo de webhooks.
3. Dirija-se ao fluxo com webhook que deseja testar e clique no ícone URL para copiar o mesmo e usá-lo no Postman.
4. A seguir, complete os seguintes parâmetros no Postman:
Headers
Content-Type: application/json
Authorization: Bearer xxxxx, sendo xxxxx o token API que deve obtê-lo no submódulo Minha Empresa → Configuração de segurança
💡Importante: ao empregar um webhook é obrigatória a autenticação através do token API. Por outro lado, tenha em mente que se você já possui um gerado e decide gerar um novo, você tem que substituir o novo em todos aqueles webhooks e APIs de Atom que você tenha em uso.
Body
Formato: raw
Escrever os parâmetros em formato JSON, ex:
{
"phone": "5795755112756",
"client_name": "Martin Lopez"
}
Todos os parâmetros devem inserir-se em formato string, ou seja, entre aspas duplas ( “”).
No momento de utilizar os webhooks ATOM você pode encontrar os seguintes códigos
| Cenário |
Cenário
| Código de Resposta |
Código de Resposta
| Corpo da Resposta |
Corpo da Resposta
| Envio satisfatório |
Envio satisfatório
| 200 - Ok |
200 - Ok
| {"message":"Webhook executado satisfatoriamente"} |
{"message":"Webhook executado satisfatoriamente"}
| Token inexistente |
Token inexistente
| 401 - Unauthorized |
401 - Unauthorized
| No authorization token found. |
No authorization token found.
| Token incorreto |
Token incorreto
| 404 - Not Found |
404 - Not Found
| Cannot find a company with uuidToken = xxxxxxx |
Cannot find a company with uuidToken = xxxxxxx
| Parâmetro requerido |
Parâmetro requerido
| 500 - Internal Server Error |
500 - Internal Server Error
| {"message": "El parametro xxxx es requerido","hasErrors": true} |
{
"message": "El parametro xxxx es requerido",
"hasErrors": true
}
| Tentar simular um fluxo ativo |
Tentar simular um fluxo ativo
| 500 - Internal Server Error |
500 - Internal Server Error
| {"message":"El contacto se encuentra simulando un flujo.","hasErrors":true} |
{
"message":"El contacto se encuentra simulando un flujo.",
"hasErrors":true
}
Defina os gatilhos do seu CRM ou ERP que executarão o fluxo com webhook criado. É importante que você configure neles tanto o URL como os parâmetros do webhook de ATOM.
Uma vez que você tenha avaliado e aprovado a interação entre seu CRM ou ERP e o webhook ATOM, ponha produtivo seu fluxo.
Emprego do componente http para devolver os dados de um fluxo
Alternativamente, você tem a possibilidade de devolver os dados empregados em um fluxo através do método POST de solicitação HTTP.
Para isso, será usado o componente “Solicitação HTTP” no desenho do fluxo de trabalho. A seguir, veremos sua configuração:
No editor de fluxos de trabalho de ATOM, insira o componente “Solicitação HTTP”.
Como método, deve escolher: “POST”.
Insira a URL à qual serão enviados os dados dos campos personalizados empregados no fluxo.
Ative o campo para inserir os campos no Corpo da solicitação, deslizando o botão Corpo.
5. Os campos de informação devem inserir-se em formato JSON. Tenha em mente que tanto o identificador do campo como seu valor (o campo de informação) devem ir entre aspas duplas (“).
Para escolher o campo de informação que captura o dado, pressione a tecla / (barra) a qual exibirá uma listagem com todos os campos de informação disponíveis para inserir.
6. Proceda a simular a execução do fluxo para avaliar o envio dos dados.
A seguir, apresentamos um exemplo de uma simulação de um fluxo que contém um componente “Solicitação HTTP”:
Geramos um fluxo com uma solicitação HTTP com os seguintes parâmetros:
O campo “name” é um parâmetro de entrada do fluxo enquanto que o campo “identificacion” captura a resposta do cliente no whatsapp
Iniciamos a simulação do fluxo através da ferramenta POSTMAN:
O cliente recebe e contesta o seguinte no WhatsApp:
Podemos observar como a última resposta do cliente se armazena no campo “Identificacion”:
Posteriormente, podemos escolher optar por diferentes lógicas, análise de intenções com inteligência artificial para depois definir o que você quer que o bot execute.
Por exemplo, podemos enviar uma mensagem onde, por exemplo, se o cliente responde que deseja, neste caso, agendar uma consulta, derivá-lo no atendimento a um grupo de assessores, ou, caso contrário, etiquetaremos para saber que não está interessado no momento nesta campanha.
IMPORTANTE:
Se você utiliza Webhooks para o envio de notificações por meio de fluxos, tenha em mente que, se há uma conversa ativa sendo atendida por um assessor, o componente previamente verificará esta condição e suspenderá sua execução para não interferir no atendimento personalizado que está sendo dado.
ARTIGOS RELACIONADOS:
Como criar uma campanha