Como adicionar Webhooks?

Os Webhooks são serviços utilizados via API, que têm como função avisar um endpoint (URL) sobre novos eventos, vindos de um determinado sistema.

Webhooks permitem criar integrações que comunicam eventos ocorridos nos documentos da plataforma da Clicksign. Quando um evento ocorre, a Clicksign notifica a sua aplicação imediatamente, através de uma requisição HTTP POST para a URL previamente cadastrada.

Como adicionar Webhooks?

É possível adicionar Webhooks de duas formas: através da plataforma Clicksign ou diretamente pela API. Confira abaixo como seguir em ambos os casos:

Adicionando um Webhook pela plataforma Clicksign

1. Vá até as Configurações, entre na aba API e em seguida clique em Adicionar Webhook. Adicione uma URL válida para realizar o cadastro. Será nessa URL que você receberá requisições HTTP POST com os eventos que ocorrerem nos documentos.

2. Consulta do HMAC SHA256 Secret: Após o cadastro do Webhook, será gerado um HMAC SHA256 Secret. Veja como utilizá-lo em Segurança de Webhooks.

Adicionando um Webhook via API

Recomendamos que o processo abaixo seja feito por alguém com conhecimentos em programação, seguindo os passos da nossa documentação para desenvolvedores – cadastro de Webhooks via API.

Eventos do Documento

Quando ocorrerem eventos nos documentos da sua conta, uma requisição HTTP POST pode ser disparada para a URL cadastrada no webhook. Para contexto geral, consulte “Introdução a Webhooks” e “Segurança de Webhooks”. Para cadastro, veja “Cadastro de Webhooks”.

Use os nomes abaixo exatamente como indicados ao configurar os eventos no cadastro do webhook (via APP ou API).