Envie dados para os seus sistemas com webhooks

Um webhook envia dados para um URL à sua escolha no momento em que algo acontece, por exemplo quando alguém se regista ou ganha um prémio. O seu programador configura o sistema que os recebe. Os webhooks fazem parte do plano Basic e superiores.

Adicionar um webhook

Pode adicionar webhooks a uma campanha, no editor em Ligar > Webhooks, ou a toda a conta em Definições > Webhooks.

1. Clique em Adicionar webhook.
2. Introduza o URL do payload. Tem de usar HTTPS.
3. Escolha o Tipo de conteúdo: application/json ou application/x-www-form-urlencoded.
4. Escolha o Método: POST ou GET. Use POST, a menos que o seu sistema precise de GET, que envia os dados no URL.
5. Introduza um Secret para assinar os pedidos (recomendado).
6. Escolha os eventos em Que eventos devem acionar o webhook?:
   • "Quando é criado um novo lead" (ao nível da conta)
   • "Sempre que um lead participa numa campanha"
   • "Quando um lead ganha um prémio"
7. Confirme que Ativo está ligado e guarde.

No editor de campanhas também pode escolher Basic Auth em Autenticação e usar Payload personalizado para decidir os nomes dos campos.

O que é enviado

O corpo tem um event e um objeto data com a campanha (id e nome), os campos do lead, o canal, os consentimentos com texto, hora e endereço IP, as respostas ao quiz e, para os vencedores, o prémio com o respetivo código. Os valores vazios são omitidos.

Verificar a assinatura

Se definir um secret, cada pedido tem um cabeçalho X-Hub-Signature: sha1= seguido de um HMAC-SHA1 dos dados codificados em JSON, usando o seu secret como chave. Calcule o mesmo do seu lado e compare, para ter a certeza de que o pedido veio do Scratcher.

Entregas e novas tentativas

Se o seu URL não responder ou devolver um erro, o Scratcher tenta mais duas vezes: após 5 segundos e após um minuto. Clique em Mostrar entregas (ou Ver entregas) para ver cada pedido e resposta, mostrar apenas os falhados e usar Tentar novamente numa entrega. As entregas são guardadas durante 60 dias.

Ative Registar corpo da resposta para guardar também o que o seu sistema respondeu, o que ajuda na depuração.