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": "acceptance_term_sent",
    "data": {
      "user": {
        "email": "[email protected]",
	  "name": "John Admin"
      },
      "account": {
        "key": "a63c9e1a-de14-4434-b448-ec8601d2186b"
      }
    },
    "occurred_at": "2022-07-26T16:24:04.879-03:00"
  },
  "acceptance": {
    "key": "a8a19bb3-3154-48b9-9ac7-a6eb4826a0be",
    "name": "Alteração Plano de Internet",
    "sender_name": "John Admin",
    "sender_phone": "",
    "content": "O valor do plano subiu para 129.90",
    "status": "sent",
    "signer_phone": "00999999999",
    "signer_name": "Fernando Sacchet",
    "sent_at": "2022-07-25T14:19:07.497-03:00",
    "created_at": "2022-07-25T14:18:37.455-03:00",
    "messages": [
      {
        "message_id": "SMf9cd2d5293f4448d9f23e8fa44368a03",
        "message": "Olá *Fernando*!\n\n O Remetente *John Admin* enviou *Alteração de Plano* para você analisar e a Clicksign foi contratada para registrar o seu Aceite. Toque em Visualizar para ter acesso ao conteúdo.\n\n Lembre-se que o processo de Aceite precisa ser finalizado em até *24 horas* para não expirar.\n\n Ao visualizar, você confirma que é *Fernando*, concorda com os Termos de Uso da Clicksign e declara estar ciente da Política de Privacidade.\n\n Termos de Uso 👉 https://www.clicksign.com/termos\n\n Política de Privacidade 👉 https://www.clicksign.com/politica-de-privacidade",
        "profile_name": "Fernando",
        "error_message": "",
        "direction": "sent",
        "created_at": "2022-07-25T14:19:07.497-03:00"
      } ]
    }
}

**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