ZahlenwerkDocs

Webhooks

Eigene Systeme bei neuen Berichten und Positionen automatisch benachrichtigen.

Webhooks senden bei bestimmten Ereignissen eine HTTP-Anfrage an Ihr eigenes System, etwa an ein Data Warehouse oder ein Automatisierungswerkzeug.

Einrichten dürfen Owner und Team Admins, unter EinstellungenIntegrationenWebhooksConfigure: Endpoint URL und optional Description eintragen, Add webhook.

Danach zeigt Zahlenwerk das Signaturgeheimnis (beginnt mit whsec_) einmalig an. Kopieren Sie es sofort in Ihr System.

Ereignisse

EreignisWann
report.parsedEin Bericht wurde erfolgreich ausgelesen.
report.failedDas Auslesen eines Berichts ist fehlgeschlagen.
document.extractedEin Dokument wurde ausgelesen.
position.createdEine Position wurde angelegt.

Signatur prüfen

Jede Anfrage trägt den Header:

Zahlenwerk-Signature: t=<Unix-Zeit>,v1=<Signatur>

v1 ist ein HMAC-SHA256 über "<t>.<Body>" mit dem Geheimnis Ihres Webhooks. Prüfen Sie die Signatur und verwerfen Sie Anfragen, die älter als fünf Minuten sind.

import { createHmac, timingSafeEqual } from 'node:crypto';

export function verify(header: string, body: string, secret: string) {
  const parts = Object.fromEntries(header.split(',').map((p) => p.split('=')));
  const expected = createHmac('sha256', secret).update(`${parts.t}.${body}`).digest('hex');
  const fresh = Math.abs(Date.now() / 1000 - Number(parts.t)) < 300;
  const given = Buffer.from(parts.v1 ?? '');
  return fresh && given.length === expected.length && timingSafeEqual(Buffer.from(expected), given);
}

Anforderungen

  • Nur HTTPS-Endpunkte.
  • Interne und private Adressen werden abgelehnt.

Eine allgemeine REST-API gibt es nicht. Für lesenden und schreibenden Zugriff nutzen Sie den MCP-Endpunkt.

Auf dieser Seite