Como testar um webhook?

Se você estiver tendo problemas para receber o seu webhook, ou deseja conhecer exatamente os dados que estão sendo enviados antes de fazer uma integração, pode facilmente testar o envio.

Para testar seu webhook, siga os passos abaixo ou assista o tutorial em vídeo:

Preparando uma URL de teste

Acesse o site https://webhook.site, uma ferramenta gratuita para testes de webhooks;
Ao acessar, será gerado automaticamente um link único para que você possa utilizar como teste;
Copie esse endereço e não feche a janela;

Incluindo a URL de teste no formulário

Acesse a aba de "Opções" do seu formulário no Respondi;
Desça com o mouse até a parte de "Integrações" e clique em "Configurar integrações";
Habilite o campo de "Webhooks" e insira o link copiado na etapa anterior e clique em "Salvar";
Acesse o link do seu formulário e faça um preenchimento completo das respostas;

Preencha todos os campos e envie os dados. Você deve acessar o link público do formulário, o modo "visualização" não dispara webhooks.

Conferindo os dados enviados pelo webhook

Após realizar o preenchimento do formulário, volte na aba aberta do site https://webhook.site, aguarde alguns segundos, e você verá uma nova entrada no lado esquerdo;

Ao clicar nessa entrada, você terá acesso a todos os dados que foram enviados pelo webhook.
Suas respostas aparecem em dois lugares:
- "answers", em um formato mais simples de "Pergunta" -> "Resposta"
- e "raw_answers", onde aparece mais detalhes do campo preenchido, mas é um pouco mais complexo de configurar.
- Note que se você estiver coletando UTMs, elas estarão em "respondent.respondent_utms"

Esses são exatamente os dados que são enviados para qualquer link de webhook. Se tudo estiver como esperado, você pode voltar as configurações do seu formulário e alterar a URL em webhooks para o link oficial da integração que você está tentado realizar.

Não esqueça de publicar as novas alterações 😉

Pontos importantes:

Tanto preenchimentos completos quanto incompletos ativam um webhook. Porém, as respostas incompletas só ativam a integração após 1h;
Você precisa preencher todos os campos que deseja integrar no seu envio de testes. Somente campos preenchidos são enviados ao webhook;
Normalmente um webhook é disparada alguns segundos após o preenchimento, porém, em alguns raros casos pode levar até 15 minutos;
Lembre-se que o "modo de visualização" (aquele com a barrinha amarela no topo) não dispara webhooks. Você deve fazer um envio real para testar;
Se os dados estão corretos, mas mesmo assim a sua integração não funciona como deveria, você pode entrar em contato com o suporte do produto ao qual está tentando integrar e compartilhar esse conteúdo com eles. Irá ajudar a descobrir o problema;

Estrutura base

No tutorial acima é demonstrado como testar um webhook real do seu formulário, com os seus campos. Se você deseja somente ter uma ideia genérica sobre como nosso JSON é estruturado, pode consultar o payload de exemplo.