الانتقال إلى المحتوى الرئيسي
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 الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

الاستجابة

عرض وجهات webhook (بدون تقسيم إلى صفحات، الأقدم أولاً).

uuid
string<uuid>

معرّف الوجهة الثابت؛ يُستخدم كـ {destination_uuid} للتحديث/الحذف.

label
string

اسم سهل القراءة معروض في Console.

url
string<uri>

رابط الوجهة الذي يتلقى طلبات POST مع payload الخاص بـ webhook.

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 المخزن مؤقتاً، وهو مفيد لعرض واجهة المستخدم.

deliveries_count
integer

محاولات التسليم (بما في ذلك عمليات إعادة المحاولة) التي تمت إلى هذه الوجهة في آخر 30 يوماً.

failed_deliveries_count
integer

محاولات التسليم خلال آخر 30 يوماً التي استجابت لها الوجهة برمز HTTP 400 أو أعلى، أو لم تستجب لها (انتهاء المهلة، أو رفض الاتصال، أو عنوان محظور).

average_response_time_ms
integer | null

متوسط وقت الاستجابة بالمللي ثانية على مدار آخر 30 يومًا، مقربًا إلى عدد صحيح. يكون null عندما لا توجد عمليات تسليم في تلك النافذة.

error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) على مدار آخر 30 يوماً؛ 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

وقت آخر استجابة من الوجهة لتسليم بحالة HTTP أقل من 400، خلال آخر 30 يوماً. وتكون القيمة null إذا لم تُجب خلال تلك الفترة بتسليم ذي حالة HTTP أقل من 400.

environment
enum<string>

بيئة التطبيق الذي يملك الوجهة.

الخيارات المتاحة:
live,
sandbox
daily_points
object[]

إدخال واحد لكل يوم بتوقيت UTC خلال آخر 30 يوماً، بدءاً من الأقدم، بما في ذلك الأيام التي لم تشهد أي عمليات تسليم. يحتسب كل محاولة، بما في ذلك عمليات إعادة المحاولة.

secret_last4
string

آخر أربعة أحرف من سر التوقيع الحالي للوجهة، لتتمكن من التمييز بين الأسرار. غير كافية للتحقق من التوقيع.

created_by_email
string | null

البريد الإلكتروني لعضو Business Console الذي أنشأ الوجهة. يكون null بالنسبة للوجهة التي تم إنشاؤها باستخدام مفتاح API.

created_by_name
string | null

اسم عضو Business Console الذي أنشأ الوجهة. null لوجهة تم إنشاؤها باستخدام مفتاح API.

created_at
string<date-time>
updated_at
string<date-time>
آخر تعديل في ٧ نوفمبر ٢٠٢٦