Criar um Webhook

Um webhook avisa um sistema de fora, na hora, quando algo acontece no CRM. Em vez de o outro sistema ficar perguntando se houve novidade, o CRM é quem manda …

T
Written By tecnologiaLast updated about 2 months ago

Criar um Webhook

O Que É e Quando Usar

Um webhook avisa um sistema de fora, na hora, quando algo acontece no CRM. Em vez de o outro sistema ficar perguntando se houve novidade, o CRM é quem manda o aviso para um endereço que você cadastra.

Use quando um negócio ganho precisa disparar a emissão de um pedido, quando um contato novo precisa entrar em outra ferramenta, ou quando o time quer um alerta automático a cada avanço de etapa.

A tela fica em Configurações, item Webhook, e se chama Webhooks de saída. Ela tem duas abas: Visão geral, com os webhooks globais e o panorama dos gatilhos, e Por etapa, para disparos amarrados a uma etapa específica de um funil.

Criar um Webhook Global

  1. Abra Configurações e vá em Webhook, na aba Visão geral.
  2. Comece um webhook novo. Abre o painel Novo webhook global.
  3. Preencha o Nome, com até 120 caracteres.
  4. Preencha a URL (HTTPS), o endereço que vai receber o aviso.
  5. Em Eventos, marque o que dispara o envio. As opções são Oportunidade

    criada, Oportunidade movida de etapa, Oportunidade ganha, Oportunidade perdida, Contato criado, Contato atualizado, Tarefa criada, Tarefa concluída e Mensagem de chat recebida.

  6. Deixe a chave Ativo ligada, se quiser que ele já comece a valer.
  7. Preencha o Segredo HMAC, se for usá-lo. É opcional, exige no mínimo 8

    caracteres e serve para o sistema de destino confirmar que a chamada veio mesmo do CRM.

  8. Clique em Criar webhook. A confirmação é Webhook global criado.

Quando o webhook já existe, o rótulo do botão passa a ser Salvar alterações e o campo do segredo aparece como Segredo HMAC (já configurado), com o campo em branco para manter o valor atual.

O segredo é uma credencial. Guarde-o no mesmo lugar em que a equipe guarda senhas de sistema e evite enviá-lo por mensagem, e-mail ou planilha.

Regras Que a URL Precisa Cumprir

O endereço é validado antes de salvar, e cada recusa tem um texto próprio:

  • URL é obrigatória, quando o campo está vazio;
  • URL inválida, quando o endereço não é reconhecido;
  • URL deve usar HTTPS, porque endereço sem criptografia não é aceito;
  • URL não pode conter credenciais (user:pass@), porque usuário e senha
    embutidos no endereço ficariam expostos.

Testar Antes de Confiar

O painel tem um botão Testar que dispara uma chamada de verdade para o endereço cadastrado. Ele só funciona depois de salvar: no webhook ainda não gravado, aparece "Salve o webhook antes de testar pela primeira vez".

O resultado volta em uma faixa colorida com Teste OK ou Teste falhou, o código devolvido pelo destino, o tempo que a chamada levou e um trecho da resposta. Verde significa que o outro lado recebeu; vermelho significa que ele recusou ou não respondeu, e aí o ajuste é do lado de quem recebe.

Acompanhar o Estado dos Webhooks

Na aba Visão geral, a tabela mostra Eventos, Status e Ações. O selo de status assume quatro valores:

  • Ativo: ligado e com a última entrega bem-sucedida;
  • Falha na entrega: a última tentativa não foi aceita pelo destino;
  • Inativo: cadastrado, porém com a chave Ativo desligada;
  • Não configurado: a etapa ou o ponto ainda não tem gatilho nenhum.

Quando um gatilho já disparou, a linha mostra o resultado e o momento da última entrega, como "Hoje às 14:22" ou "Ontem às 18:05". A aba Por etapa repete a mesma leitura para cada etapa de um funil escolhido no seletor, e uma etapa com vários gatilhos aparece em falha se qualquer um deles falhou.

Limitações e Permissões

O item Webhook só aparece em Configurações para administradores da conta. Estes webhooks são de saída: eles avisam sistemas externos sobre o que aconteceu no CRM, e não recebem dados de fora. Para o caminho de entrada, use a chave de API.

Artigos Relacionados

Was this helpful?

Your feedback shapes what we write next.