الويب هوك

تم التحديث

المكان: الإعدادات > التكاملات > الويب هوك

ما فائدتها:

"أرسل الأحداث الواردة إلى خادمك." يرسل SyBox نسخة من كل حدث تم اختياره إلى عنوان على خادمك وقت حدوثه فورًا. وتصل أحداث WhatsApp بتنسيق Meta الخاص. أما رسائل العملاء على Messenger و Instagram و Telegram و TikTok والدردشة المباشرة، وأحداث المحادثات (الاكتمال، والتصنيفات، وجهات الاتصال، والصفقات، وحالات CRM)، فتصل بتنسيق SyBox الخاص. ولا يتم إرسال رسائل البريد الإلكتروني أو SMS.

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

الأحداث التي يمكنك اختيارها:

  • "رسالة واردة": أرسل عميل رسالة.
  • "حالة الرسالة": رسالة أرسلتَها وتم إرسالها أو تسليمها أو قراءتها أو فشل إرسالها.
  • "تفاعل": تفاعل عميل مع رسالة.
  • "وضع علامة كمكتمل على محادثة": تم وضع علامة كمكتمل على محادثة، سواء بواسطة أحد أعضاء الفريق، أو بواسطة أتمتة، أو تلقائيًا بعد صمت العميل.
  • "إضافة تصنيف أو إزالته": تمت إضافة تصنيف إلى محادثة أو إزالته منها.
  • "إنشاء جهة اتصال أو تحديثها": تم إنشاء جهة اتصال جديدة، أو تغيّر اسم جهة اتصال أو بريدها الإلكتروني أو حقولها. ولا يقوم استيراد جهات الاتصال بإرسال هذه الأحداث.
  • "إتمام صفقة": تم تسجيل صفقة في محادثة.
  • "فتح حالة CRM أو إغلاقها": تم فتح حالة CRM، أو إغلاقها كمحلولة أو غير محلولة أو ملغاة. ولا تتبع الحالة أي رقم، لذلك يستقبلها فقط الويب هوك الذي يغطي كل الأرقام، وليس الويب هوك المقتصر على بعض الأرقام.

تصل الأحداث الخمسة الأخيرة بتنسيق SyBox الخاص، لكل القنوات. وتعرض صفحة توثيق المطورين مثالاً لكل حدث منها.

  • "تفريغ الصوت" (خيار إضافي): يتم الاحتفاظ بالرسالة الصوتية لفترة قصيرة، تصل إلى نحو دقيقتين، حتى يتسنى إرسال نصها المكتوب معها. ويكون معطلاً ما لم تقم بتفعيله.

طريقة إضافة ويب هوك

  1. انتقل إلى الإعدادات > التكاملات > الويب هوك.
    Settings, Webhooks: an active webhook with its last result, and the "Add webhook" button
  2. انقر على "أضف ويب هوك".
    The new webhook window: its name and the address it calls
  3. أدخل "الاسم".
  4. أدخل "رابط الوجهة". ويجب أن يكون "عنوان https عام يمكننا الوصول إليه". ويتم رفض عناوين http العادية وعناوين الشبكات الخاصة أو الداخلية.
  5. تحت "الأحداث"، فعّل حدثًا واحدًا على الأقل. ويكون حدث "رسالة واردة" مفعلًا بشكل افتراضي.
  6. اختياري: فعّل "تفريغ الصوت" لتلقي الرسائل الصوتية مع نصوصها.
  7. تحت "الأرقام"، اترك "كل الأرقام" مفعلة لتغطية كل أرقام WhatsApp. أو أوقف تفعيلها وحدد فقط الأرقام التي تريدها.
  8. انقر على حفظ.
  9. تظهر نافذة تعرض "مفتاح التوقيع". "انسخه الآن — لن يظهر مجدداً." احفظه على خادمك.

حول عمليات الإرسال:

  • تستخدم كل عملية إرسال التنسيق نفسه لويب هوك WhatsApp الخاص بشركة Meta.
  • يتم توقيع كل عملية إرسال بمفتاح التوقيع الخاص بك بالطريقة نفسها التي توقع بها Meta الويب هوك الخاص بها. وإذا كان خادمك يتحقق بالفعل من ويب هوك Meta، فيمكنه التحقق من ويب هوك SyBox باستخدام مفتاح SyBox السري بدلاً منه.
  • إذا لم يستجب خادمك بنجاح، يحاول SyBox مجددًا عدة مرات بفواصل زمنية أطول في كل مرة، لمدة ساعة تقريبًا. وبعد ذلك يتوقف عن محاولة إرسال ذلك الحدث.
  • قد يصل الحدث نفسه مرتين في بعض الأحيان، على سبيل المثال بعد انتهاء المهلة. لذا ينبغي لخادمك معالجة الأحداث المكررة.

طريقة اختبار الويب هوك

  1. تأكد من أن الويب هوك مفعّل. إذا كان معطلاً، ستظهر لك رسالة "قم بتفعيل هذا الويب هوك أولاً."
  2. في بطاقته، انقر على "إرسال حدث تجريبي". ستظهر لك رسالة "جارٍ إرسال حدث تجريبي. ستظهر نتيجته في «عمليات التسليم»."
  3. بعد بضع ثوانٍ تفتح قائمة "عمليات التسليم" وتعرض رد خادمك. وتعرض البطاقة أيضًا آخر رد من خادمك مع وقته. ويظهر الرد الناجح (على سبيل المثال "HTTP 200") باللون الأخضر، بينما يظهر الخطأ باللون الأحمر. وتعني عبارة "آخر تسليم: أبدًا" أنه لم يتم تسليم أي شيء بعد.
    To test a webhook: "HTTP 200" marked on the screen in SyBox

يحتوي الحدث التجريبي على "event": "test" ولا يحمل أي بيانات للعملاء. ويمكنك إرسال حدث تجريبي كل بضع ثوانٍ؛ وإذا حاولت قبل ذلك، ستظهر لك رسالة "تم إرسال حدث تجريبي منذ لحظات. حاول مرة أخرى بعد بضع ثوانٍ."

طريقة عرض عمليات التسليم

  1. في بطاقة الويب هوك، انقر على "عمليات التسليم".
  2. تعرض القائمة "آخر 50 عملية تسليم خلال آخر 7 أيام."، من الأحدث إلى الأقدم. وتعرض كل عملية نوع الحدث، ووقت محاولة إرسالها، وحالتها:
    • "تم التسليم": استجاب خادمك بنجاح.
    • "في انتظار الإرسال": لم تتم محاولة إرسالها بعد.
    • "فشل التسليم، جارٍ إعادة المحاولة": لم يستجب خادمك بنجاح، وسيحاول SyBox مرة أخرى لاحقًا.
    • "لم يتم التسليم": توقف SyBox عن المحاولة.
    • كما تعرض رمز HTTP الذي استجاب به خادمك، والوقت الذي استغرقته الاستجابة بالمللي ثانية، و"المحاولات: [العدد]" عند محاولة إرسالها أكثر من مرة. ولا يتم عرض الرسالة نفسها.
  3. لإعادة إرسال إحدى العمليات، انقر على "إعادة الإرسال" في عملية حالتها "تم التسليم" أو "لم يتم التسليم". ستظهر لك رسالة "تمت إضافته إلى قائمة الانتظار لإعادة إرساله." وتتطلب إعادة الإرسال صلاحية "إظهار رقم جهة الاتصال"، لأنها تقوم بإرسال بيانات العميل مرة أخرى.

التوقف التلقائي:

إذا استمر فشل خادمك — 20 محاولة متتالية، لأكثر من ساعة — يقوم SyBox بإيقاف الويب هوك. وتعرض البطاقة باللون الأحمر "توقف تلقائياً بعد فشل [العدد] عملية تسليم متتالية"، ويتلقى المسؤول الرئيسي إشعارًا بعنوان "توقف ويب هوك تلقائياً". ويتم الاحتفاظ بأحداثه المنتظرة لمدة 24 ساعة. أصلح العنوان أو خادمك، ثم أعد تفعيل الويب هوك: فيتم إرسال الأحداث المنتظرة، ويبدأ العد من جديد من الصفر.

طريقة تعديل ويب هوك أو إيقافه مؤقتًا أو حذفه

  1. انقر على تعديل لتغيير الاسم أو العنوان أو الأحداث أو الأرقام.
    To edit, pause or delete a webhook: "Edit" marked on the screen in SyBox
  2. لاستبدال مفتاح التوقيع، اكتب مفتاحًا جديدًا في "مفتاح التوقيع". واتركه فارغًا للإبقاء على المفتاح الحالي ("اتركه فارغًا للإبقاء على المفتاح الحالي").
  3. انقر على تفعيل / تعطيل لإيقافه مؤقتًا. وستنتظر الأحداث التي تصل أثناء إيقافه مؤقتًا، فإذا أعدت تشغيله قريبًا، فسيتم إرسالها.
  4. انقر على حذف، ثم أكّد "حذف هذا الويب هوك؟".

القواعد والرسائل:

  • حقلا الاسم ورابط الوجهة مطلوبان، ويجب تفعيل حدث واحد على الأقل. وإلا فستظهر لك رسالة "بيانات غير مكتملة".
  • يتم رفض أي عنوان ليس https عامًا مع رسالة "عنوان https عام يمكننا الوصول إليه".
فقدت مفتاح التوقيع.

لا يمكن عرضه مرة أخرى. عدّل الويب هوك، واكتب مفتاحًا سريًا جديدًا من اختيارك في "مفتاح التوقيع"، ثم احفظه، واستخدم ذلك المفتاح الجديد على خادمك.

توقف الويب هوك الخاص بي بدون أن أقوم بإيقافه.

قام SyBox بإيقافه بعد فشل خادمك 20 مرة متتالية لأكثر من ساعة. راجع "التوقف التلقائي" أعلاه: أصلح خادمك، ثم أعد تفعيل الويب هوك خلال 24 ساعة حتى يتم إرسال الأحداث المنتظرة.

الويب هوك الخاص بي لا يتلقى أي شيء على الإطلاق.

انقر على "إرسال حدث تجريبي" في بطاقته أولاً، وانظر إلى "عمليات التسليم". ثم تحقق من هذه الأمور الأربعة: (1) أن الويب هوك مفعّل. (2) تم اختيار حدث واحد على الأقل. (3) أنه يغطي رقم WhatsApp الصحيح، أو "كل الأرقام". (4) أن القناة التي وصلت عليها الرسالة هي إحدى القنوات التي يدعمها الويب هوك (WhatsApp أو Messenger أو Instagram أو Telegram أو TikTok أو الدردشة المباشرة؛ وليس البريد الإلكتروني أو SMS). ثم انظر إلى نتيجة آخر عملية تسليم على البطاقة.

تُظهر البطاقة خطأً باللون الأحمر مثل HTTP 404 أو 500.

وصل SyBox إلى عنوانك، لكن خادمك رد بوجود خطأ. تحقق من العنوان وسجلات خادمك.

لا أستطيع إنشاء ويب هوك، وتظهر رسالة تفيد بأنه غير مسموح لي.

يتطلب إنشاء ويب هوك أو إعادة تشغيله إذني "إدارة القنوات" و"إظهار رقم جهة الاتصال" معًا. اطلب ذلك من المسؤول لديك.