Configurar webhooks

Um webhook é uma forma de a VerifyPDF avisar seu sistema de que um resultado está pronto, em vez de seu sistema ficar perguntando várias vezes. Este artigo explica a ideia e como ativá-lo.

O que é um webhook, em termos simples

Quando você verifica um documento, o resultado nem sempre fica pronto na hora. Sem um webhook, seu sistema precisa ficar conferindo: “já terminou?”. Isso é chamado de polling.

Um webhook inverte essa lógica. Você dá à VerifyPDF uma URL do seu próprio sistema. Quando um resultado fica pronto, a VerifyPDF chama essa URL e envia o resultado para você. Seu sistema reage à chamada em vez de ficar consultando por mudanças.

Defina uma URL de webhook por chave

Cada chave de API pode ter sua própria URL de webhook. Você a define no painel:

1. Faça login em secure.verifypdf.com e abra Developers na barra lateral esquerda.
2. Escolha a chave de API que você quer usar e edite a URL do webhook dela clicando na seta para expandir a seção de configuração do webhook.
3. Salve. A URL precisa começar com https://.

Como a URL é definida por chave, você pode encaminhar notificações de diferentes integrações para endpoints diferentes, por exemplo uma chave test apontada para uma URL de teste e uma chave live para sua URL de produção. Veja Chaves de API test e live.

Para desativar os webhooks de uma chave, deixe o campo da URL vazio e salve.

O que a VerifyPDF envia

Quando uma verificação termina, a VerifyPDF chama sua URL de webhook para que seu sistema possa agir com base no resultado, por exemplo atualizando um caso ou alertando um analista. Para o payload exato e como confirmar que uma chamada realmente veio da VerifyPDF, veja a referência da API em /agents/ e a documentação de Developers dentro do painel.

Próximos passos

• Precisa de uma chave primeiro? Veja Gerar e gerenciar chaves de API.
• Quer o fluxo de envio completo? Veja Verificar um documento com a API.