ドキュメント本文へスキップ
API

Webhook の配信とアクティビティ

すべての配信試行とエンドポイントへのすべての変更を、コンソールと同じ条件で絞り込む。

GETapi.openemail.uk/webhooks/deliveries

このページの6件の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

配信

GET /webhooks/{id}/deliveries は 1 つのエンドポイントの配信ログを、GET /webhooks/deliveries はすべてのエンドポイントの配信ログを一度に読み、endpointIds で絞り込むこともできる。どちらも status(failed はコンソールの「失敗のみ」スイッチ)、sinceuntil を受け取り、limitcursor でページを送り、各ページが同じフィルターを送る限りどのフィルターでもカーソルは有効なままである。各行には endpointId が付く。何も削除されない。

GET /webhooks/deliveries?status=failed&since=2026-09-22T00:00:00Z
{  "object": "list",  "data": [    { "object": "webhook_delivery", "id": "whd_8c1e4a7f2b9d3e6a0c5f1b28", "endpointId": "whe_3f9c2a7b1e4d8f60a5c7b92d", "eventType": "email.bounced", "status": "failed", "responseCode": 503, "attempt": 2, "maxAttempts": 8, "nextAttemptAt": "2026-09-23T10:35:00.000Z" }  ],  "hasMore": true,  "nextCursor": "whd_8c1e4a7f2b9d3e6a0c5f1b28"}

1 件を読んで再送する

GET /webhooks/{id}/deliveries/{deliveryId} は送信した本文、受信側の応答、イベントのすべての試行を返し、POST …/replay はそのイベントを 1 件ずつ再送する。本文にはイベントの対象アドレスが含まれるため、一部のアドレスに絞り込まれたキーが配信を開けるのは、自身の許可リストがキーのリストの内側に収まるエンドポイントだけで、1 アドレスを持っていてもそのドメイン全体を持つことにはならない。OAuth 経由で配信を開いたり再送したりできるのはワークスペースの所有者だけで、コンソールと同じ規則である。

アクティビティ

GET /webhooks/activityGET /webhooks/{id}/activity は監査ログを読む: created、updated、enabled、disabled、auto_disabled、secret_rotated、tested、replayed、removed。actor は実行者を示し、人は @username、キーは API key <name> として表し、OpenEmail が自ら行った場合は null になる。endpointIdssinceuntil で絞り込め、削除されたエンドポイントも履歴を保つ。