پرش به مستندات
API

تحویل‌ها و فعالیت وب‌هوک

هر تلاش تحویل و هر تغییر در یک نقطهٔ پایانی، با همان فیلترهایی که کنسول دارد.

GETapi.openemail.uk/webhooks/deliveries

هر کدام از 6 فراخوانی این صفحه را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

تحویل‌ها

GET /webhooks/{id}/deliveries گزارش تحویل یک نقطهٔ پایانی را می‌خواند و GET /webhooks/deliveries گزارش همه را یکجا، که در صورت نیاز با endpointIds محدود می‌شود. هر دو status (failed همان کلید «فقط ناموفق‌ها» در کنسول است)، since و until را می‌پذیرند، با limit و cursor صفحه‌بندی می‌شوند و تا وقتی هر صفحه همان فیلترها را بفرستد مکان‌نما را زیر هر فیلتری معتبر نگه می‌دارند. هر ردیف 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"}

خواندن و دوباره فرستادن یک تحویل

GET /webhooks/{id}/deliveries/{deliveryId} بدنه‌ای را که فرستاده شد، پاسخ گیرنده و هر تلاش رویداد را برمی‌گرداند و POST …/replay آن رویداد را دوباره می‌فرستد، هر بار یکی. بدنه نشانی‌هایی را نام می‌برد که رویداد دربارهٔ آن‌هاست، پس کلیدی که به برخی نشانی‌ها محدود شده فقط در نقطهٔ پایانی‌ای می‌تواند تحویلی را باز کند که فهرست‌های مجاز خودش درون فهرست‌های کلید باشد، و داشتن یک نشانی هرگز کل دامنه‌اش را پوشش نمی‌دهد. از راه OAuth فقط مالک فضای کاری می‌تواند تحویلی را باز کند یا دوباره بفرستد؛ همان قاعده‌ای که کنسول اعمال می‌کند.

فعالیت

GET /webhooks/activity و GET /webhooks/{id}/activity گزارش حسابرسی را می‌خوانند: created، updated، enabled، disabled، auto_disabled، secret_rotated، tested، replayed و removed. actor نام می‌برد چه کسی آن را انجام داد، شخص به‌صورت @username و کلید به‌صورت API key <name>، و وقتی OpenEmail خودش آن را انجام داده null است. endpointIds، since و until آن را محدود می‌کنند و نقطهٔ پایانی حذف‌شده تاریخچه‌اش را نگه می‌دارد.