پرش به مستندات
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 }]}

مرجع