Cadastrar Webhook em um Documento via API

O que são Webhooks (POSTBack)?

Um Webhook, ou POSTBack, é uma forma de recebimento de informações quando um evento acontece. Na prática, é um mecanismo pelo qual um sistema (D4Sign) envia informações para outro sistema (o seu) de forma passiva, sem que o seu sistema precise "pedir" por essas informações.

Na D4Sign, um evento HTTP POST será disparado para a URL que você informar no documento, nas seguintes situações:

• Quando um documento for assinado por um signatário.

• Quando um documento atingir a fase FINALIZADO (ou seja, todas as partes assinaram).

• Quando um documento for CANCELADO.

• Quando um e-mail de notificação para um signatário não for entregue.

🚧 Importante: O disparo ocorre em formato FORM-DATA.

Como Cadastrar um Webhook em um Documento (Via API)

Para cadastrar um webhook em um documento específico via API, utilize o endpoint POST /documents/{UUID-DOCUMENT}/webhooks.

🚧 Atenção: Não esqueça de enviar o tokenAPI e a cryptKey em sua requisição, conforme o exemplo: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}.

Requisição - Envio Header

{
    "Content-Type": "application/json"
}

Requisição - Envio Body

Este objeto JSON ({"url": "SUA_URL_AQUI"}) irá cadastrar o webhook no documento.

Retornos Enviados para a Sua URL via POST

A D4Sign enviará diferentes tipos de retorno para a sua URL cadastrada, identificados pelo campo type_post e message:

• Retorno de documento finalizado:

  JSON

  {
      "uuid": "UUID-DOCUMENT",
      "type_post": "1",
      "message": "Finished document"
  }
  

• Retorno de documento cancelado: (Formato similar, com type_post e message específicos de cancelamento)

• Retorno de e-mail não entregue: (Formato similar, com type_post e message específicos de falha na entrega de e-mail)

• Retorno de assinatura do signatário: (Formato similar, com type_post e message específicos para cada assinatura)

🚧 Atenção: Sugerimos a utilização de serviços como http://requestcatcher.com/ para os testes iniciais.

Esses serviços fornecem uma URL temporária que irá coletar as requisições HTTP para apresentá-las de forma fácil, auxiliando na depuração da integração.

Tentativas de Disparo

A D4Sign possui um mecanismo robusto de tentativas de disparo para garantir que seu webhook seja entregue, mesmo que sua URL esteja temporariamente indisponível. Se a URL cadastrada no documento estiver inacessível, tentaremos efetuar 6 novas requisições, seguindo o seguinte cronograma:

• Tentativa 1: Imediata (0 min.)

• Tentativa 2: Após 1 hora.

• Tentativa 3: Após 1 hora.

• Tentativa 4: Após 1 hora.

• Tentativa 5: Após 6 horas.

• Tentativa 6: Após 6 horas.

• Tentativa 7: Após 12 horas.

Portanto, o webhook será perdido somente se a URL cadastrada estiver indisponível por mais de 27 horas.