मुख्य सामग्री पर जाएं
GET
curl

​
गंतव्य की स्थिति

health_status बताता है कि गंतव्य अपनी डिलीवरी का जवाब किस तरह देता रहा है। विफल प्रयास वह है जिसमें गंतव्य ने HTTP 400 या उससे अधिक के साथ जवाब दिया, या जिसका उसने बिल्कुल जवाब नहीं दिया (टाइमआउट, अस्वीकार किया गया कनेक्शन या ब्लॉक किया गया पता)। पुनः प्रयास failing_streak में नहीं जुड़ते, और कोई भी सफल प्रयास, जिसमें पुनः प्रयास या पुनः भेजना भी शामिल है, स्ट्रीक को समाप्त कर देता है। health_status, enabled पर निर्भर नहीं करता। डिलीवरी मेट्रिक्स और daily_points पिछले 30 दिनों को शामिल करते हैं (metrics_window_days)। daily_points में हमेशा 30 प्रविष्टियाँ होती हैं, हर UTC दिन के लिए एक, सबसे पुरानी पहले।

​
संबंधित

प्राधिकरण

​
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।

प्रतिक्रिया

webhook गंतव्यों की सूची (पेजिनेशन रहित, सबसे पुराने पहले)।

​
uuid
string<uuid>

स्थिर गंतव्य पहचानकर्ता; अपडेट/डिलीट के लिए {destination_uuid} के रूप में उपयोग करें।

​
label
string

Console में दिखाया गया मानव-पठनीय नाम।

​
url
string<uri>

गंतव्य URL जो webhook payload के साथ POST अनुरोध प्राप्त करता है।

​
enabled
boolean

false होने पर, Didit इस गंतव्य पर डिलीवरी को बिना किसी सूचना के छोड़ देता है।

​
webhook_version
enum<string>

इस गंतव्य पर भेजा गया payload स्कीमा संस्करण। v3 वर्तमान/अनुशंसित फ़ॉर्मेट है।

उपलब्ध विकल्प:
v1,
v2,
v3
​
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
उदाहरण:
​
subscribed_events_count
integer

subscribed_events की कैश्ड लंबाई, UI रेंडरिंग के लिए उपयोगी।

​
deliveries_count
integer

पिछले 30 दिनों में इस गंतव्य पर किए गए डिलीवरी प्रयास (पुनः प्रयास शामिल)।

​
failed_deliveries_count
integer

पिछले 30 दिनों में डिलीवरी प्रयास जिन पर गंतव्य ने HTTP 400 या उससे अधिक के साथ उत्तर दिया, या उत्तर नहीं दिया (टाइमआउट, अस्वीकृत कनेक्शन या ब्लॉक किया गया पता)।

​
average_response_time_ms
integer | null

पिछले 30 दिनों में मिलीसेकंड में औसत रिस्पॉन्स समय, जिसे निकटतम पूर्णांक तक राउंड किया गया है। उस विंडो में कोई डिलीवरी न होने पर null।

​
error_rate_percentage
integer

पिछले 30 दिनों में round(failed_deliveries_count / deliveries_count * 100); जब कोई डिलीवरी न हो तो 0।

​
last_delivery_at
string<date-time> | null

सबसे हाल के डिलीवरी प्रयास का टाइमस्टैम्प (सफलता या विफलता)। कभी डिलीवर न होने पर null।

​
metrics_window_days
integer

दिनों में उस विंडो की अवधि जिसे deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage और daily_points कवर करते हैं। हमेशा 30।

​
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
​
daily_points
object[]

पिछले 30 दिनों के प्रति UTC दिन एक प्रविष्टि, सबसे पुरानी पहले, जिसमें बिना किसी डिलीवरी वाले दिन भी शामिल हैं। पुनः प्रयास सहित प्रत्येक प्रयास की गणना करता है।

​
secret_last4
string

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

​
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>
अंतिम संशोधन 7 नवंबर 2026