Disparos de Webhooks

Anatomia de uma requisição Webhook

Quando ocorrer um evento em um documento, uma requisição HTTP POST será disparada para a URL previamente cadastrada nas configurações da conta.

POST /documents HTTP/1.1
Host: www.example.com
Content-Type: application/json
Accept: application/json
Event: upload
Content-Hmac: sha256=75417778600008707f990e38babb0f72444404d4c2ad5e9a2189a2c920b0f10b
{
  event: { /* Evento que disparou o Webhook */
    "name": "add_signer", 
    "data": {
      "user": {
        "email": "[email protected]",
        "name": "Empresa de Teste"
      },
      "account": {
        "key": "35286aca-beef-490d-ad23-bc5e78441232"
      },
      "signers": [
        {
          "key": "c9d50ca2-543f-49ee-924a-345f23088434",
          "request_signature_key": "c08a5ed5-3c74-987c-830f-ae9b9ddd7b85",
          "email": "[email protected]",
          "created_at": "2018-04-24T22:42:40.180-03:00",
          "sign_as": "witness",
          "auths": [
            "sms"
          ],
          "phone_number": "11987654321",
          "phone_number_hash": "66e0c202cea2d29452067233e8e0f8fe2808cca773852ab537e40cf4a68d16ae"
        }
      ]
    },
    "occurred_at": "2018-04-25T01:42:40.197Z"
  },
  "document": { /* Documento */
    //...
  },
    "signers": [ /* Signatários deste documento */
      //...
    ],
    "events": [ /* Array completo com todos eventos deste documento */
      {
        "name": "add_signer",
        //...
      },
      {
        "name": "sign",
        //...
      },      
      {
        "name": "upload",
        //...
      }
    ]
  }
}

Timeout de Webhooks

O disparo dos Webhooks tem timeout de 5 segundos. Se a sua aplicação não responder com um código 2XX neste intervalo, o Webhook será enfileirado para ser disparado novamente conforme a tabela abaixo. Recomendamos que sua aplicação responda o mais rápido possível aos Webhooks da Clicksign. Se você precisar realizar outras requisições ou processamentos dos documentos, realize esses procedimentos em background.

Tentativas de disparo de Webhook

A Clicksign realiza 10 tentativas de envio da requisição para a URL cadastrada. Assim, um webhook é perdido somente se a URL cadastrada estiver indisponível por mais de 24 horas.

Tentativas de disparo: Tentativa 1: Momento em que ocorre o evento. Tentativa 2: 00:00:10 (Mais 10 segundos) Tentativa 3: 00:01:00 (Mais 50 segundos) Tentativa 4: 00:05:00 (Mais 4 minutos) Tentativa 5: 00:30:00 (Mais 25 minutos) Tentativa 6: 01:00:00 (Mais 30 minutos) Tentativa 7: 02:00:00 (Mais 1 hora) Tentativa 8: 06:00:00 (Mais 4 horas) Tentativa 9: 12:00:00 (Mais 6 horas) Tentativa 10: 1 dia (Mais 12 horas)





❓Precisa de ajuda? [email protected]

💰Dúvida sobre planos e preços? Veja o comparativo

🔍Não sabe qual versão está usando? Descubra a sua versão

📚Respostas rápidas? Visite nosso FAQ