Перейти к документации
API

Доставки и активность вебхуков

Каждая попытка доставки и каждое изменение эндпоинта, с теми же фильтрами, что в консоли.

GETapi.openemail.uk/webhooks/deliveries

Выполняет любой из 6 запросов на этой странице в вашем рабочем пространстве, с вашим собственным ключом.

Доставки

GET /webhooks/{id}/deliveries читает журнал доставок одного эндпоинта, а GET /webhooks/deliveries всех сразу, при желании сужая по endpointIds. Оба принимают status (failed это переключатель «только неудачные» в консоли), 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 сужают его, а удалённый эндпоинт сохраняет историю.