Disponível no plano Marketer e nos planos superiores.
Os webhooks são a forma como o Pretty Links informa outros sistemas quando algo acontece. Sempre que um link é adicionado, editado, enviado para a lixeira, restaurado ou removido, o Pretty Links envia uma solicitação HTTP POST para uma URL que você especificar, com um corpo JSON descrevendo o que aconteceu.
Este guia faz parte do Visão geral do complemento “Pretty Links Developer Tools”, o ponto de acesso ao complemento “Ferramentas do Desenvolvedor”.
Adicionando uma assinatura
- Ir para Painel > Pretty Links > Ferramentas do desenvolvedor > Webhooks.
- Clique em Adicionar assinatura.
- Preencha:
- URL de destino — A URL HTTPS completa para a qual os Pretty Links devem enviar a solicitação POST. Geralmente, trata-se de uma URL de webhook fornecida pelo Zapier, Make, n8n, seu endpoint personalizado ou um webhook de entrada do Slack/Teams;
- Tipos de eventos — Quais eventos devem acionar este webhook (veja abaixo);
- Descrição — Descrição opcional para que você se lembre para que serve essa assinatura.
- Clique em Salvar.
A assinatura já está ativa. Na próxima vez que ocorrer um evento correspondente, sua URL de destino receberá uma solicitação POST.
Tipos de eventos
Você pode se inscrever em um evento, em vários eventos ou em todos os eventos.
| Evento | Disparar quando |
|---|---|
link adicionado | É criado um novo Pretty Link |
link-atualizado | Um Pretty Link já existente é editado |
link-excluído | Um Pretty Link é movido para a lixeira |
link-restaurado | Um Pretty Link enviado para a lixeira é recuperado da lixeira |
link removido | Um Pretty Link foi excluído definitivamente |
todos | Todas as opções acima (você receberá todos os eventos de link) |
Escolha todos se você quiser uma única assinatura para acompanhar tudo, ou selecionar eventos específicos caso seu sistema de destino se interesse apenas, por exemplo, pela criação de novos links.
Segurança de webhooks: o cabeçalho PRLI-WEBHOOK-KEY
Seu site tem um único chave de webhook — mostrado em Painel > Pretty Links > Ferramentas do desenvolvedor junto com a chave da API. O Pretty Links envia essa chave no PRLI-WEBHOOK-KEY cabeçalho de cada POST que ele envia para uma URL de destino, independentemente de qual assinatura tenha sido acionada.
Seu endpoint de recepção deve verificar esse cabeçalho. Se o valor corresponder à chave que o Pretty Links exibe no painel de administração, a solicitação é legítima. Se não corresponder (ou estiver ausente), a solicitação é falsa e seu endpoint deve ignorá-la.
Assim como a chave da API, você pode regenerar a chave do webhook no painel de administração caso ela venha a vazar. Regenerá-la significa atualizar o valor de comparação em todos os receptores que você configurou.
É assim que você protege seu endpoint contra pessoas que enviam cargas falsas do tipo “link adicionado” para sua URL. Sem a verificação da chave, qualquer pessoa que adivinhar a URL do seu webhook poderia acionar sua automação posterior.
A maioria dos receptores de webhooks (Zapier, Make, código personalizado) permite que você leia os cabeçalhos das chamadas recebidas. Compare PRLI-WEBHOOK-KEY ao valor esperado antes de processar a carga útil.
Registro de Eventos
Cada envio de webhook — bem-sucedido ou não — é registrado no log de eventos na tela Webhooks. Para cada envio, você pode ver:
- O tipo de evento;
- A URL de destino para a qual foi enviado;
- O código de resposta HTTP que seu endpoint retornou;
- A carga útil completa que foi enviada.
Isso é útil para a depuração. Se um Zap não estiver sendo acionado, verifique o log de eventos: o Pretty Links realmente enviou o webhook? Seu endpoint retornou um código 200 ou 500? A carga útil estava de acordo com o esperado?
Envio de teste
Ao lado de cada assinatura há um Envio de teste ação. Clique nela e o Pretty Links enviará uma carga de teste para a sua URL de destino agora mesmo, sem esperar por um evento real.
Use “Enviar para teste” para:
- Verifique se uma nova assinatura está conectada corretamente;
- Confirme se a URL de destino está acessível;
- Veja como fica o formato da carga útil na sua ferramenta de processamento posterior;
- Faça um novo teste após alterar a URL de destino.
Configurações comuns de webhooks
Alerta no Slack quando um link de campanha é criado: Inscreva-se no link adicionado e configure a URL de destino para um webhook de entrada do Slack (geralmente por meio do Zapier ou do Make para formatação).
Arquivar automaticamente na planilha quando o link for enviado para a lixeira: Inscreva-se no link-excluído e configure a URL de destino para um webhook do Zapier que adicione uma linha à planilha do Google “Links excluídos”.
Sincronizar com um CRM personalizado: Inscreva-se no todos e configure a URL de destino para o endpoint de entrada do seu CRM. Use o campo “tipo de evento” na carga útil para determinar o que fazer em cada lado.
Novas tentativas e falhas
Se o seu endpoint retornar um código de resposta diferente de 2xx (ou não responder de forma alguma), a entrega será registrada como malsucedida. Verifique o seu endpoint, corrija o problema e, em seguida, use o “Teste de envio” para confirmar se ele está funcionando novamente. Eventos reais que ocorreram durante a interrupção não são reproduzidos automaticamente; portanto, certifique-se de que seu endpoint seja confiável antes de depender de webhooks para fluxos de trabalho críticos.