Zur Dokumentation springen
API

Webhook-Ereignisse und Statistiken

Die Ereignisse, die ein Endpunkt abonnieren kann, und wie die Zustellungen gelaufen sind.

GET/webhooks/events

Führt jeden der 2 Aufrufe in Ihrem Workspace aus.

Ereignisse

GET /webhooks/events listet jedes Ereignis, das ein Endpunkt in eventTypes nennen kann, jeweils mit einem Satz dazu, wann es ausgelöst wird, und die Grenzen, die für einen Endpunkt gelten: maxEndpoints für den Workspace, das sein Tarif festlegt, und maxAddresses und maxDomains für eine Allowlist. Es braucht webhooks:read.

GET /webhooks/events
{  "object": "webhook_catalogue",  "events": [    { "id": "email.sent", "label": "A message left OpenEmail." },    { "id": "email.bounced", "label": "A message bounced." }  ],  "maxEndpoints": 10,  "maxAddresses": 50,  "maxDomains": 20}

Ein Endpunkt, der keine Ereignisse nennt, empfängt jedes E-Mail-Ereignis außer email.replied. email.replied und die anderen Familien erreichen also nur einen Endpunkt, der sie namentlich anfordert.

Statistiken

GET /webhooks/stats liest, wie die Zustellungen in einem Zeitraum gelaufen sind, also die Zahlen im Tab „Analysen“ der Seite „Webhooks“: Versuche, Zustellungen und Fehlschläge, die mittlere Zeit, die ein Empfänger zum Antworten brauchte, eine Zeitreihe in Intervallen, die gesendeten Ereignisse und die empfangenen Antwortcodes. Es braucht webhooks:read. endpointIds grenzt es auf bestimmte Endpunkte ein, since und until legen den Zeitraum fest, standardmäßig 30 Tage, und grain und offsetMinutes bestimmen die Einteilung der Zeitreihe. Jeder Versuch eines Ereignisses zählt als ein Zustellversuch.

GET /webhooks/stats?grain=day
{  "object": "webhook_stats",  "since": "2026-09-02T00:00:00.000Z",  "until": "2026-10-02T00:00:00.000Z",  "grain": "day",  "endpointIds": [],  "totals": { "attempts": 1280, "delivered": 1266, "failed": 14, "medianDurationMs": 212 },  "buckets": [{ "bucket": "2026-09-28", "delivered": 44, "failed": 1 }],  "events": [{ "id": "email.delivered", "count": 702 }],  "codes": [{ "id": "200", "count": 1266 }, { "id": "503", "count": 14 }]}

Referenz