كل المستندات

واجهة Webhooks

اضبط Webhooks للاحتيال وAML: استقبل القرارات فور صدورها، وأعد المحاولة عند الفشل، وتجنّب فتح حالة مكررة في أنظمتك.

تنزيل Markdown
الأدلةمرجع APIأمثلة الكودأفضل الممارسات

Webhooks

أنشئ اشتراكات لتستقبل إشعارات موقّعة (callbacks) عند وقوع أحداث في المنصة، بدلًا من الاستعلام المتكرر.

الطريقةالمسارالاستخدام
POST/api/v1/webhooks/subscriptionsإنشاء اشتراك وإصدار signingSecret
GET/api/v1/webhooks/subscriptionsعرض اشتراكات حساب المنشأة
POST/api/v1/webhooks/subscriptions/:id/testإرسال حدث اختبار
DELETE/api/v1/webhooks/subscriptions/:idحذف الاشتراك

إنشاء اشتراك

POST /api/v1/webhooks/subscriptions
{
  "url": "https://api.example.com/webhooks",
  "eventTypes": [
    "EVENT_RISK_EVALUATED",
    "EVENT_FEEDBACK_SUBMITTED"
  ]
}

يجب أن يستخدم الرابط HTTPS وأن يحتوي الطلب على نوع حدث واحد على الأقل. يُعاد signingSecret مرة واحدة فقط عند الإنشاء، فاحفظه فورًا في أداة إدارة الأسرار (secret manager).

تشمل الأنواع المتاحة EVENT_RISK_EVALUATED وEVENT_FEEDBACK_SUBMITTED وBLOCKLIST_ENTRY_ADDED وBLOCKLIST_ENTRY_REMOVED.

التحقق من التوقيع

Signature headers
X-Webhook-Signature: sha256=<signature>
X-Webhook-Event-Type: EVENT_RISK_EVALUATED

احسب HMAC-SHA256 لجسم الطلب الخام (raw body) باستخدام السر، وقارن النتيجة بمقارنة ثابتة الزمن (constant-time) قبل تحليل JSON.