Chaindoc logoChaindoc

Webhooks do Chaindoc

Webhooks enviam dados de eventos para o seu servidor no exato momento em que algo acontece no Chaindoc. Sem polling, sem delays. Esta página cobre setup, tipos de eventos, verificação HMAC, lógica de retry e testes.

Visão geral

Em vez de ficar consultando a API, os webhooks avisam seu servidor sobre o que aconteceu assim que ocorre. Você vai usá-los para sincronizar o status de documentos, disparar workflows após assinaturas, enviar notificações e manter seu banco de dados atualizado.

  • Entrega instantânea com até 3 retries automáticos (backoff exponencial)
  • Verificação de assinatura HMAC SHA256 em cada payload
  • Filtre apenas os tipos de evento que você precisa
  • Acompanhamento de status de entrega no seu dashboard

Configuração

Passo 1: Criar uma chave de API

Navegue até Configurações → Acesso à API no seu dashboard Chaindoc e crie uma chave de API com configuração de webhooks habilitada.

Passo 2: Configurar a URL do webhook

Use a API para configurar seu endpoint de webhook:

terminal
curl -X PATCH https://api.chaindoc.io/user/api-access/1/config \
  -H "Authorization: Bearer your_auth_token" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://yourapp.com/webhooks/chaindoc",
    "webhookEnabled": true,
    "webhookSecret": "your_secure_random_string"
  }'

Passo 3: Implementar seu endpoint

Crie um endpoint no seu servidor para receber eventos de webhook. Aqui estão exemplos em diferentes linguagens:

const express = require('express');
const crypto = require('crypto');

const app = express();
app.use(express.json());

app.post('/webhooks/chaindoc', (req, res) => {
  const signature = req.headers['x-webhook-signature'];
  const eventType = req.headers['x-webhook-event'];
  
  // Verify signature
  if (!verifySignature(req.body, signature, process.env.WEBHOOK_SECRET)) {
    return res.status(401).send('Invalid signature');
  }
  
  // Process event
  console.log('Received event:', eventType, req.body);
  
  // Handle different event types
  switch (eventType) {
    case 'document.created':
      handleDocumentCreated(req.body);
      break;
    case 'document.verified':
      handleDocumentVerified(req.body);
      break;
    case 'signature.request.completed':
      handleSignatureCompleted(req.body);
      break;
  }
  
  // Always respond with 200 OK
  res.status(200).send('Webhook received');
});

function verifySignature(payload, signature, secret) {
  const hmac = crypto.createHmac('sha256', secret);
  const digest = hmac.update(JSON.stringify(payload)).digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(digest)
  );
}

app.listen(3000);

Tipos de evento

O Chaindoc envia webhooks para os seguintes eventos:

document.created

Disparado quando um novo documento é criado via API.

terminal
{
  "event": "document.created",
  "documentId": "86840ee4-8bf2-4a91-a289-e99d8307ec25",
  "name": "Service Agreement",
  "timestamp": "2024-12-04T10:30:00.000Z"
}

document.verified

Disparado quando um documento é verificado com sucesso na blockchain.

terminal
{
  "event": "document.verified",
  "documentId": "86840ee4-8bf2-4a91-a289-e99d8307ec25",
  "versionId": "f0b7721f-0399-4035-9b69-7b95d3a367f0",
  "txHash": "0x789ghi...",
  "chainId": 137,
  "timestamp": "2024-12-04T10:35:00.000Z"
}

document.signed

Disparado quando todas as assinaturas necessárias são coletadas.

terminal
{
  "event": "document.signed",
  "documentId": "86840ee4-8bf2-4a91-a289-e99d8307ec25",
  "signatureRequestId": "req_21096b94498f4a2d9795e810edc2c9a9",
  "signers": [
    {
      "email": "signer1@example.com",
      "signedAt": "2024-12-04T10:30:00.000Z"
    },
    {
      "email": "signer2@example.com",
      "signedAt": "2024-12-04T10:32:00.000Z"
    }
  ],
  "timestamp": "2024-12-04T10:32:00.000Z"
}

signature.request.created

Disparado quando uma nova solicitação de assinatura é criada.

terminal
{
  "event": "signature.request.created",
  "signatureRequestId": "req_21096b94498f4a2d9795e810edc2c9a9",
  "documentId": "86840ee4-8bf2-4a91-a289-e99d8307ec25",
  "recipients": [
    {"email": "signer1@example.com"},
    {"email": "signer2@example.com"}
  ],
  "deadline": "2024-12-31T23:59:59.000Z",
  "timestamp": "2024-12-04T10:30:00.000Z"
}

signature.request.completed

Disparado quando todos os signatários completam suas assinaturas.

terminal
{
  "event": "signature.request.completed",
  "signatureRequestId": "req_21096b94498f4a2d9795e810edc2c9a9",
  "documentId": "86840ee4-8bf2-4a91-a289-e99d8307ec25",
  "completedAt": "2024-12-04T10:32:00.000Z",
  "timestamp": "2024-12-04T10:32:00.000Z"
}

signature.request.rejected

Disparado quando um signatário rejeita a solicitação de assinatura.

terminal
{
  "event": "signature.request.rejected",
  "signatureRequestId": "req_21096b94498f4a2d9795e810edc2c9a9",
  "documentId": "86840ee4-8bf2-4a91-a289-e99d8307ec25",
  "rejectedBy": "signer1@example.com",
  "reason": "Terms not acceptable",
  "timestamp": "2024-12-04T10:30:00.000Z"
}

Segurança

Verificação de assinatura

O Chaindoc assina todos os payloads de webhook usando HMAC SHA256. Sempre verifique as assinaturas para garantir autenticidade e prevenir ataques de replay.

Como funciona a verificação

1O Chaindoc cria a assinaturaO Chaindoc cria a assinatura HMAC usando seu webhook secret

2Assinatura enviada no headerA assinatura é enviada no header X-Webhook-Signature

3Seu servidor verificaSeu servidor recalcula a assinatura e compara usando função timing-safe

const crypto = require('crypto');

function verifyWebhookSignature(payload, signature, secret) {
  const hmac = crypto.createHmac('sha256', secret);
  const digest = hmac.update(JSON.stringify(payload)).digest('hex');
  
  // Use timing-safe comparison to prevent timing attacks
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(digest)
  );
}

// Usage
const isValid = verifyWebhookSignature(
  req.body,
  req.headers['x-webhook-signature'],
  process.env.WEBHOOK_SECRET
);

if (!isValid) {
  return res.status(401).send('Invalid signature');
}

Lógica de retry

O Chaindoc automaticamente retenta entregas de webhook falhas com backoff exponencial.

  • 1º retry: Após 1 minuto
  • 2º retry: Após 5 minutos (total: 6 minutos)
  • 3º retry: Após 15 minutos (total: 21 minutos)

Testando webhooks

Desenvolvimento local

Use ferramentas como ngrok para expor seu servidor local para testes de webhook:

terminal
# Instalar ngrok
npm install -g ngrok

# Iniciar seu servidor local
node server.js

# Expor porta 3000
ngrok http 3000

# Use a URL do ngrok como seu endpoint de webhook
# Exemplo: https://abc123.ngrok.io/webhooks/chaindoc

Teste manual

Teste seu endpoint de webhook com um payload de exemplo:

terminal
curl -X POST https://yourapp.com/webhooks/chaindoc \
  -H "Content-Type: application/json" \
  -H "X-Webhook-Event: document.created" \
  -H "X-Webhook-Signature: test_signature" \
  -d '{
    "event": "document.created",
    "documentId": "test-123",
    "name": "Test Document",
    "timestamp": "2024-12-04T10:30:00.000Z"
  }'

Boas práticas

  • Sempre verifique as assinaturas de webhook antes de processar
  • Responda rapidamente (menos de 30 segundos) para evitar timeouts
  • Processe webhooks de forma assíncrona em uma fila
  • Implemente idempotência para lidar com eventos duplicados
  • Registre todos os eventos de webhook para debugging e auditoria
  • Monitore falhas de entrega de webhook no seu dashboard
  • Use endpoints HTTPS por segurança
  • Lide com todos os tipos de evento adequadamente (ignore eventos desconhecidos)

Exemplo de produção

Aqui está um handler de webhook pronto para produção com integração de banco de dados:

webhooks/chaindoc.ts
import express from 'express';
import crypto from 'crypto';
import { PrismaClient } from '@prisma/client';

const app = express();
const prisma = new PrismaClient();

app.use(express.json());

app.post('/webhooks/chaindoc', async (req, res) => {
  const signature = req.headers['x-webhook-signature'] as string;
  const eventType = req.headers['x-webhook-event'] as string;
  const payload = req.body;
  
  // 1. Verify signature
  if (!verifySignature(payload, signature, process.env.WEBHOOK_SECRET!)) {
    console.error('Invalid webhook signature');
    return res.status(401).json({ error: 'Invalid signature' });
  }
  
  // 2. Check for duplicate events (idempotency)
  const eventId = `${eventType}-${payload.timestamp}`;
  const existing = await prisma.webhookEvent.findUnique({
    where: { eventId },
  });
  
  if (existing) {
    console.log('Duplicate event, skipping:', eventId);
    return res.status(200).json({ status: 'duplicate' });
  }
  
  // 3. Store event
  await prisma.webhookEvent.create({
    data: {
      eventId,
      eventType,
      payload,
      processedAt: new Date(),
    },
  });
  
  // 4. Process event asynchronously
  processWebhookAsync(eventType, payload).catch((error) => {
    console.error('Error processing webhook:', error);
  });
  
  // 5. Respond immediately
  res.status(200).json({ status: 'received' });
});

async function processWebhookAsync(eventType: string, payload: any) {
  switch (eventType) {
    case 'document.verified':
      await handleDocumentVerified(payload);
      break;
    case 'signature.request.completed':
      await handleSignatureCompleted(payload);
      await sendNotificationEmail(payload);
      break;
    case 'signature.request.rejected':
      await handleSignatureRejected(payload);
      break;
  }
}

async function handleDocumentVerified(payload: any) {
  await prisma.document.update({
    where: { id: payload.documentId },
    data: {
      status: 'VERIFIED',
      txHash: payload.txHash,
      verifiedAt: new Date(),
    },
  });
}

async function handleSignatureCompleted(payload: any) {
  await prisma.signatureRequest.update({
    where: { id: payload.signatureRequestId },
    data: {
      status: 'COMPLETED',
      completedAt: new Date(),
    },
  });
}

async function sendNotificationEmail(payload: any) {
  // Send email notification
  console.log('Sending notification for:', payload.signatureRequestId);
}

function verifySignature(payload: any, signature: string, secret: string) {
  const hmac = crypto.createHmac('sha256', secret);
  const digest = hmac.update(JSON.stringify(payload)).digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(digest)
  );
}

app.listen(3000, () => {
  console.log('Webhook server running on port 3000');
});

O que fazer a seguir