Webhooks

Como os webhooks funcionam

1. Você configura uma URL de webhook na KivoSign
2. Quando um evento acontece, a KivoSign envia um HTTP POST para essa URL
3. Seu sistema processa o evento e responde com 200 OK

A KivoSign envia webhooks para todo o ciclo de vida do documento (criado, enviado, aberto, assinado, concluído, recusado, cancelado), para eventos de destinatário (destinatário concluiu, lembrete enviado, destinatário expirou) e para eventos de modelo (criado, atualizado, excluído, usado).

Primeiros passos

Exemplo de payload

{
  "event": "DOCUMENT_COMPLETED",
  "payload": {
    "id": 123,
    "envelopeId": "envelope_abcdefhiklmnorst",
    "title": "Contrato",
    "status": "COMPLETED",
    "completedAt": "2024-01-15T10:30:00.000Z",
    "recipients": [
      {
        "id": 1,
        "envelopeId": "envelope_abcdefhiklmnorst",
        "email": "signatario@exemplo.com",
        "signingStatus": "SIGNED"
      }
    ]
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "webhookEndpoint": "https://seu-endpoint.com/webhook"
}

payload.id é o ID numérico legado (v1). Use payload.envelopeId como identificador canônico da v2. Cada destinatário repete o envelopeId como vínculo confiável com o envelope, porque os campos legados documentId e templateId dependem do tipo do envelope e um deles sempre vem nulo.

Veja também

• Ciclo de vida do documento - Os status do documento