تكامل بث الأحداث

نظرة عامة على التكامل

نوع التكامل

المصدر: يتم إرسال البيانات من Pushwoosh إلى نظامك عبر HTTP أو gRPC بناءً على مشغلات الأحداث المكونة.

كيف يعمل التكامل؟

ينقل Pushwoosh بيانات أحداث الاتصالات (مثل نشاط الدفع/البريد الإلكتروني) إلى نقطة نهاية يحددها العميل. يتم إرسال البيانات في تدفقات مجمعة على فترات مجدولة أو عند الوصول إلى الحد الأدنى لحجم الدفعة.

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

مسرد المصطلحات

عنوان URL لنقطة النهاية: نقطة نهاية من جانب الخادم تسمح باستلام الطلبات. يمكن للعميل تحديد منفذ إذا لزم الأمر.

أمثلة:

https://clientdomainname.com/webhook_endpoint
https://clientdomainname.com:8081/webhook_endpoint

قائمة الكيانات المتزامنة

أحداث إحصائيات الاتصالات (مثل، Push Sent، Email Delivered)
أحداث النشر: الأحداث التي يرسلها تطبيقك إلى Pushwoosh عبر postEvent، يتم بثها بشكل منفصل عن أحداث إحصائيات الاتصالات

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

تتبع التفاعل في الوقت الفعلي

مراقبة تفاعلات المستخدم مثل إرسال إشعار الدفع، أو فتح بريد إلكتروني، أو تسليم رسالة فور حدوثها، مما يتيح رؤية فورية لأداء الحملة.

تكامل التحليلات الخارجية

بث الأحداث إلى منصات التحليلات التابعة لجهات خارجية لإعداد التقارार والتحليل المركزي.

سير عمل المستخدم الآلي

تشغيل الإجراءات في الأنظمة الخارجية (مثل CRMs أو أدوات أتمتة التسويق) بناءً على سلوكيات المستخدم، على سبيل المثال، إرسال رسالة متابعة عندما يفتح المستخدم بريدًا إلكترونيًا.

إعداد التكامل

لإعداد التكامل:

في حساب Pushwoosh الخاص بك، انتقل إلى الإعدادات > تكاملات الجهات الخارجية، وابحث عن تكامل بث الأحداث، وانقر على تكوين.

تكوين تكامل بث الأحداث

في النافذة التي تفتح، املأ الحقول اللازمة.

املأ الحقول اللازمة

أدخل عنوان URL لنقطة النهاية

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

مثال

https://clientdomainname.com/webhook_endpoint
https://clientdomainname.com:8081/webhook\_endpoint

حدد الأحداث

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

قدم بيانات اعتماد التفويض

إذا كان الخادم الخاص بك يتطلب ذلك، فأدخل القيمة الكاملة لترويسة Authorization في حقل التفويض.

أمثلة:

Bearer your_token_here
Basic base64encoded_credentials

اختر نوع النقل

من القائمة المنسدلة نوع النقل، اختر بروتوكول التسليم لنقل الأحداث: HTTP أو gRPC. لكل منهما سلوك وتكوين محدد.

HTTP

مع نوع النقل HTTP، يرسل Pushwoosh البيانات على دفعات بناءً على أحد الشروط التالية:

ما لا يقل عن 100 حدث جاهز للإرسال، أو
مرور ساعة واحدة منذ آخر إرسال.

بعد إرسال البيانات، يتم إغلاق الاتصال بمجرد استلام استجابة ناجحة.

إذا استجاب الخادم بخطأ 5xx، فسيقوم Pushwoosh بإعادة محاولة الطلب وفقًا لسياسة إعادة المحاولة المحددة.

آلية إعادة المحاولة

المحاولة	التأخير
الأولى	ثانية واحدة
الثانية	3 ثوانٍ بعد المحاولة الأولى
الثالثة	8 ثوانٍ بعد المحاولة الثانية

إذا فشلت جميع محاولات إعادة المحاولة، يتم تجاهل الطلب.

المهلة

المهلة الافتراضية للطلب هي 30 ثانية. يمكن تخصيص ذلك عند الطلب عبر الدعم.

عرض مثال

gRPC

يستخدم نوع النقل gRPC البث ثنائي الاتجاه لنقل البيانات. تعرف على المزيد في وثائق gRPC.

يتم فتح بث عند استيفاء أحد الشروط التالية:

ما لا يقل عن 1000 حدث جاهز للتسليم
مرور ساعة واحدة منذ آخر بث تم فتحه

يتم إغلاق البث بعد إرسال الأحداث. هذا يضمن عدم فتح بث جديد لكل حدث فردي في وقت قصير.

انظر مواصفات protobuf

آلية إعادة المحاولة يتضمن كل حدث uuid فريدًا. إذا فشل حدث ما:

يجب أن تتضمن الاستجابة status لا يساوي "Success"
يجب تضمين uuid الأصلي من الطلب

سيقوم Pushwoosh بإعادة محاولة التسليم بناءً على هذه الاستجابة.

إعدادات الاتصال

يتم تكوين الخيارات المتقدمة مثل TLS أو keep-alive أو سياسات إعادة المحاولة يدويًا عبر الدعم وقد تتطلب مشاركة التطوير.

تمكين أحداث النشر

هذا المفتاح مغلق افتراضيًا، لذلك يتم بث أحداث إحصائيات الاتصالات فقط. لبث الأحداث التي يرسلها تطبيقك إلى Pushwoosh عبر postEvent أيضًا، قم بتشغيل مفتاح السماح بأحداث النشر.

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

حدد المنصات

في قسم المنصات، حدد منصة واحدة على الأقل لتنشيط بث الأحداث.

حدد منصة واحدة على الأقل

المنصات المدعومة تشمل:

iOS, Android, macOS, Windows, Amazon, Safari
Chrome, Firefox, Internet Explorer, Huawei
Email, SMS, Line, Xiaomi, WhatsApp

تكوين المرشحات المتقدمة

في قسم المرشحات المتقدمة، قم بتحسين معايير تسليم الأحداث باستخدام المرشحات:

أحداث النشاط المباشر: قم بالتمكين لاستلام أحداث النشاط المباشر. تحتوي هذه الأحداث فقط على بيانات وصفية بما في ذلك live_activity_id.
مرشحات الحملة: قم بالتصفية حسب رمز الحملة. سيتم تسليم الأحداث المرتبطة بهذه الحملات فقط.
مرشحات الرسائل: قم بالتصفية حسب رمز الرسالة. سيتم تسليم الأحداث المرتبطة بهذه الرسائل فقط.

تعيين المرشحات المتقدمة

بعد إكمال جميع الحقول المطلوبة، انقر فوق زر تطبيق لحفظ وتنشيط التكامل الخاص بك.

تفاصيل الطلب ومثاله


نقطة النهاية	`https://exampleclientendpoint.com/webhook_endpoint`
طلب HTTP	`POST`
المصادقة	لا
نوع الطلب	المصدر
معنى الطلب	إرسال الطلبات إلى نقطة نهاية الويب هوك
الترويسات	`Content-Type: application/json`

مثال على نص الطلب

{
  "event_name": "Email Opened",
  "message_code": "E682-E6D92B9A-53E24868",
  "campaign_id": 961048,
  "platform": "Email",
  "payload": "Welcome to Headway! 👋",
  "application_code": "XXXXX-XXXXX",
  "hwid": "user@example.com",
  "user_id": "USER_ID",
  "timestamp": 1723799271,
  "journey_title": "",
  "journey_point_title": "5_Welcome_ID_new",
  "attributes": null
}

السمات

من بين أحداث إحصائيات الاتصالات، يتم ملء attributes فقط لأحداث الدفع، مع محتوى خاص بالقناة (Android، iOS، وما إلى ذلك) للمنصة التي تم إرسال الدفع إليها. تحمل أحداث البريد الإلكتروني والرسائل القصيرة فقط الحقول ذات المستوى الأعلى (event_name، platform، payload، وما إلى ذلك). تكون attributes null لتلك الأحداث. ضمن كائن attributes مملوء، يتم حذف الحقول خارج منصة الحدث الخاصة بدلاً من إرسالها كقيم فارغة. راجع webhook.proto للحصول على قائمة الحقول الكاملة.

يحمل حدث النشر أزواج مفتاح/قيمة السمة الخاصة به في attributes.event_attributes بدلاً من ذلك. يبقى message_code و payload فارغين، لأن حدث النشر غير مرتبط برسالة أو حملة.

الاستجابة في الوقت الحالي، يتم تجاهل رمز الاستجابة ونصها.

كيف تعرف أن التكامل يعمل؟

ستبدأ في تلقي طلبات من Pushwoosh على نقطة النهاية التي قمت بتكوينها.