Webhooks

Webhooks

इस पृष्ठ का अनुवाद AI उपकरणों का उपयोग करके किया गया है और इसमें त्रुटियाँ हो सकती हैं। सबसे सटीक और नवीनतम जानकारी के लिए, कृपया मूल अंग्रेजी संस्करण देखें।

Webhooks तृतीय-पक्ष एप्लिकेशन को Zoho Projects से स्वचालित HTTP सूचनाएँ भेजना आसान बनाते हैं। Zoho ProjectsWebhooks का उपयोग करके आप अपने HTTP URL को कॉन्फ़िगर कर सकते हैं और उन्हें विशिष्ट व्यावसायिक नियमों से जोड़ सकते हैं ताकि समस्याओं से संबंधित पूरी सूचना प्रक्रिया को स्वचालित किया जा सके। Webhooks के बारे में अधिक जानने के लिए, कृपया WebHooks.org।

उपलब्धता: नवीनतम उपयोगकर्ता-आधारित Enterprise प्लान

Webhooks को कॉन्फ़िगर करें

  1. क्लिक करें शीर्ष नेविगेशन पैनल में।
  2. नेविगेट करें Issue Tracker > Webhooks।
  3. क्लिक करें Add Webhook।
  4. Webhooks पृष्ठ पर सभी आवश्यक पैरामीटर निर्दिष्ट करें।
  5. क्लिक करें Save।

Webhook कॉन्फ़िगरेशन में फ़ील्ड की सूची

फ़ील्ड का नाम
 विवरण
 डेटा प्रकार
 बाधा
नाम

Webhook का नाम निर्दिष्ट करें।

टेक्स्ट

100 वर्ण
सूचित करने के लिए URL

तृतीय-पक्ष एप्लिकेशन का REST API URL निर्दिष्ट करें।

 URL
 1000 वर्ण
विधि

API विधि का प्रकार चुनें - POST या GET। डिफ़ॉल्ट रूप से POST विधि का चयन किया जाता है।

 रेडियो बटन
 -
समस्या पैरामीटर जोड़ें
  • पैरामीटर को दो तरीकों से जोड़ें - या तो मानक प्रारूप का उपयोग करके या उपयोगकर्ता द्वारा परिभाषित प्रारूप (xml, json, आदि) का उपयोग करके।
  • निर्दिष्ट करें पैरामीटर का नाम। और संबंधित समस्या फ़ील्ड से चुना गया पैरामीटर मान।
  • ये पैरामीटर webhook को तृतीय-पक्ष को ट्रिगर करने में महत्वपूर्ण हैं।
 टेक्स्ट
 3000 वर्ण
कस्टम पैरामीटर जोड़ें
  • Webhook के लिए पैरामीटर का नाम और संबंधित मान निर्दिष्ट करें।
  • यह key/value जोड़ी मुख्य रूप से Auth tokens, API key आदि भेजने के लिए उपयोग की जाती है।
 टेक्स्ट
 3000 वर्ण
URL का पूर्वावलोकन करें

तृतीय-पक्ष एप्लिकेशन को सूचित करने के लिए पूरे webhook URL का पूर्वावलोकन करें।

 केवल पढ़ने के लिए
 केवल पढ़ने के लिए

Webhooks को व्यावसायिक नियम से जोड़ें

  1. Business Rulesमें नेविगेट करें Rule details -> Criteria -> Actions।
  2. Actionsमें क्लिक करें Call Webhooks।
  3. क्लिक करें एक नया Webhook बनाने के लिए या क्लिक करें व्यावसायिक नियम के लिए किसी मौजूदा Webhook को कॉल करने के लिए।

  4. क्लिक करें Save Rule।

Learn More व्यावसायिक नियमों को कॉन्फ़िगर करने के बारे में।

Test Webhook Integration

  1. अपने व्यावसायिक नियम मानदंड के अनुसार Zoho Projects में परीक्षण डेटा जोड़ें।
  2. अपने अनुप्रयोग में Webhook सूचना के माध्यम से Zoho Projects से प्राप्त अपडेट / डेटा के लिए जांचें।
  3. यदि कोई त्रुटि या डेटा विसंगति है, तो Zoho Projects में अपनी Webhook सेटिंग को संशोधित करें।
  4. Zoho Projects से अपने अनुप्रयोग को वांछित परिणाम मिलने तक परीक्षण जारी रखें।

Webhooks दोनों का समर्थन करता है Issue related Parameters (Issue title, Status, Assignee आदि) और Custom Parameters।

Known Limitations

  • केवल 10 Issue related parameters और 5 Custom parameters प्रति Webhook की अनुमति है।
  • उपयोगकर्ता द्वारा परिभाषित प्रारूप (xml, json आदि) में एक Issue related parameter की अनुमति है।
    • उपयोगकर्ता द्वारा परिभाषित प्रारूप में Issue related parameter का नमूना: <issue-data><title>${Issue.IssueTitle}</title><key>${Issue.IssueKey}</key></issue-data>
  • Webhook केवल व्यावसायिक नियम के माध्यम से ट्रिगर होता है, अर्थात् जब व्यावसायिक नियम निष्पादित होता है, तो संबंधित Webhook को कॉल किया जाता है।
  • केवल एक Webhook को व्यावसायिक नियम से संबंधित किया जाता है जबकि कई व्यावसायिक नियम एक ही Webhook से मैप किए जाते हैं।
  • प्रति दिन केवल 1000 Webhook कॉल की अनुमति है।
  • विफल Webhook निष्पादन को पुनः प्रयास नहीं किया जाता है।
  • जब Webhook कॉल 10 प्रयासों के लिए लगातार विफल होता है, तो Webhook निष्क्रिय कर दिया जाता है।
  • यदि दिन के लिए Webhook कॉल की सीमा पहुंच गई है या यदि Webhook को लगातार विफलता के कारण अक्षम किया गया है, तो कोई मेल सूचना नहीं भेजी जाती है।
  • Webhook विफलताओं का ऑडिट किया जाता है और Webhook Failures पृष्ठ केवल अंतिम 100 विफलताएँ।


Error Codes

जब Webhook का निष्पादन विफल होता है, तो निम्नलिखित में से एक त्रुटि संदेश Zoho Projects में प्रदर्शित होता है:

HTTP Status Codes

  • 400 Bad Request - अक्सर आवश्यक पैरामीटर गायब होता है।
  • 401 Unauthorized - कोई वैध Auth Token नहीं।
  • 402 Request Failed - पैरामीटर मान्य थे लेकिन अनुरोध विफल हुआ।
  • 404 Not Found - अनुरोधित आइटम मौजूद नहीं है।
  • 500, 502, 503, 504 Server errors - तीसरे पक्ष के अनुप्रयोग पर कुछ गलत हुआ।
  • Error Code 1 - API सर्वर से अस्थायी रूप से कनेक्ट करने में सक्षम नहीं। आपको Zoho Projects से भेजे गए अनुरोधों के लिए API सर्वर लॉग और फायरवॉल सेटिंग की जांच करनी होगी।

Custom Errors

  • Internal process failure - जब Webhook को प्रक्रिया करते समय त्रुटियों के कारण निष्पादित नहीं किया जाता है।
  • Day limit reached - जब कंपनी दिन के लिए अधिकतम सीमा तक पहुंचती है।

Business Scenario

प्रोजेक्ट मालिकों को SMS अलर्ट भेजें।

Purpose

जब किसी समस्या को Show Stopper के रूप में आपके Issue Tracker में चिह्नित किया जाता है, तो आप व्यावसायिक नियम से Webhook को संबंधित करके प्रोजेक्ट मालिक को समस्या शीर्षक के साथ एक SMS भेज सकते हैं।

Pre-requisite

  • SMS gateway service में खाता
  • Business Rules & Webhooks तक पहुंचने की अनुमति

Procedure

  • SMS gateway service में खाता बनाएं
  • Zoho Issue Tracker में Webhook को कॉन्फ़िगर करें
  • Business Rule सेट करें
  • अपने Webhook इंटीग्रेशन का परीक्षण करें

 Step 1: SMS Gateway में खाता बनाएं

अपनी SMS gateway service में खाता बनाएं और Webhook को कॉन्फ़िगर करने के लिए निम्नलिखित विवरण प्राप्त करें:

  • API URL
  • Username
  • Password
  • API Id 

वर्तमान में Zoho ने निम्नलिखित SMS Gateway प्रदाताओं के साथ भागीदारी की है:

  1. Bulk SMS
  2. Clickatell
  3. Screen Magic
  4. Valueleaf
  5. Solutions Infini

आप उपरोक्त विक्रेताओं से SMS क्रेडिट और API विवरण खरीद सकते हैं।

 चरण 2: Webhook को कॉन्फ़िगर करें

Webhooks पृष्ठ में निम्नलिखित विवरण निर्दिष्ट करें:

सूचित करने के लिए URL:

  1. http://<IP Address>/smsgateway/post - POST विधि 

उपयोगकर्ता द्वारा परिभाषित प्रारूप में पैरामीटर:

पैरामीटर का नाम - पाठ

पैरामीटर का मान -

नमस्ते ${Issue.ProjectOwner},

निम्नलिखित समस्या ${Issue.Severity} के रूप में चिह्नित की गई है।

${Issue.IssueKey} - ${Issue.IssueTitle}

${Issue.DueDate} तक देय

कस्टम पैरामीटर (नाम = मान):

user = <gateway_user_name>

password = <api_password>

api_id = <gateway_unique_api_id>

to = <user_mobile_number>


उपरोक्त उपयोगकर्ता-परिभाषित और कस्टम पैरामीटर में, हमने प्रदर्शन उद्देश्य के लिए Clickatell gateway का उपयोग किया है।

 चरण 3: एक व्यावसायिक नियम सेट अप करें

निम्नलिखित विशिष्टताओं के साथ एक व्यावसायिक नियम बनाएँ:

  1. Business Rule का नाम - Show Stopper
  2. Execute on - Field Update - Severity
  3. Criteria: Severity Showstopper है और Status Closed नहीं है
  4. कार्रवाई :
    • Reproducible - Always
    • निर्दिष्ट करना - Developer
    • Webhook को कॉल करें - पिछले चरण में बनाई गई webhook को चुनें
  5. Business rule को सहेजें। और जानें Business rule बनाने के बारे में।

 चरण 4: इंटीग्रेशन का परीक्षण करें

प्रोजेक्ट में एक परीक्षण समस्या जोड़ें और इसे एक developer को निर्दिष्ट करें। साथ ही, Severity को Show Stopper में बदलें। यह उपरोक्त नियम से जुड़ी webhook को ट्रिगर करेगा और प्रोजेक्ट owner को Issue title, Severity, और Due date के साथ एक SMS सतर्कता प्राप्त होगी।

यह भी देखें