मुख्य सामग्री पर जाएं
POST
वेबहुक कॉन्फ़िगर करें

वेबहुक कॉन्फ़िगर करें

खाते का वेबहुक URL सेट करता है। प्रति खाता एक URL होता है और दोनों घटनाएँ वहीं जाती हैं।
API कुंजी इसे नहीं बुला सकती। वेबहुक URL बदलने — या साइनिंग सीक्रेट पढ़ने — के लिए वह सत्र चाहिए जो आपने स्वयं वेबसाइट पर खोला हो। API कुंजी के साथ अनुरोध अस्वीकार होता है:
Response
अन्यथा चोरी हुई एक कुंजी ही आपकी घटनाओं को किसी और के सर्वर पर मोड़ने के लिए काफ़ी होती। URL Dashboard → API में सेट करें; वहीं साइनिंग सीक्रेट भी दिखता है।

अनुरोध बॉडी

string
आवश्यक
वेबहुक URL। इस एंडपॉइंट पर केवल HTTPS, और यह localhost, 127.0.0.1, 0.0.0.0 या ::1 की ओर नहीं होना चाहिए। इसके अलावा भेजते समय भी ऐसे किसी होस्ट पर डिलीवरी अस्वीकार होती है जो निजी, लूपबैक या लिंक-लोकल पते पर रिज़ॉल्व हो।

प्रतिक्रिया

string
अब कॉन्फ़िगर किया गया URL।
string
X-Webhook-Signature के लिए साइनिंग सीक्रेट। खाते पर पहली बार URL सेट करते समय बनता है और उसके बाद स्थिर रहता है।
Response

डैशबोर्ड वाला रास्ता

डैशबोर्ड उन्हीं खाता-स्तरीय फ़ील्ड पर दूसरी जोड़ी एंडपॉइंट इस्तेमाल करता है — URL और सीक्रेट पढ़ने के लिए GET /api/v1/account/webhook, और सेट या साफ़ करने के लिए PATCH /api/v1/account/webhook। ये वही मान स्वीकार करते हैं, दो अंतरों के साथ: PATCH http:// URL भी लेता है, और {"webhook_url": null} भेजने पर वेबहुक साफ़ हो जाता है। URL साफ़ करने पर सीक्रेट बना रहता है, इसलिए बाद में वेबहुक दोबारा चालू करने से आपका पहले से तैनात जाँच कोड बेकार नहीं होता। दोनों एंडपॉइंट के लिए भी वेबसाइट सत्र चाहिए।