Webhook de saída
Avise outro sistema quando algo acontece no Leadz, usando os blocos Webhook e HTTP Request do funil.
Nesta página
O webhook de saída é o caminho inverso do webhook de entrada: é o Leadz que chama um endereço de outro sistema e entrega os dados do contato. Ele não fica em uma tela própria. Você o monta dentro de um funil, com o bloco Webhook ou o bloco HTTP Request, no ponto exato em que o aviso deve sair.
#Antes de começar
- O endereço de destino precisa usar
https://e estar na internet. Endereços de rede local ou privada são recusados. - Os blocos Webhook e HTTP Request ficam no grupo Avançado da paleta do editor. Se o seu plano não inclui esse grupo, eles aparecem com cadeado. Veja sparkleleadz.com/planos.
#Qual bloco usar
| Webhook | HTTP Request | |
|---|---|---|
| Para que serve | Enviar os dados do contato a um endereço | Chamar um site ou uma API e usar a resposta no funil |
| Usa a resposta | Não | Sim |
| Saídas no funil | Uma só. O funil segue, com sucesso ou falha | Sucesso e Erro |
| Nova tentativa em caso de falha | Não tem | Até 3 vezes, se você ligar |
| Botão de teste | Não tem | Testar |
Para só avisar outro sistema, use o Webhook. Para tratar a falha, repetir o envio ou ler o que o sistema devolveu, use o HTTP Request.
#Enviar um aviso com o bloco Webhook
- Abra Automação › Funil e edite o funil.
- Na paleta, abra o grupo Avançado e arraste o bloco Webhook para o ponto do funil em que o aviso deve sair.
- Em Método, deixe
POST. Em URL de destino, cole o endereço do outro sistema. - Em Autenticação, escolha como o token vai: Bearer (Authorization), Header próprio, Na URL (query), No corpo ou Usuário e senha (Basic). Para um endereço que não pede token, deixe Sem token.
- Em Como montar o payload, deixe Parâmetros do Leadz.
- Clique em + Adicionar parâmetro…, escolha o dado do Leadz e escreva ao lado o nome com que ele deve chegar no destino.
- Salve e ative o funil.
#O que pode ser enviado
Cada parâmetro tem dois lados: à esquerda, o dado no Leadz; à direita, o nome que o sistema de destino espera.
| Grupo | Dados |
|---|---|
| Contato | ID do contato (interno), Código do contato (#), Nome completo, Primeiro nome, Sobrenome, E-mail, Telefone, WhatsApp, Instagram, Status do lead, Origem, Tags, Segmento |
| Negociação | Valor, Moeda, Nome, ID, Produto, Oferta, Tipo da venda, Plano e Total ganho do contato (LTV) |
| Fluxo | ID do fluxo, Nome do fluxo, ID da execução, ID do bloco |
| Contexto | Última mensagem do lead, Data/hora do envio (ISO) |
Além desses, você pode enviar qualquer campo personalizado do contato, uma Variável do fluxo… ou um Texto fixo…. O bloco aceita até 50 parâmetros.
#Formato do envio
Com Enviar os parâmetros como em Automático, um POST leva um JSON simples, com os nomes que você escolheu:
{
"ID_USER": "identificador-do-contato",
"EMAIL": "ana@exemplo.com",
"TELEFONE": "5511999990000",
"ORIGEM": "Landing Page"
}
Com o token em Bearer (Authorization), a chamada sai com este cabeçalho:
Authorization: Bearer TOKEN-DO-DESTINO
Content-Type: application/json
Outras opções de Enviar os parâmetros como:
- JSON no corpo: sempre JSON.
- Formulário:
application/x-www-form-urlencoded. - Query string: os parâmetros vão no próprio endereço.
Em Automático, um GET leva os parâmetros no endereço.
Campo sem valor fica fora do envio. Para mandar o campo mesmo vazio, marque Enviar também os campos vazios.
Se o destino exige um formato diferente, troque Como montar o payload para JSON manual e escreva o corpo, usando o botão Variáveis para inserir os dados do contato. Cabeçalhos adicionais vão em Headers extra (JSON).
#Chamar uma API e tratar a resposta com o HTTP Request
Use o HTTP Request quando o aviso não pode se perder ou quando o funil depende do que o outro sistema responde.
- Arraste o bloco HTTP Request, do grupo Avançado, para o funil.
- Escolha o método e cole o endereço.
- Preencha as abas Parâmetros, Cabeçalhos, Corpo e Autenticação conforme o sistema de destino pede.
- Em Mais opções, ajuste Tempo limite (de 5 a 30 segundos) e Se falhar, tentar de novo (de Não a 3 vezes).
- Clique em Testar para fazer a chamada de verdade e ver a resposta. O teste não grava nada no contato.
- Ligue a saída Sucesso ao caminho normal e a saída Erro ao que deve acontecer se a chamada falhar, como criar uma tarefa para o time.
Na aba Resposta, você escolhe o que fazer com o que voltou: guardar em uma variável do funil, em um campo do contato, em um campo personalizado ou em uma tag.
Depois da chamada, o funil tem estas variáveis à disposição:
| Variável | Conteúdo |
|---|---|
http_status |
O código da resposta, como 200 ou 404 |
http_ok |
Verdadeiro quando a chamada deu certo |
http_response |
O que o sistema devolveu |
http_error |
A mensagem de erro, quando a chamada não chegou ao destino |
#Repetição em caso de falha
- Bloco Webhook. Faz uma tentativa só, com espera de até 10 segundos. Se falhar, o funil segue em frente e o erro fica registrado na execução do funil.
- Bloco HTTP Request. Sem configurar, também faz uma tentativa só. Com Se falhar, tentar de novo ligado, repete até 3 vezes. A nova tentativa só acontece em erro do servidor de destino (5xx), excesso de pedidos (429) ou falha de rede. Uma resposta como 400 ou 404 não é repetida.
O Leadz não guarda uma fila de reenvio. Passadas as tentativas, o aviso não é enviado de novo sozinho.
#Avisar quando algo muda no CRM
Não existe uma tela de «avisos automáticos» fora do funil. Para avisar outro sistema de uma mudança, crie um funil com o gatilho da mudança e coloque o bloco Webhook logo depois. Gatilhos que servem para isso:
- Tag adicionada ao lead
- Lead entrou em coluna do Kanban
- Card criado no Kanban
- Campo personalizado alterado
- Status de atendimento mudou
#Enviar eventos ao Sparkle Tracker
Para avisar o Sparkle Tracker, não use o bloco Webhook. Com o Tracker conectado, o editor tem o bloco Enviar evento ao Sparkle Tracker, que não pede endereço nem token. Veja Sparkle Tracker.
#Segurança
- O token do bloco fica guardado no servidor. Em mensagens de erro e no registro da execução, ele aparece mascarado.
- Prefira Bearer (Authorization) ou Header próprio. A opção Na URL (query) deixa o token gravado nos registros do sistema de destino.
- Um endereço digitado com
http://é trocado porhttps://na hora do envio.
#Problemas comuns
O bloco mostra «URL não configurada»
O campo URL de destino está vazio. Abra o bloco e cole o endereço.
A execução registra «URL externa aponta para rede local» ou «rede privada ou reservada»
O endereço de destino é de dentro de uma rede interna. O Leadz só chama endereços públicos na internet.
O destino recebe os campos com os nomes errados
O nome que chega é o que está à direita de cada parâmetro. Abra o bloco e ajuste. Espaços e pontos no nome viram _.
Um campo não chega no destino
O contato está sem aquele dado, e campo vazio fica fora do envio. Marque Enviar também os campos vazios se o destino precisa receber o campo mesmo assim.
O destino responde com erro e o funil continuou
O bloco Webhook não desvia o funil em caso de erro. Troque pelo HTTP Request e use a saída Erro.
Dois parâmetros têm o mesmo nome
O editor avisa em vermelho. Só o primeiro é enviado. Dê nomes diferentes.
#Veja também
Que bom! Obrigado pelo retorno.
Poxa. Tente a solução de problemas ou fale com o suporte.
Mais em Integrações
Ver os 8 artigos