Como funciona
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.
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.
Não é necessário ter a API ou Token de Acesso ativados para utilizar webhooks. São funcionalidades independentes. Mas é fortemente recomendado aos usuários da API que utilizem webhooks em vez de praticar polling.
Uma vez dentro da sua conta, clique na barra lateral em Configurações.
Dentro dela, clique em "Habilitar Webhooks", conforme setas vermelhas abaixo.
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).
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:
Na próxima página, apresentaremos os tipos de eventos que a ZapSign envia por webhook.
