تكامل Webhook

مطلوب مساعدة من المطور

ستحتاج إلى مساعدة من فريق التطوير لديك لإعداد التكامل. يرجى مشاركة هذا الدليل معهم.

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

يتيح لك هذا التكامل إعداد نقطة نهاية Webhook لتلقي بيانات في الوقت الفعلي من Pushwoosh، وتحديداً أحداث حالة البريد الإلكتروني، مثل إرسال البريد الإلكتروني، وتسليم البريد الإلكتروني، وارتداد البريد الإلكتروني، وفتح البريد الإلكتروني، وما إلى ذلك.

نوع التكامل

المصدر: يتم إرسال البيانات من Pushwoosh إلى نظامك عبر الويب هوك.

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

نقطة نهاية Webhook: عنوان URL من جانب الخادم يتلقى طلبات HTTP POST من Pushwoosh. يمكن للعملاء تحديد المنفذ الدقيق.

• مثال بدون منفذ: https://clientdomainname.com/webhook_endpoint
• مثال مع تحديد المنفذ: https://clientdomainname.com:8081/webhook_endpoint

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

أحداث حالة البريد الإلكتروني التي توفر بيانات حول تفاعلات المستخدم مع الرسائل التي ترسلها.

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

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

1. في حساب Pushwoosh الخاص بك، انتقل إلى الإعدادات > تكاملات الطرف الثالث وابحث عن تكامل Webhook. انقر فوق تكوين.

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

بمجرد التكوين بنجاح، ستبدأ في تلقي طلبات من Pushwoosh.

كيفية التحقق من أن التكامل يعمل

بمجرد إعداد التكامل، ستبدأ في تلقي طلبات HTTP POST من Pushwoosh على نقطة نهاية الويب هوك المحددة.

نص طلب Webhook

اسم الحقل	النوع	مطلوب	الوصف	مثال
event_name	string	نعم	اسم الحدث	"Email Sent"
message_id	uint64	لا	المعرف الفريد للرسالة المرتبطة بالحدث.	200XXXX3258
message_code	string	نعم	رمز الرسالة المرتبط بالحدث.	"B780-XXXXXX3C-XXXX0375"
campaign_id	uint64	لا	المعرف الفريد للحملة المرتبطة بالحدث.	96XXXX
platform	string	نعم	منصة الجهاز المرتبطة بالحدث (على سبيل المثال، iOS، Android، Email).	"Email"
application_code	string	نعم	رمز التطبيق المرتبط بالحدث.	"3XXXX-XXXX1"
hwid	string	نعم	معرف الجهاز (HWID) المرتبط بالحدث.	"example@gmail.com"
user_id	string	نعم	معرف مستخدم Pushwoosh (User ID) المرتبط بالحدث.	"15XXXX8"
payload	string	لا	يعتمد المحتوى المتعلق بالرسالة على المنصة. بالنسبة لـ أحداث البريد الإلكتروني، يحتوي هذا على موضوع البريد الإلكتروني. بالنسبة للمنصات الأخرى، قد يتضمن هذا محتوى مختلفًا ذا صلة بالحدث (على سبيل المثال، محتوى الرسالة أو عنوانها).	"Don't miss our summer sale!"
timestamp	int64	نعم	الوقت الذي وقع فيه الحدث، بتنسيق الطابع الزمني UNIX.	1723798222
journey_title	string	لا	عنوان الرحلة (Journey) المرتبط بالحدث.	"Summer sale"
journey_point_title	string	لا	عنوان النقطة المحددة داخل الرحلة (Journey) المرتبطة بالحدث.	"5_summer sale_new"

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

{
  "event_name": "Email Sent",
  "message_code": "B780-XXXXXX3C-XXXX0375",
  "campaign_id": 96XXXX,
  "platform": "Email",
  "payload": "Don't miss our summer sale!",
  "application_code": "3XXXX-XXXX1",
  "hwid": "example@gmail.com",
  "user_id": "15XXXX8",
  "timestamp": 1723798222,
  "journey_title": "Summer sale",
  "journey_point_title": "5_summer sale_promoemail"
}