ऑब्जेक्ट
WebhookEndpoint
फ़ील्ड
idintegerज़रूरीurlstringज़रूरीdescriptionstringज़रूरीactivebooleanज़रूरीpaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: लगातार 10 असफल प्रयास;feature_disabled: प्लान में वेबहुक शामिल नहीं हैं।disabled_reasonstring | nullgone: प्राप्तकर्ता ने 410 से जवाब दिया;manual: एडमिन ने बंद किया।मान्य मान:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullवेबहुक की डेटा प्रोफ़ाइल (
nullका मतलब है कोई प्रोफ़ाइल नहीं, जैसे उसी रोल वाली API कुंजी के लिए)।collection_idsarray of integerज़रूरीवे कलेक्शन, जिनके बारे में वेबहुक इवेंट पाता है; ख़ाली का मतलब है रोल और डेटा प्रोफ़ाइल को उपलब्ध सभी कलेक्शन।
tagsarray of stringज़रूरीकार्ड के इवेंट सिर्फ़ उन कार्ड के लिए, जिन पर इनमें से कोई टैग हो; ख़ाली का मतलब है कोई फ़िल्टर नहीं।
auth_typestring | nullबाहर जाने वाली रिक्वेस्ट के ऑथराइज़ेशन का टाइप (
nullका मतलब है कोई नहीं)।मान्य मान:
bearerbasicnullauth_setbooleanज़रूरीक्या बाहर जाने वाली रिक्वेस्ट का ऑथराइज़ेशन सेट है (मान कभी नहीं लौटाए जाते)।
previous_secret_valid_untilstring (date-time) | nullकब तक डिलीवरी पिछले सीक्रेट से भी साइन की जाती हैं (
nullका मतलब है कोई ओवरलैप अवधि नहीं)।healthWebhookHealthconsecutive_failuresintegerज़रूरीlast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)ज़रूरीupdated_atstring (date-time)ज़रूरी
इनमें इस्तेमाल
- GET
/v1/webhooks/{webhook_id}वेबहुक पाएँ - PATCH
/v1/webhooks/{webhook_id}वेबहुक बदलें - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretपिछला सीक्रेट रद्द करें - POST
/v1/webhooks/{webhook_id}/resumeवेबहुक फिर से शुरू करें