كل المستندات

واجهة Webhooks

ضبط Webhooks وتسليم الأحداث.

تنزيل 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 باستخدام السر، وقارن النتيجة بطريقة ثابتة الزمن قبل تحليل JSON.