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

أحداث خطافات الويب وإحصاءاتها

الأحداث التي يمكن لنقطة نهاية الاشتراك فيها، وكيف سارت التسليمات.

GET/webhooks/events

ينفّذ أيًّا من الاستدعاءات الـ2 على مساحة عملك.

الأحداث

يسرد GET /webhooks/events كل حدث يمكن لنقطة نهاية أن تسمّيه في eventTypes، مع جملة لكل منها تقول متى يُطلَق، والحدود المفروضة على نقطة النهاية: maxEndpoints لمساحة العمل، وتحدده خطتها، وmaxAddresses وmaxDomains لقائمة سماح واحدة. يتطلب 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}

نقطة النهاية التي لا تسمّي أي حدث تستقبل كل أحداث البريد عدا email.replied، لذا لا تصل email.replied والعائلات الأخرى إلا إلى نقطة نهاية تطلبها بالاسم.

الإحصاءات

يقرأ GET /webhooks/stats كيف سارت التسليمات خلال فترة، وهو تبويب التحليلات في صفحة خطافات الويب: المحاولات، والمُسلَّمة والفاشلة، والوقت الوسيط الذي استغرقه المستقبِل ليجيب، وسلسلة من الفترات، والأحداث المرسلة، ورموز الاستجابة المستلمة. يتطلب webhooks:read. ويضيّقه endpointIds إلى بعض نقاط النهاية، ويحدد since وuntil الفترة، وهي 30 يومًا افتراضيًا، ويشكّل grain وoffsetMinutes السلسلة. وكل مرة يُجرَّب فيها حدث تُعدّ محاولة واحدة.

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 }]}

المرجع