नेविगेशन पर जाएँ

वर्कस्पेस वेबहुक अपडेट करें

निर्दिष्ट वर्कस्पेस webhook अपडेट करें

पाथ पैरामीटर

webhook_idstringआवश्यक

वेबहुक की यूनीक ID

हेडर

xi-api-keystringवैकल्पिक

अनुरोध

This endpoint expects an object.
is_disabledbooleanआवश्यक

क्या वेबहुक को अक्षम या सक्षम करना है

namestringआवश्यक

वेबहुक का डिस्प्ले नाम (केवल दिखाने के लिए इस्तेमाल किया जाता है)।

retry_enabledboolean or nullवैकल्पिक

क्या अस्थायी विफलताओं (5xx, 429, timeout) के लिए अपने-आप रीट्राई सक्षम करना है

request_headersmap from strings to strings or nullवैकल्पिक

वेबहुक डिलीवरी में शामिल करने के लिए अनुरोध हेडर्स की सूची (वैकल्पिक)

eventslist of enums or nullवैकल्पिक

वर्कस्पेस-लेवल इवेंट्स का पूरा सेट, जिनके लिए इस वेबहुक को सब्सक्राइब किया जाना चाहिए। वेबहुक को सूची के इवेंट्स में जोड़ा जाता है और जो सूची में नहीं हैं उनसे हटाया जाता है। मौजूदा इवेंट सब्सक्रिप्शन अपरिवर्तित रखने के लिए इसे छोड़ दें।

अनुमत मान:
log_redacted_fieldslist of strings or nullवैकल्पिक

फ़ील्ड नाम जिनके मान delivery log, request payload दिखाते समय, छिपा देता है। इनका मिलान किसी भी गहराई पर होता है और case तथा _ या - जैसे विराम चिह्नों को अनदेखा किया जाता है। tokens और passwords जैसे गुप्त दिखने वाले नामों के फ़ील्ड हमेशा छिपे रहते हैं। संग्रहीत log और redeliveries मूल मान बनाए रखते हैं। अधिकतम 50 नाम, प्रत्येक 1 से 128 वर्ण का, जिसमें whitespace, dots या wildcards न हों।

रिस्पॉन्स

सफल रिस्पॉन्स

statusstring

वर्कस्पेस वेबहुक पैच अनुरोध का स्टेटस। अनुरोध सफल होने पर स्टेटस ‘ok’ होगा। अन्यथा, स्टेटस 500 के साथ एक एरर मैसेज लौटाया जाएगा।

त्रुटियाँ

422
Unprocessable Entity Error