Criar Webhook
Configure URL e eventos que irão disparar notificações.
Criar um webhook leva poucos minutos. Você precisa de um endereço HTTPS do seu sistema, escolher os eventos e guardar a chave de assinatura que geramos para você.
Passo a passo
- 1Acesse Configurações → WebhooksNo menu de configurações, abra Webhooks e clique em 'Criar Webhook'.
- 2Informe o endereço de destinoCole a URL HTTPS do endpoint do seu sistema. Ele precisa aceitar POST com corpo JSON e estar acessível pela internet. Para os primeiros testes, serviços como o Webhook.site resolvem.
- 3Escolha os eventosMarque apenas o que o seu sistema realmente vai tratar. Eventos que você não usa geram chamadas desnecessárias e poluem o histórico.
- 4Guarde a chave de assinaturaCada webhook recebe uma chave exclusiva, gerada automaticamente. Copie e guarde num cofre de segredos — evite deixá-la no código. Você pode revê-la depois em 'Ver secret'.
- 5SalvarClique em Salvar. O webhook já fica ativo e começa a enviar notificações imediatamente.
Boas práticas
- Use HTTPS — Sempre use URLs com HTTPS para garantir que os dados trafeguem criptografados.
- Responda rápido — Seu endpoint deve responder em até 10 segundos com status 2xx. Valide a assinatura, guarde o evento numa fila, responda 200 e processe depois.
- Valide a assinatura — Use o secret para validar o header X-Webhook-Signature e garantir que a requisição é legítima.
- Pause quando precisar — Para manutenção, desative o webhook em vez de excluí-lo. Você não perde a configuração.
- Um webhook por finalidade — Como cada webhook tem sua própria lista de eventos, separar por destino costuma ser mais simples do que um endereço único que recebe tudo.
Cabeçalhos extras
Se o seu endpoint exige autenticação própria, dá para cadastrar cabeçalhos extras que acompanham toda chamada — um token de acesso, por exemplo. Os reservados Content-Type, X-Webhook-Signature e X-Webhook-Event são definidos pela Leaper e não podem ser sobrescritos.