تخطَّ إلى المستندات
API

تسليمات خطافات الويب ونشاطها

كل محاولة تسليم وكل تغيير على نقطة نهاية، مرشَّحة كما ترشّحها وحدة التحكم.

GETapi.openemail.uk/webhooks/deliveries

ينفّذ أيًّا من الاستدعاءات الـ6 في هذه الصفحة على مساحة عملك، بمفتاحك أنت.

التسليمات

يقرأ GET /webhooks/{id}/deliveries سجل التسليم لنقطة نهاية واحدة، ويقرأ GET /webhooks/deliveries سجل كل النقاط دفعة واحدة، مع إمكان التقييد بـendpointIds. كلاهما يقبل statusfailed هو مفتاح «الفاشلة فقط» في وحدة التحكم) و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>، ويكون null حين فعلت OpenEmail ذلك من تلقاء نفسها. تقيّده endpointIds وsince وuntil، وتحتفظ نقطة النهاية المُزالة بسجلّها.