Webhooks

Os Webhooks permitem que o seu sistema receba notificações em tempo real sobre eventos que ocorrem na nossa plataforma. Em vez de fazer polling na API para verificar se um envelope foi finalizado, nós enviamos um HTTP POST para uma URL que você configurar assim que o evento acontecer.

Eventos Suportados

Atualmente, suportamos o seguinte evento:

Evento	Descrição
`ENVELOPE_COMPLETED`	Disparado quando todos os signatários finalizaram a assinatura de um envelope.

Formato da Requisição

Enviaremos uma requisição POST para a sua URL configurada com um corpo em JSON.

Exemplo de Payload (`ENVELOPE_COMPLETED`)

{
  "id": "evt_8a7b6c5d4e3f2a1",
  "event": "ENVELOPE_COMPLETED",
  "createdAt": "2025-10-20T14:30:00.000Z",
  "data": {
    "envelope": {
      "id": "env_123456789",
      "status": "COMPLETED",
      "completedAt": "2025-10-20T14:30:00.000Z"
    },
    "documents": [
      {
        "id": "doc_987654321",
        "name": "Contrato_Prestacao_Servicos.pdf",
        "originalFileHash": "sha256_hash_string..."
      }
    ],
    "signatories": [
      {
        "id": "sig_112233",
        "name": "João da Silva",
        "email": "joao@empresa.com",
        "signedAt": "2025-10-20T14:25:00.000Z"
      },
      {
        "id": "sig_445566",
        "name": "Maria Souza",
        "email": "maria@cliente.com",
        "signedAt": "2025-10-20T14:29:55.000Z"
      }
    ]
  }
}

Nota: Por segurança, não enviamos o arquivo PDF assinado diretamente no webhook. Utilize o id do documento recebido para gerar uma URL de download segura através da nossa API (GET /documents/{documentId}/download).

Retentativas e Falhas

Se o seu servidor não responder com um status de sucesso (2xx), nosso sistema tentará reenviar o webhook automaticamente.

Política de Retentativa: Utilizamos um algoritmo de backoff exponencial. Tentaremos enviar novamente em intervalos crescentes (ex: 1 min, 5 min, 30 min...) por um período determinado.

Timeout: Seu servidor deve processar o webhook e responder o mais rápido possível. Se você precisar executar tarefas longas, recomendamos enfileirar o trabalho do seu lado e responder com 200 OK imediatamente.

Eventos Suportados#

Formato da Requisição#

Exemplo de Payload (ENVELOPE_COMPLETED)#

Retentativas e Falhas#

Eventos Suportados

Formato da Requisição

Exemplo de Payload (`ENVELOPE_COMPLETED`)

Retentativas e Falhas