Webhooks recibir eventos de sinatura en tempo real

Formato da carga útil

Todos os eventos comparten o mesmo esquema JSON de nivel superior: `event`, `envelope_id`, `occurred_at`, `data`. O contido de `data` varía segundo o evento (campos documentados por evento na referencia API).

{
  "event": "envelope.completed",
  "envelope_id": "env_01HG3K8X9Y2N4P5Q6R7S8T9V0W",
  "occurred_at": "2026-05-27T08:42:13.521Z",
  "data": {
    "title": "Contrat de prestation Acme Corp",
    "status": "completed",
    "created_at": "2026-05-24T14:12:00.000Z",
    "completed_at": "2026-05-27T08:42:13.000Z",
    "signers": [
      {
        "email": "client@acme.example",
        "name": "Alex Client",
        "signed_at": "2026-05-27T08:42:13.000Z",
        "method": "eidas_aes",
        "ip": "203.0.113.42"
      }
    ],
    "proof_pdf_url": "https://certyneo.com/api/envelopes/env_01HG.../proof.pdf"
  }
}

A sinatura HMAC é calculada no corpo bruto como enviado non alterar os espazos, o re-parsing JSON moitas veces cambia a orde das claves e rompe a verificación.

Comprobar a sinatura HMAC

Cada solicitude é asinada co seu segredo webhook (visible unha vez cando se crea no panel de control e despois cifrado ao descanso).<timestamp>,v1=<hex_hmac>`. Sempre comprobar a sinatura antes de procesar a carga útil sen este paso, calquera pode forxar un evento e chamar o seu endpoint.

import crypto from "node:crypto";

export function verifyCertyneoSignature(
  rawBody: string,
  signatureHeader: string,
  secret: string,
): boolean {
  // Header format: t=<timestamp>,v1=<hex_hmac>
  const parts = Object.fromEntries(
    signatureHeader.split(",").map((p) => p.split("=")),
  );
  const ts = parts.t;
  const sig = parts.v1;
  if (!ts || !sig) return false;

  // Reject events older than 5 minutes (replay protection).
  const age = Math.abs(Date.now() / 1000 - Number(ts));
  if (age > 300) return false;

  const expected = crypto
    .createHmac("sha256", secret)
    .update(`${ts}.${rawBody}`)
    .digest("hex");

  // timingSafeEqual to mitigate timing attacks.
  return crypto.timingSafeEqual(
    Buffer.from(expected, "hex"),
    Buffer.from(sig, "hex"),
  );
}

import hashlib
import hmac
import time


def verify_certyneo_signature(
    raw_body: bytes, signature_header: str, secret: str
) -> bool:
    """Verify a Certyneo webhook signature.

    Header format: `t=<timestamp>,v1=<hex_hmac>`
    Rejects events older than 5 minutes (replay protection).
    """
    parts = dict(p.split("=") for p in signature_header.split(","))
    ts = parts.get("t")
    sig = parts.get("v1")
    if not ts or not sig:
        return False

    if abs(time.time() - int(ts)) > 300:
        return False

    expected = hmac.new(
        secret.encode("utf-8"),
        f"{ts}.{raw_body.decode('utf-8')}".encode("utf-8"),
        hashlib.sha256,
    ).hexdigest()

    return hmac.compare_digest(expected, sig)

Política de retry

Se o seu endpoint responde a algo máis que un HTTP 2xx (timeout, 5xx, conexión rexeitada), nós soamos segundo un backoff exponencial.

Se queres reanudar manualmente un evento fallido, o panel de control webhook ofrece un botón Re-deliver en cada entrega fallida dispoñible durante 7 días despois do fallo definitivo.

Teste sen enviar un envelope real

O punto final `/v1/webhooks/test` acepta unha URL e un tipo de evento, e POSTe unha carga útil ficticia asinada exactamente como a verdadeira.

# Trigger a test webhook to your endpoint
curl -X POST https://api.certyneo.com/v1/webhooks/test \
  -H "Authorization: Bearer $CERTYNEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event": "envelope.completed", "url": "https://your.app/webhooks/certyneo"}'

Para ir máis lonxe

• Hub desenvolvedor
• API de sinatura electrónica
• Integracións nativas
• Páxina de seguridade
• Planes e tarifas