القسم الحالي: قواعد الأحداث

التنبيهات وWebhooks - قواعد الأحداث

حدد ظروف السوق والإجراءات التي تشغل تسليم webhooks. يمكنك إنشاء القواعد من لوحة التحكم أو برمجياً عبر API.

مرجع لوحة التحكم وأنواع الأحداث

يمكنك إنشاء التنبيهات وإدارتها من لوحة المطور. لمرجع أنواع الأحداث والشروط الكامل، راجع أنواع الأحداث وشروطها.

POST /api/v1/alerts/

Pro+

أنشئ قاعدة تنبيه تشغل تسليم webhooks عند تحقق الشروط.

نقطة النهاية

https://api.sahmk.sa/api/v1/alerts/

المعاملات

(*) مطلوب

المعاملالنوعالقيم المسموحة
symbol *string

رمز السهم

event_type *string
price_alertlarge_moveabnormal_volumeunusual_value_traded
conditionstring
price_aboveprice_belowpct_changepct_change_abs_gteratio_gte

بحسب نوع الحدث

value *number

رقم

webhook_idnumber

معرّف الـ webhook

destinationobject

كائن JSON

configobject

كائن JSON

onceboolean
truefalse

الافتراضي true

إرشادات تصميم القواعد

  • ابدأ بنطاق رموز محدود وحدود واضحة.
  • استخدم فترات تهدئة لتقليل ضوضاء الإشعارات.
  • تحقق في بيئة الاختبار قبل تفعيل قواعد الإنتاج.
  • condition مطلوب مع price_alert؛ أما أنواع الأحداث الموثقة الأخرى فتطبّعه تلقائياً.
  • يجب أن تتجاوز حدود النسب 1.0. والحد الأقصى للحركة الكبيرة هو 10% في TASI و30% في NOMU.
  • once القيمة الافتراضية true. تضبطه الأمثلة على false صراحةً لإنشاء قواعد متكررة، ولذلك تعرض استجاباتها fire_once: false.
200 OKapplication/json
{
  "id": 57,
  "workspace_id": null,
  "symbol": "2222",
  "event_type": "large_move",
  "target_scope_type": "single_symbol",
  "target_scope_id": null,
  "symbols": ["2222"],
  "evaluated_symbol_rules": 1,
  "condition": "pct_change_abs_gte",
  "value": "3.0",
  "config": {
    "window": "5m",
    "destination": { "type": "webhook", "webhook_id": 19 }
  },
  "fire_once": false,
  "webhook_id": 19,
  "webhook_url": "https://example.com/hooks/sahmk",
  "destination": { "type": "webhook", "webhook_id": 19 },
  "status": "active",
  "last_triggered_at": null,
  "total_triggers": 0,
  "created_at": "2026-05-08T13:36:45+03:00"
}

GET /api/v1/alerts/

Pro+

اعرض القواعد الحالية وصفّها اختيارياً حسب الحالة.

نقطة النهاية

https://api.sahmk.sa/api/v1/alerts/?status=active

المعاملات

(*) مطلوب

المعاملالنوعالقيم المسموحة
statusstring
activepausedall
  • الاستعلام: status=active|paused|all
  • قيم الحالة: active, paused, triggered
  • المطابقة: once يطابق fire_once.
200 OKapplication/json
{
  "alerts": [
    {
      "id": 57,
      "workspace_id": null,
      "symbol": "2222",
      "event_type": "large_move",
      "target_scope_type": "single_symbol",
      "target_scope_id": null,
      "symbols": ["2222"],
      "evaluated_symbol_rules": 1,
      "condition": "pct_change_abs_gte",
      "value": "3.0",
      "config": {
        "window": "5m",
        "destination": { "type": "webhook", "webhook_id": 19 }
      },
      "status": "active",
      "fire_once": false,
      "webhook_id": 19,
      "webhook_url": "https://example.com/hooks/sahmk",
      "destination": { "type": "webhook", "webhook_id": 19 },
      "last_triggered_at": null,
      "total_triggers": 0,
      "created_at": "2026-05-08T13:36:45+03:00"
    }
  ]
}

آخر تحديث في