मुख्य सामग्री पर जाएं
POST
curl
Webhook गंतव्य आपको अलग-अलग Didit इवेंट अलग-अलग URL पर भेजने देते हैं। हर गंतव्य का अपना secret_shared_key, webhook_version और subscribed_events सूची होती है।

subscribed_events कैसे काम करता है

subscribed_events सटीक इवेंट नामों की एक आवश्यक सरणी है। Didit इस गंतव्य पर webhook तभी भेजता है जब payload का webhook_type सरणी के किसी मान से मेल खाता हो।
  • कम से कम एक इवेंट शामिल करें।
  • नीचे दिए गए समर्थित इवेंट नामों का ही उपयोग करें।
  • जो भी इवेंट आप भेजना चाहते हैं, सब जोड़ें; * या all जैसा कोई वाइल्डकार्ड मान नहीं है।
  • अलग-अलग उत्पाद क्षेत्रों को अलग-अलग सिस्टम तक रूट करने के लिए, अलग-अलग subscribed_events सूचियों वाले कई गंतव्य बनाएँ।

इवेंट कैटलॉग

Investigator (investigator.*) और प्रमाणीकरण (auth.*) इवेंट परिवार भी स्वीकार किए जाते हैं। हर इवेंट और उसका payload Webhooks में सूचीबद्ध है। सामान्य सदस्यता सेट:
payload के उदाहरण और हस्ताक्षर कोड के लिए, webhook मार्गदर्शिका देखें।

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

application/json
label
string
आवश्यक

Console → Webhooks में प्रदर्शित मानव-पठनीय नाम। आपके पास कई गंतव्य होने पर उन्हें अलग करने में मदद करता है (उदा. "Prod", "Staging mirror")।

Maximum string length: 255
url
string<uri>
आवश्यक

HTTPS URL जो POST अनुरोध प्राप्त करेगा। एप्लिकेशन के गंतव्यों के बीच अद्वितीय होना चाहिए। एक स्थिर, सुरक्षित endpoint का उपयोग करें: Didit बैकऑफ़ शेड्यूल पर विफल डिलीवरी का पुनः प्रयास करता है।

Maximum string length: 2000
enabled
boolean
डिफ़ॉल्ट:true

false होने पर, गंतव्य सहेजा जाता है लेकिन Didit इस पर कोई webhook पुश नहीं करेगा। उन स्टेजिंग कॉन्फ़िगरेशन के लिए उपयोगी जिन्हें आप रोक कर रखना चाहते हैं।

webhook_version
enum<string>

Payload स्कीमा संस्करण जो Didit भेजेगा। v3 वर्तमान/अनुशंसित फ़ॉर्मेट है; पुराने संस्करण लेगसी इंटीग्रेशन के साथ बैकवर्ड कम्पैटिबिलिटी के लिए रखे गए हैं।

उपलब्ध विकल्प:
v1,
v2,
v3
subscribed_events
enum<string>[]

डिलीवर करने के लिए इवेंट्स। प्रभावी रूप से आवश्यक: एक स्पष्ट [] को 400 के साथ अस्वीकार कर दिया जाता है, और फ़ील्ड को छोड़ने पर बिना किसी सब्सक्रिप्शन वाला गंतव्य बनता है जिसे कुछ भी प्राप्त नहीं होता है।

Minimum array length: 1

समर्थित webhook इवेंट का नाम। subscribed_events में इन सटीक स्ट्रिंग्स का उपयोग करें; असमर्थित मान अस्वीकृत कर दिए जाते हैं।

उपलब्ध विकल्प:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
उदाहरण:

प्रतिक्रिया

गंतव्य बनाया गया। secret_shared_key HMAC हस्ताक्षर सीक्रेट है — इसे अभी सहेजें।

uuid
string<uuid>

स्थिर गंतव्य पहचानकर्ता। बाद के कॉलों में {destination_uuid} के रूप में उपयोग करें।

label
string
url
string<uri>
enabled
boolean
webhook_version
enum<string>
उपलब्ध विकल्प:
v1,
v2,
v3
secret_shared_key
string

इस गंतव्य से संबद्ध स्वतः-जेनरेट किया गया HMAC साइनिंग सीक्रेट (43-वर्ण का URL-सुरक्षित token)। इनकमिंग webhooks पर हस्ताक्षर हेडर सत्यापित करने के लिए इसका उपयोग करें। API कुंजी कॉलर्स को हमेशा पूरा लौटाया जाता है; कंसोल उपयोगकर्ताओं को read:webhooks अनुमति की आवश्यकता होती है, अन्यथा वे एक खाली स्ट्रिंग देखते हैं।

secret_last4
string

गंतव्य के वर्तमान साइनिंग सीक्रेट के अंतिम चार वर्ण, ताकि आप सीक्रेट में अंतर कर सकें। हस्ताक्षर सत्यापित करने के लिए पर्याप्त नहीं है।

previous_secret_expires_at
string<date-time> | null

Business Console में गंतव्य के साइनिंग सीक्रेट को रोटेट किए जाने के बाद 24 घंटों के लिए सेट होता है। इस समय तक, गंतव्य पर प्रत्येक डिलीवरी में बदले गए सीक्रेट के साथ बनाए गए X-Signature-Previous, X-Signature-V2-Previous और X-Signature-Simple-Previous भी शामिल होते हैं (हस्ताक्षर सत्यापन देखें)। पिछले 24 घंटों में कोई रोटेशन न होने पर null।

subscribed_events
enum<string>[]

इस webhook गंतव्य के लिए इवेंट फ़िल्टर। Didit केवल उन webhook को डिलीवर करता है जिनका इवेंट प्रकार इनमें से किसी एक मान से सटीक रूप से मेल खाता है — कोई वाइल्डकार्ड सब्सक्रिप्शन नहीं है। भेजे जाने पर, सूची में कम से कम एक मान्य इवेंट होना चाहिए (एक स्पष्ट [] को 400 के साथ अस्वीकार कर दिया जाता है); ऐसा गंतव्य जिसकी सूची खाली है (निर्माण के समय फ़ील्ड छोड़ दिया गया) कुछ भी प्राप्त नहीं करता है। अपडेट करने पर सूची पूरी तरह से बदल दी जाती है, कभी मर्ज नहीं की जाती।

Minimum array length: 1

समर्थित webhook इवेंट का नाम। subscribed_events में इन सटीक स्ट्रिंग्स का उपयोग करें; असमर्थित मान अस्वीकृत कर दिए जाते हैं।

उपलब्ध विकल्प:
status.updated,
data.updated,
user.status.updated,
user.data.updated,
business.status.updated,
business.data.updated,
activity.created,
transaction.created,
transaction.status.updated,
travel_rule.status.updated,
workflow.compliance_changed,
transaction_rule_suggestions.created,
auth.signup,
auth.login,
auth.login_failed,
auth.password_reset_requested,
auth.password_reset_completed,
auth.mfa_changed,
auth.new_device,
auth.account_locked,
investigator.report.ready,
investigator.decision.automated,
investigator.decision.overridden,
investigator.decision.contested,
investigator.question.raised,
investigator.automation.paused,
investigator.rfi.answered,
investigator.rfi.overdue,
investigator.drift.detected,
investigator.sla.breached,
investigator.qa.failed,
investigator.external.report.ready
उदाहरण:
created_by_email
string | null

उस Business Console सदस्य का ईमेल जिसने गंतव्य बनाया। API कुंजी से बनाए गए गंतव्य के लिए null।

created_by_name
string | null

Business Console के उस सदस्य का नाम जिसने गंतव्य बनाया। API कुंजी से बनाए गए गंतव्य के लिए null।

created_at
string<date-time>
updated_at
string<date-time>
health_status
enum<string>

डिलीवरी स्थिति। failing: गंतव्य द्वारा पिछली बार सफलतापूर्वक उत्तर दिए जाने के बाद से 3 या अधिक लगातार इवेंट अपने पहले डिलीवरी प्रयास में विफल रहे (देखें failing_streak)। degraded: failing नहीं है, लेकिन पिछले 24 घंटों में एक डिलीवरी प्रयास विफल रहा और बाद के किसी भी प्रयास ने उस इवेंट को डिलीवर नहीं किया है; इसे डिलीवर करने वाला पुनः प्रयास या पुनः भेजना इसे साफ़ कर देता है। healthy: दोनों में से कोई नहीं। enabled से स्वतंत्र। एक विफल प्रयास वह होता है जिसका उत्तर HTTP 400 या उससे ऊपर के साथ दिया गया हो, या कोई उत्तर न दिया गया हो।

उपलब्ध विकल्प:
healthy,
degraded,
failing
failing_streak
integer

पिछले 30 दिनों के भीतर, गंतव्य द्वारा पिछली बार सफलतापूर्वक उत्तर देने के बाद से कितने लगातार इवेंट अपने पहले डिलीवरी प्रयास में विफल रहे। पुनः प्रयासों की गणना नहीं की जाती है, और पुनः प्रयास या पुनः भेजने सहित कोई भी सफल प्रयास इस सिलसिले को समाप्त कर देता है। पिछली सफलता के बाद से किसी भी इवेंट के विफल न होने पर 0।

failing_since
string<date-time> | null

जब वर्तमान failing_streak का पहला विफल प्रयास किया गया था। null जब failing_streak 0 हो।

last_success_at
string<date-time> | null

जब गंतव्य ने पिछले 30 दिनों के भीतर, 400 से कम के HTTP स्थिति कोड के साथ डिलीवरी का अंतिम बार उत्तर दिया। null यदि उसने उस अवधि में उत्तर नहीं दिया है।

environment
enum<string>

उस एप्लिकेशन का एनवायरनमेंट जिसके पास गंतव्य का स्वामित्व है।

उपलब्ध विकल्प:
live,
sandbox
summary
object

पिछले metrics_window_days (30) दिनों के लिए डिलीवरी मेट्रिक्स। last_delivery_at सबसे हालिया प्रयास है, चाहे वह कभी भी किया गया हो।

अंतिम संशोधन 7 नवंबर 2026