Chaindoc logoChaindoc

Webhooks Chaindoc

Receba notificações em tempo real quando ocorrerem eventos na sua conta Chaindoc. Os webhooks enviam os dados dos eventos para o seu servidor instantaneamente, eliminando a necessidade de sondagem.

Visão geral

Os Webhooks do Chaindoc permitem que a tua aplicação receba notificações em tempo real quando ocorrem eventos na tua conta. Em vez de consultar a API, os webhooks enviam os dados do evento para o teu servidor assim que uma ação acontece.

Principais funcionalidades

  • Notificações em tempo real - Entrega instantânea de eventos para o teu servidor
  • Tentativas automáticas - Até 3 tentativas com recuo exponencial
  • Verificação de assinatura - HMAC SHA256 para autenticidade da carga útil
  • Filtragem de eventos - Receba apenas os eventos que lhe interessam
  • Rastreamento de erros - Monitorize o estado de entrega e as falhas do webhook

Casos de uso

  • Envie notificações por e-mail quando os documentos forem assinados
  • Aciona fluxos de trabalho quando os documentos forem verificados na blockchain
  • Atualize a sua base de dados quando forem criados pedidos de assinatura
  • Sincroniza o estado do documento com sistemas externos
  • Registo de auditoria e conformidade

Configuração

Passo 1: Crie uma chave API

Navegue até Configurações → Acesso à API no seu painel do Chaindoc e crie uma chave API com a configuração webhook ativada.

Passo 2: Configure o URL do Webhook

Use a API para configurar o seu endpoint 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 o ponto final do Webhook

Crie um ponto final no seu servidor para receber eventos webhook. Aqui estão alguns exemplos em diferentes idiomas:

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 eventos

O Chaindoc envia webhooks para os seguintes eventos:

document.created

Acionado quando um novo documento é criado através da API.

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

document.verified

Acionado 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"
}

documento.assinado

Acionado quando todas as assinaturas necessárias forem recolhidas.

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

Acionado 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

Acionado quando todos os signatários concluírem as 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

Acionado quando um signatário rejeita o pedido 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 todas as cargas úteis do webhook usando HMAC SHA256. Verifique sempre as assinaturas para garantir a autenticidade e evitar ataques de repetição.

Como funciona a verificação de assinatura

1Chaindoc cria assinaturaO Chaindoc cria uma assinatura HMAC usando o seu segredo webhook

2Assinatura enviada no cabeçalhoA assinatura é enviada no cabeçalho X-Webhook-Signature

3O teu servidor verificaO teu servidor recalcula a assinatura e compara usando uma função segura em termos de tempo

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 repetição

O Chaindoc tenta automaticamente novamente as entregas de webhooks com falha, com backoff exponencial.

  • 1.ª tentativa: Após 1 minuto
  • 2.ª tentativa: Após 5 minutos (total: 6 minutos)
  • 3.ª tentativa: Após 15 minutos (total: 21 minutos)

Testando Webhooks

Desenvolvimento local

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

terminal
# Install ngrok
npm install -g ngrok

# Start your local server
node server.js

# Expose port 3000
ngrok http 3000

# Use the ngrok URL as your webhook endpoint
# Example: https://abc123.ngrok.io/webhooks/chaindoc

Testes manuais

Teste o seu endpoint webhook com uma carga útil de amostra:

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"
  }'

Melhores práticas

  • Verifique sempre as assinaturas do webhook antes de processar
  • Responde rápido (em menos de 30 segundos) para evitar tempos limite
  • Processe webhooks de forma assíncrona numa fila
  • Implementa idempotência para lidar com eventos duplicados
  • Regista todos os eventos webhook para depuração e auditoria
  • Monitore falhas na entrega de webhooks no seu painel
  • Use pontos finais HTTPS por segurança
  • Lida com todos os tipos de eventos com elegância (ignora eventos desconhecidos)

Exemplo completo

Aqui está um manipulador 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',
      blockchainTxHash: payload.txHash,
      verifiedAt: new Date(payload.timestamp),
    },
  });
}

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

function verifySignature(payload: any, signature: string, secret: string): boolean {
  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);