Belgelere geç
API

Webhook olayları ve istatistikleri

Bir uç noktanın abone olabileceği olaylar ve teslimlerin nasıl gittiği.

GET/webhooks/events

2 çağrıdan herhangi birini çalışma alanınızda çalıştırır.

Olaylar

GET /webhooks/events, bir uç noktanın eventTypes içinde adlandırabileceği her olayı, her birinin ne zaman tetiklendiğini söyleyen bir cümleyle birlikte, ve bir uç noktanın tabi olduğu sınırları listeler: çalışma alanı için planının belirlediği maxEndpoints, tek bir izin listesi için ise maxAddresses ve maxDomains. webhooks:read gerektirir.

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}

Hiçbir olay adlandırmayan bir uç nokta, email.replied dışındaki her e-posta olayını alır; bu yüzden email.replied ve diğer aileler yalnızca onları adıyla isteyen bir uç noktaya ulaşır.

İstatistikler

GET /webhooks/stats, teslimlerin bir aralıkta nasıl gittiğini okur; Webhook'lar sayfasının Analizler sekmesidir: denemeler, teslim edilenler ve başarısız olanlar, bir alıcının yanıt vermesinin ortanca süresi, dilimlerden oluşan bir seri, gönderilen olaylar ve alınan yanıt kodları. webhooks:read gerektirir. endpointIds onu bazı uç noktalara daraltır, since ve until aralığı belirler (varsayılanı 30 gündür), grain ve offsetMinutes ise seriyi biçimlendirir. Bir olayın her denenişi bir deneme sayılır.

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

Referans