दस्तावेज़ पर जाएँ
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> के रूप में, और जब OpenEmail ने ख़ुद किया हो तो यह null होता है। endpointIds, since और until इसे सीमित करते हैं, और हटाया गया एंडपॉइंट अपना इतिहास रखता है।