Belgelere geç
API

Webhook teslimleri ve etkinlik

Her teslim denemesi ve bir uç noktadaki her değişiklik, konsolun süzdüğü şekilde süzülür.

GETapi.openemail.uk/webhooks/deliveries

Bu sayfadaki 6 çağrının herhangi birini kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

Teslimler

GET /webhooks/{id}/deliveries tek bir uç noktanın teslim günlüğünü, GET /webhooks/deliveries ise isteğe bağlı olarak endpointIds ile daraltılmış biçimde tüm uç noktalarınkini birden okur. İkisi de status (failed konsolun «yalnızca başarısız» anahtarıdır), since ve until alır, limit ve cursor ile sayfalanır ve her sayfa aynı filtreleri gönderdiği sürece imleci her filtrede geçerli tutar. Her satır kendi endpointId değerini taşır. Hiçbir şey budanmaz.

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

Birini okumak ve yeniden göndermek

GET /webhooks/{id}/deliveries/{deliveryId} gönderilen gövdeyi, alıcının yanıtını ve olayın her denemesini döndürür, POST …/replay ise o olayı birer birer yeniden gönderir. Gövde olayın ilgili olduğu adresleri adlandırdığından, bazı adreslere daraltılmış bir anahtar bir teslimi yalnızca kendi izin listeleri anahtarınkilerin içinde kalan bir uç noktada açabilir ve tek bir adrese sahip olmak asla alan adının tamamını kapsamaz. OAuth üzerinden birini yalnızca çalışma alanının sahibi açabilir veya yeniden gönderebilir; konsolun uyguladığı kuralın aynısı.

Etkinlik

GET /webhooks/activity ve GET /webhooks/{id}/activity denetim günlüğünü okur: created, updated, enabled, disabled, auto_disabled, secret_rotated, tested, replayed ve removed. actor bunu kimin yaptığını adlandırır; bir kişiyi @username, bir anahtarı API key <name> olarak; OpenEmail bunu kendiliğinden yaptığında null olur. endpointIds, since ve until onu daraltır ve kaldırılmış bir uç nokta geçmişini korur.