🌐 مشغل الويب هوك

يمكن لمشغل Webhook تمكين الأنظمة الخارجية من بدء سير العمل في SmartFlow عن طريق إرسال البيانات عبر طلبات API. هذا المشغل مثالي لدمج SmartFlow مع التطبيقات الخارجية، مما يسمح بأتمتة المهام بشكل ديناميكي وسلس.

---

📝 تفاصيل المشغل

الاسم: Webhook
الفئة: المشغلات

---

🔧 المعلمات

1. رابط الويب هوك

• النوع: string
• الوصف: عنوان URL لنقطة النهاية الخاصة بالويب هوك لاستقبال الطلبات الواردة. يتم إنشاؤه تلقائيًا لكل سير عمل يستخدم هذا الزناد.
• مطلوب: نعم
• مثال:

  https://api.smartflow.com/webhooks/{workflowId}

2. الحمولة

• النوع: object
• الوصف: البيانات المرسلة من النظام الخارجي في جسم الطلب. يمكن أن تتضمن هذه الحمولة حقولًا مخصصة اعتمادًا على التكامل.
• مطلوب: نعم
• مثال:

  {
    "event": "order_created",
    "orderId": "12345",
    "customer": {
      "name": "John Doe",
      "email": "john@example.com"
    }
  }

3. الرؤوس

• النوع: object
• الوصف: رؤوس اختيارية قد تتضمنها النظام الخارجي لأغراض المصادقة أو البيانات الوصفية.
• مطلوب: لا
• مثال:

  {
    "Authorization": "Bearer your-api-key",
    "Content-Type": "application/json"
  }

🚀 كيف يعمل

1. تكوين عنوان URL للويب هوك:

   • عند إنشاء سير عمل باستخدام مشغل الويب هوك، يقوم SmartFlow بإنشاء عنوان URL فريد للويب هوك.
   • شارك هذا العنوان مع النظام الخارجي لتكوين تكاملهم.

2. استرجاع مفتاح API:

   • انتقل إلى إعدادات نموذج الدردشة.
   • اذهب إلى التكامل → الويب.
   • انقر على نسخ مفتاح API لاسترجاع رمز المصادقة اللازم.

3. هيكل الحمولة:

   • ترسل الأنظمة الخارجية البيانات (الحمولة) إلى عنوان URL للويب هوك باستخدام طلب HTTP POST.
   • يجب أن تتطابق الحمولة مع الهيكل المطلوب من قبل سير العمل.

4. تنفيذ المشغل:

   • عندما يستقبل الويب هوك طلبًا صالحًا، يتم تشغيل سير العمل المرتبط تلقائيًا.
   • يقوم SmartFlow بمعالجة الحمولة، وتنفيذ الإجراءات المحددة، وإرجاع استجابة إذا لزم الأمر.

💡 حالات الاستخدام

1. تكامل CRM:

   • السيناريو: يقوم عميل بإنشاء حساب جديد في نظام CRM الخاص بك.
   • Webhook: يرسل نظام CRM طلب POST إلى SmartFlow مع تفاصيل العميل.
   • سير العمل: يرسل بريدًا إلكترونيًا للترحيب ويضيف العميل إلى قائمة التسويق الخاصة بك.

2. إدارة الطلبات:

   • السيناريو: تقوم منصة التجارة الإلكترونية بمعالجة طلب جديد.
   • Webhook: ترسل المنصة تفاصيل الطلب إلى SmartFlow.
   • سير العمل: يحدث المخزون، يرسل بريد تأكيد الطلب، ويقوم بإخطار المستودع.

3. مراقبة الحوادث:

   • السيناريو: يكتشف نظام المراقبة خطأً حرجًا.
   • Webhook: يرسل النظام تنبيهًا إلى SmartFlow.
   • سير العمل: ينشئ تقرير حادث ويقوم بإخطار فريق الهندسة.

🔍 مثال التكوين

طلب الويب الوارد

URL:

https://api.smartflow.com/webhooks/abc123

الحمولة:

{
  "event": "user_registered",
  "userId": "67890",
  "name": "Jane Doe",
  "email": "jane@example.com"
}

الرؤوس:

{
  "Authorization": "Bearer 123456789",
  "Content-Type": "application/json"
}

🛠️ أفضل الممارسات

1. التحقق:

   • تحقق من الطلبات الواردة لضمان سلامة البيانات ومنع الاستخدام غير السليم.
   • استخدم رؤوس أو رموز أمان للمصادقة.

2. أمان مفتاح API:

   • تأكد من أن مفتاح API المستخرج من إعدادات ChatModel → التكامل → الويب محفوظ بشكل آمن وغير مكشوف للجمهور.

3. تخطيط البيانات:

   • قم بتخطيط الحقول الواردة بوضوح إلى متغيرات سير العمل لضمان معالجة سلسة.

4. الاختبار:

   • اختبر الويب هوك باستخدام حمولات عينة لضمان التوافق والموثوقية.

5. معالجة الأخطاء:

   • قم بتكوين سير العمل للتعامل مع البيانات المفقودة أو المشوهة بشكل لطيف.

📊 مراقبة وتصحيح الأخطاء

• سجلات النشاط:
  تتبع طلبات الويب الواردة وحالة معالجتها في لوحة معلومات SmartFlow.

• تقرير الأخطاء:
  تحديد الطلبات الفاشلة وعرض تفاصيل الأخطاء لتسهيل عملية التصحيح.

---

تقدم هذه القسم دليلًا مفصلًا لمشغل الويب هوك، مما يضمن أن المستخدمين يمكنهم دمجه بسلاسة في سير العمل الخاص بهم. دعني أعرف إذا كنت بحاجة إلى أي تحسينات!