अवलोकन
GET /jobs/{id} को बार-बार पोल करने के बजाय, आप एक वेबहुक URL प्रदान कर सकते हैं ताकि जब आपका जॉब पूरा हो जाए तो एक POST अनुरोध प्राप्त हो सके। यह अधिक कुशल है और अनावश्यक API कॉल्स को कम करता है।
वेबहुक का उपयोग
किसी भी जनरेशन अनुरोध मेंX-Webhook-URL हेडर जोड़ें। जब जॉब टर्मिनल स्टेट (completed, failed, या cancelled) तक पहुँचता है, तो API आपके URL पर पूरे जॉब डेटा के साथ एक POST अनुरोध भेजेगा।
वेबहुक पेलोड
जब जॉब पूरा हो जाता है, तो आपके वेबहुक URL को जॉब डेटा के साथ एक POST अनुरोध प्राप्त होता है:सर्वोत्तम प्रथाएँ
तुरंत प्रतिक्रिया दें - तेज़ी से 2xx स्टेटस कोड लौटाएँ। यदि आवश्यक हो तो वेबहुक डेटा को एसिंक्रोनस रूप से प्रोसेस करें।
- सुरक्षा के लिए HTTPS एंडपॉइंट्स का उपयोग करें
- डुप्लिकेट डिलीवरी के मामले में आइडेम्पोटेंसी लागू करें
- डिबगिंग के लिए वेबहुक रसीदों को लॉग करें
वेबहुक बनाम पोलिंग
जब आपके पास ऐसा सर्वर हो जो HTTP अनुरोध प्राप्त कर सके तो वेबहुक का उपयोग करें। क्लाइंट-साइड एप्लिकेशन के लिए या जब आप कोई सार्वजनिक एंडपॉइंट उजागर नहीं कर सकते तो पोलिंग का उपयोग करें।
अगले चरण
जॉब लाइफ़साइकिल
जॉब स्टेट्स और स्टेटस पोलिंग के बारे में जानें
कोड उदाहरण
वेबहुक हैंडलिंग के साथ पूर्ण उदाहरण देखें