इवेंट · वेबहुक सर्विस के इवेंट
webhook.ping
टेस्ट इवेंट
POST /v1/webhooks/{webhook_id}/test से भेजा गया टेस्ट इवेंट। इसका सब्सक्रिप्शन नहीं लिया जा सकता और यह इवेंट फ़ीड में दर्ज नहीं होता।
- ऑब्जेक्ट टाइप
- webhook
- किसे डिलीवर होता है
- एडमिन रोल वाले वेबहुक
पेलोड
idstringज़रूरीइवेंट का ID (
evt_…), जोwebhook-idहेडर में भी भेजा जाता है। डुप्लिकेट डिलीवरी हटाने के लिए इसका इस्तेमाल करें।typestringज़रूरीमान्य मान:
webhook.pingcreated_atstring (date-time)ज़रूरीबदलाव कब हुआ (UTC)।
org_idintegerज़रूरीapi_versionstringज़रूरीdataस्कीमा के कॉन्ट्रैक्ट का वर्शन।sequenceintegerवेबहुक के अंदर डिलीवरी का क्रम नंबर (टेस्ट इवेंट में नहीं होता)।
payloadstringज़रूरीthinका मतलब हैdataनहीं: ऑब्जेक्ट API से पढ़ें।मान्य मान:
fullthindataobjectफ़ील्ड
endpoint_idintegerज़रूरीmessagestringज़रूरीrequested_byinteger | null
testbooleanज़रूरीPOST /v1/webhooks/{webhook_id}/testसे भेजा गया टेस्ट इवेंट।
डिलीवरी का उदाहरण
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "webhook.ping",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"object": {
"type": "webhook",
"id": "4"
},
"payload": "full",
"data": {
"endpoint_id": 4,
"message": "Test event from the knowledge platform",
"requested_by": 7
},
"test": true
}इवेंट पाना
हर डिलीवरी आपके वेबहुक पर भेजी गई POST रिक्वेस्ट है, जिसकी बॉडी यही JSON है। बॉडी पर भरोसा करने से पहले webhook-signature हेडर (Standard Webhooks) जाँचें, कुछ सेकंड के अंदर 2xx स्टेटस के साथ जवाब दें और काम उसके बाद करें। एक वेबहुक की डिलीवरी इवेंट का क्रम बनाए रखती हैं; असफल डिलीवरी का बढ़ते अंतराल पर रीट्राई होता है।
नए इवेंट टाइप और नए फ़ील्ड कभी भी आ सकते हैं: जिन टाइप और फ़ील्ड को आप नहीं जानते, उन्हें छोड़ दें।