Webhooks

Webhooks की मदद से आप Meshy से रियल-टाइम अपडेट प्राप्त कर सकते हैं, जब आपके API टास्क पूरे होते हैं या उनकी स्थिति बदलती है। एक बार कॉन्फ़िगर हो जाने पर, Meshy आपके द्वारा निर्दिष्ट URL पर json फॉर्मेट में इवेंट पेलोड POST करेगा।

Why Create Webhooks

Webhooks का उपयोग करने के कई फायदे हैं, विशेष रूप से API टास्क स्टेटस की स्वचालित रूप से जाँच करने के संदर्भ में। Webhooks के लिए, API को लगातार पोल करके टास्क स्टेटस अपडेट प्राप्त करने की तुलना में कम मेहनत और लागत की आवश्यकता होती है। Webhooks लगभग रियल-टाइम अपडेट भी प्रदान करते हैं और अंततः API पोलिंग की तुलना में बेहतर स्केल करते हैं। इससे आपको अपनी रेट लिमिट को बेहतर तरीके से मैनेज करने में भी मदद मिलती है, खासकर यदि आप लगातार पोलिंग कर रहे हों।

Setup & Configuration

Webhooks को सक्षम करने के लिए, Developer Platform में Webhooks पेज खोलें और "Create Webhook" बटन पर क्लिक करें। जिस https URL पर आप webhooks प्राप्त करना चाहते हैं उसे प्रदान करें और Meshy से स्वचालित रूप से टास्क अपडेट प्राप्त करने के लिए webhook को सक्षम करें। आपके पास प्रति Meshy अकाउंट अधिकतम 5 सक्रिय webhooks हो सकते हैं। जब कोई webhook सक्षम किया जाता है, तो सभी API टास्क स्टेटस अपडेट स्वचालित रूप से पेलोड URL पर भेजे जाएंगे। सुरक्षा कारणों से, हम फिलहाल केवल https URL पर webhooks भेजने की अनुमति देते हैं। यदि आप लोकल टेस्टिंग कॉन्फ़िगर करना चाहते हैं, तो निम्नलिखित सेक्शन देखें।

Webhook Delivery Requirements

आपके webhook को सामान्य रूप से काम करने और इवेंट प्राप्त करना जारी रखने के लिए:

आपके सर्वर को 400 से कम HTTP स्टेटस कोड के साथ प्रतिक्रिया देनी चाहिए (जैसे, 200 OK, 202 Accepted)।
>= 400 स्टेटस कोड वाली किसी भी प्रतिक्रिया को विफल डिलीवरी के रूप में माना जाएगा।
लगातार कई विफलताएं:
- progress अपडेट को देरी से या गलत क्रम में पहुंचा सकती हैं
- बार-बार प्रयासों के बाद आपके webhook को स्वचालित रूप से अक्षम कर सकती हैं (Auto-Disable Policy देखें)

टिप: webhook पेलोड को वेरिफाई और संग्रहीत करने के बाद हमेशा एक सफल प्रतिक्रिया लौटाएं, भले ही आगे की प्रोसेसिंग असिंक्रोनस रूप से हो रही हो।

यदि किसी टास्क का अंतिम इवेंट उसके सामान्य समय से लगभग दोगुने समय के बाद भी नहीं आया है, तो उसके GET एंडपॉइंट के साथ टास्क को फ़ेच करें। सामान्य समय और कितनी देर प्रतीक्षा करनी है, इसके लिए Task Lifecycle देखें।

Forwarding Webhooks for Local Testing

यदि आप अपने webhook कोड को लोकल रूप से टेस्ट करना चाहते हैं, जो आमतौर पर http एड्रेस पर होता है, तो आप webhooks को अपने कंप्यूटर या codespace पर फॉरवर्ड करने के लिए एक वेबहुक प्रॉक्सी URL का उपयोग कर सकते हैं। नीचे smee.io का उपयोग करके अनुशंसित चरण दिए गए हैं, लेकिन आप वेबहुक प्रॉक्सी URL जनरेट करने के लिए किसी भी सेवा का उपयोग कर सकते हैं।

वेबहुक प्रॉक्सी URL प्राप्त करें:

अपने ब्राउज़र में, https://smee.io/ पर जाएं
"Start a new channel" पर क्लिक करें
"Webhook Proxy URL" के तहत पूरा URL कॉपी करें। आप इस URL का उपयोग निम्नलिखित सेटअप चरणों में करेंगे।

Webhooks फॉरवर्ड करें:

यदि आपके पास पहले से smee-client इंस्टॉल नहीं है, तो अपने टर्मिनल में निम्न कमांड चलाएं।

npm install --global smee-client

smee.io से फॉरवर्ड किए गए webhooks प्राप्त करने के लिए, अपने टर्मिनल में निम्न कमांड चलाएं। WEBHOOK_PROXY_URL को पहले प्राप्त अपने वेबहुक प्रॉक्सी URL से बदलें।

smee --url WEBHOOK_PROXY_URL --path /webhook --port 3000

आपको इस तरह का आउटपुट दिखाई देना चाहिए, जहां WEBHOOK_PROXY_URL आपका वेबहुक प्रॉक्सी URL है:

Forwarding WEBHOOK_PROXY_URL to http://127.0.0.1:3000/webhook
Connected WEBHOOK_PROXY_URL

जब तक आप अपने webhook का परीक्षण कर रहे हों, इसे चलता रहने दें। जब आप webhooks को फॉरवर्ड करना बंद करना चाहें, तो Ctrl+C दबाएं।
ध्यान दें कि पाथ /webhook है और पोर्ट 3000 है। बाद में जब आप webhook डिलीवरी प्राप्त करने के लिए अपना खुद का कोड सेट अप करना चाहें, तो ये वैल्यू काम आ सकती हैं।

एक webhook बनाएं:

अब आप Webhooks पेज पर एक नया webhook बनाने के लिए वेबहुक प्रॉक्सी URL का उपयोग कर सकते हैं।

Sample Response

जब किसी टास्क की स्थिति बदलती है, तो Meshy आपके कॉन्फ़िगर किए गए URL पर एक webhook पेलोड POST करेगा। पेलोड में JSON फॉर्मेट में टास्क ऑब्जेक्ट होता है। सभी टास्क ऑब्जेक्ट प्रॉपर्टीज़ और उदाहरण पेलोड के पूर्ण विवरण के लिए, देखें: