Перейти к документации
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 }]}

Справочник