การผสานการทำงานกับ Webhook

ภาพรวมการผสานการทำงาน

การผสานการทำงานนี้ช่วยให้คุณสามารถตั้งค่า Webhook endpoint เพื่อรับข้อมูลแบบเรียลไทม์จาก Pushwoosh โดยเฉพาะ เหตุการณ์สถานะอีเมล (Email status events) เช่น อีเมลถูกส่ง (Email Sent), อีเมลถูกส่งถึง (Email Delivered), อีเมลตีกลับ (Email Bounced), อีเมลถูกเปิด (Email Opened) เป็นต้น

ประเภทของการผสานการทำงาน

แหล่งที่มา: ข้อมูลจะถูกส่งจาก Pushwoosh ไปยังระบบของคุณผ่านทาง webhook

อภิธานศัพท์

Webhook endpoint: URL ฝั่งเซิร์ฟเวอร์ที่รับคำขอ HTTP POST จาก Pushwoosh ลูกค้าสามารถระบุพอร์ตที่แน่นอนได้

ตัวอย่างแบบไม่มีพอร์ต: https://clientdomainname.com/webhook_endpoint
ตัวอย่างแบบระบุพอร์ต: https://clientdomainname.com:8081/webhook_endpoint

เอนทิตีที่ซิงโครไนซ์

เหตุการณ์สถานะอีเมล (Email status events) ที่ให้ข้อมูลเกี่ยวกับการโต้ตอบของผู้ใช้กับข้อความที่คุณส่ง

การตั้งค่าการผสานการทำงาน

ในการตั้งค่าการผสานการทำงาน:

ในบัญชี Pushwoosh ของคุณ ไปที่ การตั้งค่า (Settings) > การผสานการทำงานกับบุคคลที่สาม (3rd Party Integrations) และค้นหา การผสานการทำงานกับ Webhook (Webhook Integration) คลิก กำหนดค่า (Configure)

ในหน้าต่างที่เปิดขึ้นมา ให้ป้อน URL แบบเต็มของ webhook endpoint แล้วคลิก นำไปใช้ (Apply)

เมื่อกำหนดค่าสำเร็จแล้ว คุณจะเริ่มได้รับคำขอจาก Pushwoosh

วิธีตรวจสอบว่าการผสานการทำงานทำงานถูกต้อง

เมื่อตั้งค่าการผสานการทำงานเรียบร้อยแล้ว คุณจะได้รับคำขอ HTTP POST จาก Pushwoosh ที่ webhook endpoint ที่ระบุไว้

เนื้อหาของคำขอ Webhook

ชื่อฟิลด์	ประเภท	จำเป็น	คำอธิบาย	ตัวอย่าง
event_name	string	ใช่	ชื่อของเหตุการณ์	`"Email Sent"`
message_id	uint64	ไม่	ID ที่ไม่ซ้ำกันของข้อความที่เกี่ยวข้องกับเหตุการณ์	`200XXXX3258`
message_code	string	ใช่	รหัสของข้อความที่เกี่ยวข้องกับเหตุการณ์	`"B780-XXXXXX3C-XXXX0375"`
campaign_id	uint64	ไม่	ID ที่ไม่ซ้ำกันของแคมเปญที่เกี่ยวข้องกับเหตุการณ์	`96XXXX`
platform	string	ใช่	แพลตฟอร์มอุปกรณ์ที่เกี่ยวข้องกับเหตุการณ์ (เช่น iOS, Android, Email)	`"Email"`
application_code	string	ใช่	รหัสของแอปพลิเคชันที่เกี่ยวข้องกับเหตุการณ์	`"3XXXX-XXXX1"`
hwid	string	ใช่	ตัวระบุอุปกรณ์ (HWID) ที่เกี่ยวข้องกับเหตุการณ์	`"example@gmail.com"`
user_id	string	ใช่	User ID ของ Pushwoosh ที่เกี่ยวข้องกับเหตุการณ์	`"15XXXX8"`
payload	string	ไม่	เนื้อหาที่เกี่ยวข้องกับข้อความ ขึ้นอยู่กับแพลตฟอร์ม สำหรับ เหตุการณ์อีเมล (Email events) ฟิลด์นี้จะประกอบด้วย หัวเรื่องอีเมล (email subject) สำหรับแพลตฟอร์มอื่น ๆ อาจมีเนื้อหาที่เกี่ยวข้องอื่น ๆ ที่เฉพาะเจาะจงกับเหตุการณ์ (เช่น เนื้อหาข้อความหรือหัวเรื่อง)	`"Don't miss our summer sale!"`
timestamp	int64	ใช่	เวลาที่เกิดเหตุการณ์ในรูปแบบ UNIX timestamp	`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"
}