API
Webhook のイベントと統計
エンドポイントが購読できるイベントと、配信の結果。
GET/webhooks/events
2件の呼び出しをワークスペースに対して実行します。
イベント
GET /webhooks/events は、エンドポイントが eventTypes に指定できるすべてのイベントを、それぞれがいつ発火するかを述べた一文とともに一覧し、あわせてエンドポイントに課される上限を返す。ワークスペースについてはプランで決まる maxEndpoints、1 つの許可リストについては maxAddresses と maxDomains である。webhooks:read が必要。
{ "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}イベントを 1 つも指定しないエンドポイントは、email.replied を除くすべてのメールイベントを受け取る。そのため、email.replied とほかのイベント群は、名前を挙げて求めたエンドポイントにしか届かない。
統計
GET /webhooks/stats は期間内の配信の結果を読む。「Webhook」ページの「分析」タブに当たり、試行、配信済みと失敗、受信側が応答するまでにかかった時間の中央値、区間ごとの系列、送信したイベント、受け取った応答コードを返す。webhooks:read が必要。endpointIds は一部のエンドポイントに絞り込み、since と until は期間を決め、既定では 30 日になる。grain と offsetMinutes は系列の形を決める。イベントの試行は 1 回ごとに 1 件の配信試行として数える。
{ "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 }]}