الويب هوكس

تسمح الويب هوكس لتطبيقك باستقبال إشعارات فورية عند حدوث أحداث مختلفة في Omdaa API، مثل استقبال رسالة جديدة، إرسال رسالة، أو اتصال جلسة.

إعداد عنوان Webhook

"function">curl "keyword">-X POST https://omdaa.com/api/v1/webhooks/set \
  "keyword">-H "Authorization: Bearer YOUR_JWT_TOKEN" \
  "keyword">-H "Content"keyword">-Type: application/json" \
  "keyword">-d '{
  "webhookUrl": "https://your class="keyword">-server.com/webhook",
  "events": ["message.incoming", "message.sent", "session.connected"]
}'

أمثلة للأحداث

رسالة واردة message.incoming
{
  "event": "message.incoming",
  "data": {
    "messageId": "msg_123",
    "from": "966501234567",
    "message": "مرحبا",
    "timestamp": "2025-01-15T12:00:00Z"
  }
}
رسالة مرسلة message.sent
{
  "event": "message.sent",
  "data": {
    "messageId": "msg_123",
    "to": "966501234567",
    "status": "sent",
    "timestamp": "2025-01-15T12:00:00Z"
  }
}
اتصال جلسة session.connected
{
  "event": "session.connected",
  "data": {
    "sessionId": "sess_123",
    "phoneNumber": "966501234567",
    "connectedAt": "2025-01-15T12:00:00Z"
  }
}

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

يتم إرسال توقيع مع كل طلب Webhook في رأس مخصص حتى تتمكن من التحقق من أن الطلب قادم من Omdaa API.

X-Webhook-Signature: sha256=...

الحصول على إعدادات Webhook

للحصول على إعدادات Webhook الحالية:

"function">curl "keyword">-X GET "https://omdaa.com/api/v1/webhooks" \
  "keyword">-H "Authorization: Bearer YOUR_JWT_TOKEN"

اختبار Webhook

لاختبار اتصال Webhook:

"function">curl "keyword">-X GET "https://omdaa.com/api/v1/webhooks/test" \
  "keyword">-H "Authorization: Bearer YOUR_JWT_TOKEN"

إحصائيات Webhook

للحصول على إحصائيات Webhook:

"function">curl "keyword">-X GET "https://omdaa.com/api/v1/webhooks/stats" \
  "keyword">-H "Authorization: Bearer YOUR_JWT_TOKEN"

Circuit Breaker

Omdaa API يستخدم Circuit Breaker لحماية Webhook من الفشل المتكرر:

الحصول على حالة Circuit Breaker

"function">curl "keyword">-X GET "https://omdaa.com/api/v1/webhooks/circuit class="keyword">-breaker" \
  "keyword">-H "Authorization: Bearer YOUR_JWT_TOKEN"

إعادة تعيين Circuit Breaker

"function">curl "keyword">-X POST "https://omdaa.com/api/v1/webhooks/circuit class="keyword">-breaker/reset" \
  "keyword">-H "Authorization: Bearer YOUR_JWT_TOKEN"

جميع الأحداث المتاحة

message.incoming
رسالة واردة
message.sent
رسالة مرسلة
message.delivered
رسالة تم تسليمها
message.read
رسالة تم قراءتها
session.connected
جلسة متصلة
session.disconnected
جلسة منفصلة
group.created
مجموعة جديدة
group.updated
تحديث مجموعة