घटनाएँ और वेबहुक
वेबहुक कनेक्ट करना
अपनी एकीकरण सेटिंग में वेबहुक प्राप्त करने का पता निर्दिष्ट करें। यह नए पत्रों, मेलबॉक्सों की स्थिति और संचालन के परिणामों के बारे में सूचनाएं प्राप्त करेगा।
एकीकरण सेटिंग्स में, एक अलग वेबहुक रहस्य सेट करें और डिलीवरी सक्षम करें। इस रहस्य का उपयोग अधिसूचना हस्ताक्षरों को सत्यापित करने के लिए किया जाता है; मेल API-key इसके लिए उपयुक्त नहीं है।
अधिसूचना प्रारूप
अधिसूचना HTTP POST- अनुरोध के साथ Content-Type: application/json. फ़ील्ड event में इवेंट प्रकार, timestamp - अधिसूचना समय, data - इवेंट डेटा आता है। data की संरचना घटना पर निर्भर करती है।
पहचानकर्ता data.event_id आपको पुनः डिलीवरी को पहचानने की अनुमति देता है। इसे अपनी एकीकरण आईडी के साथ संग्रहीत करें और एक ईवेंट को केवल एक बार संसाधित करें।
{ "event": "mail.message.received", "timestamp": "2026-11-01T12:00:00Z", "data": { "event_id": "00000000-0000-4000-8000-000000000001", "created_at": "2026-11-01T12:00:00Z", "mailbox_id": 42, "folder": "INBOX", "uidvalidity": 123456, "uid": 120 }}सत्यापन एवं पुष्टि
हेडर X-Webhook-Signature में लोअरकेस हेक्साडेसिमल नोटेशन में HMAC-SHA256 शामिल है। अनुरोध निकाय के मूल बाइट्स और वेबहुक रहस्य से हस्ताक्षर की गणना करें। डेटा संसाधित करने से पहले हस्ताक्षर की जाँच करें; JSON को पुनः क्रमबद्ध करने से हस्ताक्षरित बाइट्स बदल जाएंगे।
हस्ताक्षर सत्यापित करने और ईवेंट सहेजने के बाद, HTTP 200 या 201 लौटाएँ। प्रतिक्रियाएँ 202 और 204 रसीद स्वीकार नहीं करते हैं। 10 सेकंड के भीतर उत्तर दें; ईवेंट सहेजने के बाद लंबी प्रोसेसिंग करें.
सूचनाएं बार-बार आ सकती हैं और क्रम से बाहर हो सकती हैं। सदस्यता स्थिति बदलने से पहले, उसके वर्तमान विवरण की जाँच करें। डिलीवरी इतिहास एकीकरण सेटिंग्स में उपलब्ध है।
क्या घटनाएँ घटित होती हैं
mailbox.created- बॉक्स बन गया है और उपयोग के लिए तैयार है।
mailbox.expiring- बॉक्स के लिए भुगतान अवधि की समाप्ति निकट आ रही है।
mailbox.renewed- बॉक्स के लिए भुगतान की अवधि बढ़ा दी गई है।
mailbox.suspended- मेलबॉक्स तक पहुंच निलंबित है: पढ़ना और भेजना अनुपलब्ध है।
mailbox.resumed- मेलबॉक्स तक पहुंच बहाल कर दी गई है.
mailbox.deleting_soon- अवैतनिक बॉक्स हटाए जाने में एक घंटा शेष है।
mailbox.deleted- बॉक्स हटा दिया गया है.
mailbox.account_changed- मेलबॉक्स दूसरे मेल खाते से जुड़ा हुआ है।
mail.message.received- मेलबॉक्स में एक नया आवक पत्र सामने आया है।
mail.operation.succeeded- ऑपरेशन सफलतापूर्वक पूरा हुआ. भेजने के लिए, इसका मतलब प्राप्तकर्ता के इनबॉक्स में डिलीवरी के बजाय मेल सर्वर द्वारा पत्र की स्वीकृति है।
mail.operation.failed- ऑपरेशन विफल रहा.
mail.operation.uncertain- भेजने का परिणाम अज्ञात है. कृपया पुनः भेजने से पहले स्थिति की जांच कर लें।
भुगतान अनुस्मारक: 14, 7, 3, 2, 1 दिन और समाप्ति से एक घंटा पहले। नवीनीकरण उन पुराने अनुस्मारक को रद्द कर देता है जिन्हें अभी तक नहीं भेजा गया है।