Webhook

تتيح لك Webhooks إرسال بيانات الرحلة إلى خدمات خارجية مثل التحليلات وأنظمة CRM وأدوات التسويق. يمكنك:

إخطار الأنظمة الخارجية عندما يتخذ العميل إجراءً في الرحلة
إرسال بيانات العملاء إلى أدوات التحليل
تشغيل رسائل بريد إلكتروني أو SMS أو WhatsApp من جهات خارجية عند وقوع أحداث معينة في الرحلة

كيفية إعداد عنصر Webhook

إضافة عنصر Webhook

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

عنصر Webhook على لوحة العمل مع إعدادات الاسم والطلب

تسمية خطوة Webhook وتحديد عنوان URL ونوع الطلب

في حقل STEP NAME، أدخل اسمًا لـ webhook. قد يكون من المفيد تسمية webhooks وفقًا للخدمات التي ترسل البيانات إليها أو حالة الاستخدام.

بعد ذلك، في حقل URL، حدد عنوان URL للطلب الذي يجب إرسال البيانات إليه. بجوار حقل URL، حدد نوع الطلب من القائمة المنسدلة REQUEST TYPE: GET أو POST.

واجهة تكوين Webhook تظهر حقل URL والقائمة المنسدلة REQUEST TYPE لاختيار طريقة GET أو POST

تكوين الرؤوس (Headers)

في قسم HEADERS، قم بتعيين نوع المحتوى.

بشكل افتراضي، نوع المحتوى هو application/json. إذا كانت الخدمة التي ترسل إليها webhook تتطلب نوع محتوى آخر، فأدخل النوع المناسب في قيمة رأس Content-Type.

أمثلة على أنواع المحتوى هي:

x-www-form-urlencoded
text/plain
text/xml

أضف رؤوسًا إضافية إذا لزم الأمر بالنقر فوق + ADD HEADER. يمكنك إزالة أي رأس بالنقر فوق أيقونة ‘x’ بجواره.

على سبيل المثال، قد تتطلب بعض واجهات برمجة التطبيقات (APIs) مصادقة HTTP الأساسية (HTTP Basic authentication). لمصادقة مثل هذه الطلبات، قم بما يلي:

افتح محرر نصوص عادي واكتب اسم المستخدم وكلمة المرور بدون مسافات، مفصولة بنقطتين رأسيتين. على سبيل المثال: myuser:mypass
قم بترميز هذه السلسلة إلى Base64.
انسخ سلسلة Base64 الناتجة (على سبيل المثال، bXl1c2VyOm15cGFzcw==).
في إعدادات webhook، أضف رأس Authorization بالقيمة: Basic <YOUR BASE64 STRING>. تأكد من وجود مسافة بعد كلمة “Basic”.

مثال على رأس Authorization للمصادقة الأساسية في إعدادات webhook يظهر رأسي Content-Type و Authorization

إضافة نص طلب JSON

في قسم DATA، أدخل نص طلب JSON الخاص بك. تأكد من أن نص الطلب بتنسيق JSON صحيح.

مثال:

{
  "hwid": "{{device:hwid}}"
}

استخدام البيانات الديناميكية ووحدات الماكرو

تتيح لك لوحة DATA BUILDER إدراج معلومات ديناميكية (مثل بيانات المستخدم أو الجهاز أو الوسم أو الحدث) مباشرة في نص طلب JSON الخاص بك. باستخدام البيانات الديناميكية، يمكنك تضمين قيم خاصة بالمستخدم الفردي الذي يتقدم عبر الرحلة.

للقيام بذلك:

حدد فئة. يمكنك سحب البيانات من ثلاث فئات:

Device: استخدم بيانات الجهاز عندما تحتاج إلى معلومات فنية مرتبطة بجهاز المستخدم.
Tag: استخدم بيانات الوسم عندما تريد إرسال معلومات مخزنة في ملف تعريف المستخدم.
Event: استخدم بيانات الحدث عندما يجب أن يرسل webhook القيم من الحدث الذي أدى إلى تشغيل الرحلة.

حدد معلمة (على سبيل المثال، HWID، الفئة المفضلة، إلخ).
يقوم Pushwoosh بإنشاء ماكرو يبدو كالتالي:

{{tag:Language}}

انسخ الماكرو وألصقه في نص JSON الخاص بك في قسم DATA.

عندما يتم تشغيل webhook في رحلة حية، يقوم Pushwoosh تلقائيًا باستبدال الماكرو بالقيمة الفعلية لذلك المستخدم.

إدراج العناصر النائبة للبيانات الديناميكية في نص طلب webhook

ربط بيانات استجابة Webhook بالمتغيرات

بالإضافة إلى إرسال البيانات، يمكن لعنصر Webhook أيضًا التقاط البيانات من الاستجابة التي يتلقاها وتحويلها إلى متغيرات. يمكن بعد ذلك استخدام هذه المتغيرات لاحقًا في الرحلة. على سبيل المثال، قم بتعيين وسم باستخدام تحديث ملف تعريف المستخدم، أو جدولة تأخير زمني (Time Delay) بناءً على قيمة تم إرجاعها بواسطة الخدمة الخارجية. للحصول على مثال كامل للرحلة، راجع استخدام بيانات استجابة webhook في رحلتك.

في قسم RESPONSE MAPPING، انقر فوق + ADD MAPPING واملأ حقلين لكل قيمة تريد التقاطها:

Path: موقع القيمة داخل نص استجابة JSON
Attribute: الاسم الذي تستخدمه للإشارة إلى هذه القيمة لاحقًا في الرحلة

قسم ربط الاستجابة مع حقلي Path و Attribute وزر إضافة ربط في إعدادات webhook

على سبيل المثال، إذا استجاب نظام CRM الخاص بك بـ:

{
  "data": {
    "user": {
      "id": "789xyz"
    }
  }
}

قم بتعيين Path إلى data.user.id و Attribute إلى crm_user_id لالتقاط هذا المعرف.

بعض الأشياء التي يجب معرفتها حول الربط:

Path هو مسار بسيط مفصول بنقاط (مفاتيح الكائنات، وبالنسبة للمصفوفات، الفهارس الرقمية، على سبيل المثال results.0.code). لا يدعم أحرف البدل أو المرشحات، لذلك يمكنه الإشارة فقط إلى قيمة محددة واحدة في كل مرة.
يتم تخزين القيم تمامًا كما تأتي من استجابة JSON (نص أو رقم أو true/false). لا يوجد تحويل للنوع. إذا كنت تخطط لاستخدام قيمة كتاريخ في عنصر Time Delay، فتأكد من أن خدمتك تعيدها بأحد تنسيقات التاريخ التي يدعمها Time Delay.
إذا لم تكن الاستجابة بتنسيق JSON صالح، أو لم يتطابق Path مع أي شيء، فلن يتم إنشاء المتغير المقابل لهذا المستخدم. لا يتم عرض أي خطأ، وتكتمل خطوة Webhook بشكل طبيعي.

استخدام بيانات استجابة webhook في رحلتك

اختبار Webhook

انقر فوق Test webhook للتحقق من صحة تكوين webhook الخاص بك وأن الطلب قد تم إرساله بنجاح.

حفظ الإعدادات الخاصة بك

انقر فوق Apply لحفظ تكوين webhook الخاص بك.