Webhooks
A tela Webhooks serve para cadastrar o endereço pelo qual o sistema da empresa avisa o painel, dar regras para cada aviso e cadastrar os endereços do sistema da empresa que recebem os avisos do painel.
Endereço no painel: /app/automacoes/webhooks
Como chegar: Pelo menu Automações › Webhooks. O endereço antigo de Integrações traz para cá; cada aba tem endereço próprio, então dá para mandar o link de uma aba específica.
Cabeçalho e abas
O título, o botão de criar e as duas abas.
Botões e ações
- Novo webhook
- Abre o assistente de criação, já na direção da aba aberta. Só aparece para quem pode criar.
- Entrada
- Aba dos avisos que o sistema da empresa manda para o painel. O número ao lado é a quantidade de eventos.
- Saída
- Aba dos endereços que recebem os avisos do painel. O número ao lado é a quantidade de webhooks.
- Um quadro lembra que a Entrada estava na Base avançada e a Saída em Integrações.
- As abas se movem com as setas do teclado.
- Quando a conta não tem a Entrada, só a aba Saída aparece.
Aba Entrada: endereço e segredo
O endereço assinado que o sistema da empresa chama para avisar o painel.
Botões e ações
- Copiar o endereço
- Copia o endereço para cadastrar no sistema da empresa.
- Mostrar
- Revela o segredo da assinatura para copiar (fica registrado).
- Ocultar
- Volta a mascarar o segredo.
- Copiar o segredo
- Copia o segredo revelado.
- TrocarDono
- Pergunta Trocar o segredo?: o novo vale já e o atual continua valendo por 24 horas.
- Trocar agora
- Confirma a troca e mostra o segredo novo.
- Invalidar o antigo agoraDono
- Com o segredo anterior ainda valendo, pergunta e corta na hora (use se ele vazou).
- Invalidar agora
- Confirma: avisos assinados com o segredo antigo passam a ser recusados.
- Mais ações do endereço
- Abre o menu do endereço.
- Arquivar endereço
- Quando já há entregas no histórico: o endereço vai para o arquivo.
- Excluir endereço
- Quando nunca chegou um aviso: apaga de vez.
- Criar endereço novoDono
- Com o endereço arquivado, gera outro endereço e outro segredo. Os eventos nomeados e as regras (desligadas) continuam.
- Situação: Recebendo, Último há tanto tempo, Sem avisos ainda ou Arquivado.
- Um aviso por lead a cada 7 dias, no máximo.
- Dica com os cabeçalhos da assinatura de cada aviso.
Aba Entrada: eventos, entregas e regras
O que o sistema já mandou, cada evento com nome em português, e a regra de cada um.
Campos e filtros
- Chave do eventoobrigatório
- O que vai no campo evento do corpo (letras, números, ponto, traço ou sublinhado).
- Nome em portuguêsobrigatório
- Como o evento aparece na tela.
- Etiqueta do CRM
- Os leads com esta etiqueta na Base de Contatos recebem o aviso.
- Modelo aprovado da Meta
- Fora das 24 horas, o modelo usado; sem modelo, o aviso não é enviado fora da janela.
- No máximo 1 aviso por lead a cada
- 7, 14 ou 30 dias.
- Corpo de exemplo
- O JSON do aviso simulado, preenchido com o último aviso recebido.
Botões e ações
- Regra
- Abre uma regra nova (precisa de pelo menos um evento).
- Evento
- Abre Cadastrar um evento, para registrar a chave antes de o sistema mandar.
- nomear
- No evento sem nome ainda, abre Nomear o evento.
- Editar
- Abre a regra para edição.
- Excluir regraDono
- Pergunta Excluir esta regra?; os avisos já enviados ficam registrados.
- Regra ativa
- Interruptor que liga ou desliga a regra; a regra nasce desligada.
- Enviar evento de teste
- Simula o aviso com um corpo de exemplo e mostra a assinatura, quantos leads receberiam e o fato proposto. Nada é enviado.
- Cada evento mostra quantos chegaram no mês; clicar nele mostra a regra à direita.
- Últimas entregas: cada chamada ao endereço como aceita, recusada ou repetida, com a hora e, quando algum lead não recebeu, o motivo.
- A regra tem Quando, Para os leads de uma etiqueta e os passos de Faça: propor fato para aprovar, mandar mensagem ao lead, tirar da lista e marcar campo do lead.
- Dentro das 24 horas, a IA escreve com a persona da conta; fora, usa o modelo aprovado.
Aba Saída: cartão do webhook
Um cartão por endereço do sistema da empresa. Só o dono vê a aba.
Botões e ações
- Ativo
- Interruptor que pausa ou ativa o webhook. Pausado, nada é enviado, e os eventos desse período não ficam na fila.
- Reativar
- No aviso de pausa automática, volta a enviar os próximos avisos.
- Ver as falhas
- No aviso de pausa automática, abre a gaveta de entregas já em Falharam.
- Entregas
- Abre a gaveta com as entregas deste webhook.
- Testar
- Abre o diálogo Enviar evento de teste.
- Editar webhook ‹endereço›
- Abre o formulário de edição.
- Excluir webhook ‹endereço›
- Abre a confirmação de exclusão.
- Selo Ativo, Pausado ou Pausado automaticamente, e Com dados pessoais ou Sem dados pessoais.
- Os eventos que o endereço recebe e a saúde dos últimos 7 dias, com a porcentagem entregue, as falhas e o último envio.
- O cartão Para quem vai programar o recebimento traz os cabeçalhos da assinatura e como o sistema deve responder, com o botão Documentação dos webhooks.
- Cada aviso sai assinado; a documentação continua em Integrações › Documentação.
Assistente Novo webhook
Passo 1 de 2: escolher a direção e preencher. Depois, a tela Webhook criado.
Campos e filtros
- Nomeobrigatório
- Na Entrada: um nome que diga de onde vem o aviso, como Pedido pago. A chave do evento sai do nome.
- Endereço do seu sistemaobrigatório
- Na Saída: o endereço completo que comece com https:// e receberá os avisos.
- Eventosobrigatório
- Na Saída: escolha pelo menos um evento do catálogo.
Botões e ações
- Entrada: o seu sistema avisa
- Direção em que o sistema da empresa avisa o painel. Fica desabilitada sem acesso à Entrada.
- Saída: a plataforma avisa
- Direção em que o painel avisa o sistema da empresa. Só o dono.
- Criar webhook
- Cria o webhook e mostra a tela Webhook criado.
- Cancelar
- Fecha sem criar.
- Copiar o endereço
- Em Webhook criado (Entrada), copia o endereço para o sistema da empresa.
- Copiar o segredo
- Em Webhook criado (Saída), copia o segredo da assinatura, mostrado uma vez só.
- Pronto
- Fecha a tela Webhook criado.
- Na Entrada, depois de criar, você escreve a regra: que mensagem a IA manda e para quem. O estado é Escutando e vira ativo quando chegar o primeiro aviso.
- Na Saída, o segredo aparece uma vez só; dá para gerar outro a qualquer hora.
Estados da tela
- Carregando
- Blocos em esqueleto enquanto a Saída e a Entrada carregam.
- Sem nada ainda
- Nenhum webhook de entrada (com Criar webhook de entrada) e Nenhum webhook de saída (com Criar webhook de saída).
- Se der erro
- Não foi possível abrir os webhooks, dizendo que nada mudou, com o botão de tentar de novo.
- Entrada sem o módulo da Base avançada
- Os webhooks de entrada são da Base avançada, com o botão Conhecer a Base avançada.
- Administrador na Saída
- O aviso de que a aba fica com o dono da conta.
- Atendente ou gestor sem acesso à Entrada
- Os webhooks de entrada ficam com a gestão da conta; peça a uma dessas pessoas para abrir a aba.
- Endereço de entrada arquivado
- O sistema não consegue mais avisar; as regras ficam desligadas até criar um endereço novo.
- Domínio do painel ainda não configurado
- O endereço de entrada só aparece depois que o domínio estiver pronto.