Como funcionam os Webhooks

Search…

Configure seus webhooks em menos de 1 minuto.

Introdução
O webhook é a maneira mais simples e eficiente de o seu sistema saber quando um evento ocorrer na ZapSign (por exemplo, um documento foi assinado). Isso porque cadastrando um webhook, o seu sistema será avisado proativamente pela ZapSign assim que um evento ocorrer (na prática, a ZapSign envia uma requisição POST para o seu servidor). 
Assim, a grande vantagem do webhook é que em vez de o seu sistema fazer várias requests por dia, hora e minuto à ZapSign (prática conhecida como polling), checando se houve alguma atualização nos documentos, a ZapSign se encarrega desse trabalho e avisa você, poupando recursos dos dois lados.
A sua aplicação deve retornar o status 200 quando receber um webhook, caso contrário a ZapSign irá retentar o envio, gerando duplicidades e/ou requisições desnecessárias.
Preciso ter um Plano de API para usar webhooks? Não, pois os webhooks estão disponíveis gratuitamente a todos usuários. Mas é fortemente recomendado aos usuários da API que utilizem webhooks em vez de praticar polling.
Dica: também é possível utilizar os webhooks da ZapSign para criar integrações "sem código" via plataformas conectoras como Zapier, Pluga ou Integromat. Leia mais nesse artigo.
Cadastrando um webhook
Uma vez dentro da sua conta, clique na barra lateral em Configurações. 
Dentro dela, clique em "Habilitar Webhooks", conforme indicações abaixo.
Clique em Configurações > Integração > Habilitar Webhooks.
Agora, com os Webhooks habilitados, basta inserir a URL dos endpoints em que você quer receber os webhooks.
Dica: para testes, você pode começar cadastrando um webhook da https://webhook.site/ para entender como funcionam as requisições que chegarão à sua aplicação.
Abaixo, cadastrei por exemplo dois webhooks, um de testes (da webhook.site) e outro da minha aplicação fictícia (a minhaaplicacao).
Você pode cadastrar quantos webhooks quiser.
Tudo dando certo, você irá começar a receber webhooks em todos endpoints cadastrados!
Veja como você receberia os webhooks no webhook.site por exemplo:
Exemplo de requisição webhook recebida no webhook.site

Signatários - Previous

Assinar em lote via API

Next - Webhooks

Logs de Webhooks

Last modified 2mo ago

Copy link

Contents

Introdução

Cadastrando um webhook