การผสานรวมการสตรีม Event

ภาพรวมการผสานรวม

ประเภทการผสานรวม

Source: ข้อมูลจะถูกส่งจาก Pushwoosh ไปยังระบบของคุณผ่าน HTTP หรือ gRPC ตามทริกเกอร์ event ที่กำหนดค่าไว้

การผสานรวมทำงานอย่างไร

Pushwoosh จะส่งข้อมูล event การสื่อสาร (เช่น กิจกรรมพุช/อีเมล) ไปยัง endpoint ที่ไคลเอนต์กำหนด ข้อมูลจะถูกส่งในรูปแบบสตรีมแบบแบตช์ตามช่วงเวลาที่กำหนดหรือเมื่อถึงขนาดแบตช์ขั้นต่ำ

ข้อมูลจะถูกส่งก็ต่อเมื่อตรงกับ events แพลตฟอร์ม และตัวกรองเสริมที่เลือก (รหัสแคมเปญ/ข้อความ, กิจกรรมสด) endpoint ของไคลเอนต์ต้องพร้อมที่จะรับและตอบกลับสถานะ (เป็นทางเลือก)

คำศัพท์

Endpoint URL: endpoint ฝั่งเซิร์ฟเวอร์ที่อนุญาตให้รับคำขอ ไคลเอนต์อาจระบุพอร์ตหากจำเป็น

ตัวอย่าง:

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

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

Event สถิติการสื่อสาร (เช่น Push Sent, Email Delivered)
Post events: events ที่แอปของคุณส่งไปยัง Pushwoosh ผ่าน postEvent ซึ่งจะถูกสตรีมแยกจาก event สถิติการสื่อสาร

กรณีการใช้งาน

การติดตามการมีส่วนร่วมแบบเรียลไทม์

ตรวจสอบการโต้ตอบของผู้ใช้ เช่น การส่งพุช การเปิดอีเมล หรือการส่งข้อความในขณะที่เกิดขึ้น ทำให้สามารถมองเห็นประสิทธิภาพของแคมเปญได้ทันที

การผสานรวมกับการวิเคราะห์ภายนอก

สตรีม events ไปยังแพลตฟอร์มการวิเคราะห์ของบุคคลที่สามเพื่อการรายงานและการวิเคราะห์แบบรวมศูนย์

เวิร์กโฟลว์ผู้ใช้อัตโนมัติ

ทริกเกอร์การดำเนินการในระบบภายนอก (เช่น CRM หรือเครื่องมือการตลาดอัตโนมัติ) ตามพฤติกรรมของผู้ใช้ เช่น ส่งข้อความติดตามผลเมื่อผู้ใช้เปิดอีเมล

การตั้งค่าการผสานรวม

ในการตั้งค่าการผสานรวม:

ในบัญชี Pushwoosh ของคุณ ไปที่ Settings > 3rd party Integrations ค้นหา Event streaming integration และคลิก Configure

กำหนดค่าการผสานรวมการสตรีม Event

ในหน้าต่างที่เปิดขึ้น ให้กรอกข้อมูลในฟิลด์ที่จำเป็น

กรอกข้อมูลในฟิลด์ที่จำเป็น

ป้อน Endpoint URL

ในฟิลด์ Endpoint URL ให้ป้อน URL แบบเต็มที่จะใช้ส่ง events รวมถึงโปรโตคอลและพอร์ต (ถ้ามี)

ตัวอย่าง

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

เลือก events

จากดรอปดาวน์ Events ให้เลือกอย่างน้อยหนึ่ง event หากไม่เลือก การตรวจสอบความถูกต้องจะล้มเหลว รายการ events จะถูกจัดการโดยแบ็กเอนด์และอาจเปลี่ยนแปลงได้ตลอดเวลา

ระบุข้อมูลรับรองการให้สิทธิ์

หากเซิร์ฟเวอร์ของคุณต้องการ ให้ป้อนค่าที่สมบูรณ์สำหรับ Authorization header ในฟิลด์ Authorization

ตัวอย่าง:

Bearer your_token_here
Basic base64encoded_credentials

เลือกประเภทการส่ง

จากดรอปดาวน์ Transport type ให้เลือกโปรโตคอลการจัดส่งสำหรับการส่ง event: HTTP หรือ gRPC แต่ละประเภทมีพฤติกรรมและการกำหนดค่าเฉพาะ

HTTP

ด้วยประเภทการส่ง HTTP Pushwoosh จะส่งข้อมูลเป็นแบตช์ตามเงื่อนไขข้อใดข้อหนึ่งต่อไปนี้:

มี events อย่างน้อย 100 รายการพร้อมที่จะส่ง หรือ
ผ่านไปหนึ่งชั่วโมงนับจากการส่งครั้งล่าสุด

หลังจากส่งข้อมูลแล้ว การเชื่อมต่อจะถูกปิดเมื่อได้รับการตอบกลับที่สำเร็จ

หากเซิร์ฟเวอร์ตอบกลับด้วย 5xx error Pushwoosh จะพยายามส่งคำขออีกครั้งตามนโยบายการลองใหม่ที่กำหนดไว้

กลไกการลองใหม่

ครั้งที่	การหน่วงเวลา
1	1 วินาที
2	3 วินาทีหลังจากการลองครั้งที่ 1
3	8 วินาทีหลังจากการลองครั้งที่ 2

หากการลองใหม่ทั้งหมดล้มเหลว คำขอจะถูกยกเลิก

การหมดเวลา

การหมดเวลาเริ่มต้นสำหรับคำขอคือ 30 วินาที สามารถปรับแต่งได้ตามคำขอผ่านฝ่ายสนับสนุน

ดูตัวอย่าง

gRPC

ประเภทการส่ง gRPC ใช้ bidirectional streaming สำหรับการส่งข้อมูล เรียนรู้เพิ่มเติมใน เอกสาร gRPC

สตรีมจะเปิดขึ้นเมื่อตรงตามเงื่อนไขข้อใดข้อหนึ่งต่อไปนี้:

มี events อย่างน้อย 1,000 รายการพร้อมสำหรับการจัดส่ง
ผ่านไปหนึ่งชั่วโมงนับจากสตรีมล่าสุดที่เปิด

สตรีมจะถูกปิดหลังจากส่ง events แล้ว สิ่งนี้ช่วยให้แน่ใจว่าจะไม่มีการเปิดสตรีมใหม่สำหรับแต่ละ event ในช่วงเวลาสั้นๆ

ดูข้อกำหนด protobuf

กลไกการลองใหม่
แต่ละ event จะมี uuid ที่ไม่ซ้ำกัน หาก event ล้มเหลว:

การตอบกลับต้องมี status ไม่เท่ากับ "Success"
ต้องมี uuid เดิมจากคำขอรวมอยู่ด้วย

Pushwoosh จะพยายามจัดส่งอีกครั้งตามการตอบกลับนี้

การตั้งค่าการเชื่อมต่อ

ตัวเลือกขั้นสูง เช่น TLS, keep-alive หรือ retry policies จะถูกกำหนดค่าด้วยตนเองผ่านฝ่ายสนับสนุนและอาจต้องอาศัยความช่วยเหลือจากฝ่ายพัฒนา

เปิดใช้งาน post events

โดยค่าเริ่มต้น ตัวสลับนี้จะปิดอยู่ ดังนั้นจะมีเพียง event สถิติการสื่อสารเท่านั้นที่สตรีม หากต้องการสตรีม events ที่แอปของคุณส่งไปยัง Pushwoosh ผ่าน postEvent ด้วย ให้เปิดตัวสลับ Allow post events

จากฟิลด์ Post events ที่ปรากฏขึ้น ให้เลือก events ของบัญชีของคุณที่จะสตรีม ต้องมีอย่างน้อยหนึ่ง event ในขณะที่ตัวสลับเปิดอยู่ หากบัญชีของคุณยังไม่เคยส่ง events ใดๆ รายการนี้จะว่างเปล่าจนกว่าคุณจะเรียก postEvent อย่างน้อยหนึ่งครั้ง

การแสดงผลและการคลิก in-app ก็ส่งผ่านสตรีม post event นี้เช่นกัน ในชื่อ PW_InAppShow และ PW_InAppClicked แต่ละรายการจะปรากฏในรายการ Post events หลังจากที่เกิดขึ้นอย่างน้อยหนึ่งครั้งสำหรับบัญชีแล้วเท่านั้น เช่นเดียวกับ post event อื่นๆ

เลือกแพลตฟอร์ม

ในส่วน Platforms ให้เลือกอย่างน้อยหนึ่งแพลตฟอร์มเพื่อเปิดใช้งานการสตรีม event

เลือกอย่างน้อยหนึ่งแพลตฟอร์ม

แพลตฟอร์มที่รองรับ ได้แก่:

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

กำหนดค่าตัวกรองขั้นสูง

ในส่วน Advanced filters ให้ปรับเกณฑ์การจัดส่ง event โดยใช้ตัวกรอง:

Live activity events: เปิดใช้งานเพื่อรับ live activity events events เหล่านี้มีเพียงข้อมูลเมตาซึ่งรวมถึง live_activity_id
Campaign filters: กรองตามรหัสแคมเปญ เฉพาะ events ที่ผูกกับแคมเปญเหล่านี้เท่านั้นที่จะถูกจัดส่ง
Message filters: กรองตามรหัสข้อความ เฉพาะ events ที่ผูกกับข้อความเหล่านี้เท่านั้นที่จะถูกจัดส่ง

ตั้งค่าตัวกรองขั้นสูง

หลังจากกรอกข้อมูลในฟิลด์ที่จำเป็นทั้งหมดแล้ว ให้คลิกปุ่ม Apply เพื่อบันทึกและเปิดใช้งานการผสานรวมของคุณ

รายละเอียดคำขอและตัวอย่าง


Endpoint	`https://exampleclientendpoint.com/webhook_endpoint`
HTTP Request	`POST`
Authentication	ไม่มี
Request type	Source
Request meaning	ส่งคำขอไปยัง webhook endpoint
Headers	`Content-Type: application/json`

ตัวอย่าง Request body

{
  "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

ในบรรดา event สถิติการสื่อสาร attributes จะถูกเติมข้อมูลสำหรับ push events เท่านั้น โดยมีเนื้อหาเฉพาะช่องทาง (Android, iOS และอื่นๆ) สำหรับแพลตฟอร์มที่พุชถูกส่งไป Email และ SMS events จะมีเฉพาะฟิลด์ระดับบนสุดเท่านั้น (เช่น event_name, platform, payload) attributes จะเป็น null สำหรับ events เหล่านั้น ภายในอ็อบเจกต์ attributes ที่มีข้อมูล ฟิลด์ที่อยู่นอกแพลตฟอร์มของ event เองจะถูกละไว้แทนที่จะส่งเป็นค่าว่าง ดู webhook.proto สำหรับรายการฟิลด์ทั้งหมด

post event จะมีคู่คีย์/ค่าของ attribute อยู่ใน attributes.event_attributes แทน message_code และ payload จะยังคงว่างเปล่า เนื่องจาก post event ไม่ได้ผูกกับข้อความหรือแคมเปญ

การตอบกลับ
ในขณะนี้ รหัสการตอบกลับและเนื้อหาจะถูกละเว้น

คุณจะทราบได้อย่างไรว่าการผสานรวมทำงานอยู่

คุณจะเริ่มได้รับคำขอจาก Pushwoosh ที่ endpoint ที่คุณกำหนดค่าไว้