इवेंट
Webhooks कनेक्ट करें
- Foliant में, सेटिंग्स › इंटीग्रेशन पर जाएँ।
- Webhooks पर, कनेक्ट करें पर क्लिक करें।
-
सेटिंग्स भरें:
- कनेक्ट करें पर क्लिक करें।
हर अनुरोध में क्या होता है
Foliant JSON body के साथ एकPOST अनुरोध भेजता है:
document.generated डेटा
template: टेम्पलेट काuuidऔरname।document_type:invoice,credit_note,quote, या दूसरे दस्तावेज़ों के लिए खाली।order: उसकाid,nameऔरtype(ऑर्डर या ड्राफ़्ट ऑर्डर)।refund_idऔरfulfillment_id, जब दस्तावेज़ किसी रिफ़ंड या शिपमेंट के लिए हो।document_numberऔरissued_at, नंबर वाले दस्तावेज़ों के लिए।source: दस्तावेज़ कैसे बना, जैसेdownload,admin_download,exportयाemail।export: एक्सपोर्ट की ID, जब दस्तावेज़ किसी एक्सपोर्ट का हिस्सा हो।generated_at।
export.completed डेटा
export: उसकाuuid,order_type,template_uuids,ordersकी संख्या,orders_skipped(चुने जाने के बाद डिलीट किए गए) औरdocuments,requested_by(merchantयाcustomer) औरcompleted_at।download_url: एक्सपोर्ट डाउनलोड करने का लिंक, औरdownload_url_expires_at, यानी वह लिंक कब काम करना बंद करेगा।download_expires_at: एक्सपोर्ट खुद कब एक्सपायर होगा।
हेडर
सिग्नेचर जाँचें
सिग्नेचर timestamp, एक पूर्ण विराम (full stop) और raw request body (<timestamp>.<body>) का hex HMAC-SHA256 है, जिसमें आपका signing secret key के रूप में इस्तेमाल होता है। इसे अपनी तरफ़ से कंप्यूट करें और X-Foliant-Signature में sha256= के बाद वाली वैल्यू से मिलाएँ। raw body ठीक वैसे ही इस्तेमाल करें, जैसी आपको मिली है।
रिस्पॉन्स और दोबारा कोशिश
- कोई भी 2xx रिस्पॉन्स डिलीवर माना जाता है।
- अगर आपका endpoint 5xx एरर, 408 या 429 लौटाता है, या 10 सेकंड में जवाब नहीं देता, तो Foliant बाद में फिर से कोशिश करता है। हर बार वह थोड़ा ज़्यादा इंतज़ार करता है, अधिकतम 5 कोशिशों तक।
- दूसरे 4xx रिस्पॉन्स अंतिम होते हैं: Foliant उन पर दोबारा कोशिश नहीं करता।
- हर इवेंट प्रति दस्तावेज़ या एक्सपोर्ट एक बार डिलीवर होता है। सफल होने के बाद दोबारा कोशिश उसे कभी दो बार नहीं भेजती।