การผสานรวม Inbound webhook

ต้องการความช่วยเหลือจากนักพัฒนา

คุณจะต้องได้รับความช่วยเหลือจากทีมพัฒนาของคุณเพื่อตั้งค่าการผสานรวม โปรดแชร์คู่มือนี้กับพวกเขา

Inbound webhook ช่วยให้บริการภายนอกสามารถส่ง event มายัง Pushwoosh ได้โดยตรง เมื่อระบบของบุคคลที่สามเรียกใช้ webhook, Pushwoosh จะตรวจสอบสิทธิ์ของคำขอ, ระบุผู้สมัครสมาชิก, และเริ่ม event ที่จับคู่ไว้ จากนั้น event สามารถเริ่มต้นหรือดำเนิน Journey ต่อไปได้

ใช้ Inbound webhook เพื่อเชื่อมต่อเครื่องมือต่างๆ เช่น CRM, แพลตฟอร์มอีคอมเมิร์ซ, หรือบริการวิเคราะห์ข้อมูล โดยไม่ต้องสร้างหรือดูแลเซิร์ฟเวอร์ของคุณเอง Inbound webhook แต่ละรายการจะเรียกใช้ Pushwoosh event หนึ่งรายการเมื่อได้รับและประมวลผลคำขอที่ตรงกันสำเร็จ

ก่อนที่คุณจะเริ่ม

เตรียมสิ่งต่อไปนี้ก่อนที่คุณจะเปิดการตั้งค่า webhook

1. ตัดสินใจว่า webhook ควรจะเริ่ม Pushwoosh event ใด เลือก event ที่มีอยู่แล้วจากโปรเจกต์ของคุณที่คุณต้องการให้เรียกใช้จากบริการของบุคคลที่สาม ตัวอย่างเช่น CheckoutSuccess หากคุณยังไม่มี event ที่เหมาะสม สร้าง event ใหม่ พร้อมกับ attribute ที่คุณต้องการกรอกข้อมูลจากข้อมูลที่เข้ามา

2. ตรวจสอบให้แน่ใจว่าบริการของบุคคลที่สามของคุณสามารถส่ง webhook ได้ บริการนั้นต้องสามารถส่งคำขอ HTTP POST ไปยัง URL ภายนอกได้เมื่อ event ที่คุณสนใจเกิดขึ้น เช่น การสั่งซื้อใหม่หรือการส่งแบบฟอร์ม

3. ขอตัวอย่าง JSON payload จากบริการของบุคคลที่สามของคุณ นี่คือตัวอย่างข้อมูลขนาดเล็กที่บริการส่งมาในแต่ละ event คุณจะต้องใช้มันเพื่อจับคู่ฟิลด์ payload กับ attribute ของ Pushwoosh event

สร้าง webhook

1. ในบัญชี Pushwoosh ของคุณ ไปที่ Settings → Integrations → Inbound webhooks และคลิก Settings

2. คลิก Create webhook เพื่อเปิดขั้นตอนการตั้งค่า

3. ป้อนชื่อ webhook เพื่อให้คุณสามารถระบุ webhook ในรายการได้ในภายหลัง

4. เลือก Pushwoosh event ที่ควรจะเริ่มทำงานเมื่อ webhook ได้รับคำขอที่ถูกต้อง คุณสามารถเลือกจาก event ที่มีอยู่แล้วในโปรเจกต์ของคุณ หากคุณต้องการสร้าง event ก่อน โปรดดูที่ Events

หมายเหตุ

Webhook หนึ่งรายการจะเรียกใช้ event เพียงหนึ่งรายการเท่านั้น

5. ในส่วน Match incoming data ให้วางตัวอย่าง JSON payload จากบริการของบุคคลที่สามของคุณ Pushwoosh จะโหลดฟิลด์ payload ลงในดรอปดาวน์โดยอัตโนมัติ

หมายเหตุ

หากคุณอัปเดต payload ในภายหลัง ให้คลิก Reload select options เพื่อรีเฟรชดรอปดาวน์ การทำเช่นนี้จะรีเซ็ตการจับคู่ฟิลด์ปัจจุบันของคุณ คุณจะต้องทำการจับคู่ attribute ของคุณใหม่

ตัวอย่าง payload:

{
  "user_id": "12345",
  "email_address": "jane@example.com",
  "mobile": "+15551234567",
  "purchase_date": "2024-03-15",
  "order_number": "ORD-001",
  "price": 99.99,
  "payment_state": "success"
}

6. ในส่วน Identify users by ให้เลือกว่า Pushwoosh ควรจับคู่คำขอที่เข้ามากับผู้ใช้อย่างไร:

• User ID: จับคู่โดยใช้ User ID ภายในของ Pushwoosh
• Email: จับคู่โดยใช้อีเมลแอดเดรส
• Phone: จับคู่โดยใช้หมายเลขโทรศัพท์
• HWID: จับคู่โดยใช้ตัวระบุอุปกรณ์, เบราว์เซอร์, หรืออีเมล

ใน Payload field ให้เลือกฟิลด์ที่มีค่าที่ตรงกัน

7. จับคู่ attribute ของ event แต่ละรายการกับฟิลด์ payload ในแต่ละแถวการจับคู่:

• Event attribute: ชื่อ attribute ใน Pushwoosh เลือกจาก attribute ที่กำหนดไว้สำหรับ event นี้
• Payload field: ฟิลด์จาก payload ที่เข้ามาซึ่งมีค่าอยู่

ตัวอย่างเช่น จับคู่ email กับ email_address, total กับ price, และ order_id กับ order_number

คลิก + Add attribute เพื่อเพิ่มแถว คลิก × เพื่อลบแถว

8. เมื่อการกำหนดค่าเสร็จสมบูรณ์ ให้คลิก Enable หน้าต่าง Webhook URL จะเปิดขึ้น

ต้องการความช่วยเหลือจากนักพัฒนา

ขั้นตอนต่อไปนี้จำเป็นต้องเข้าถึงการตั้งค่า webhook ของบริการของบุคคลที่สามของคุณ แชร์ URL และ Secret กับทีมพัฒนาของคุณ

คัดลอกค่าต่างๆ และวางลงในการตั้งค่า webhook ของระบบภายนอกของคุณ:

• คัดลอก URL และตั้งเป็นปลายทางของ webhook ในบริการของบุคคลที่สามของคุณ
• คัดลอก Secret และวางลงในบริการภายนอกของคุณเป็นค่าของเฮดเดอร์ Authorization ค่านี้รวมคำนำหน้า Bearer อยู่แล้ว ดังนั้นให้ใช้ตามที่เป็นอยู่ Pushwoosh จะปฏิเสธคำขอใดๆ ที่ไม่มีเฮดเดอร์นี้หรือเฮดเดอร์ไม่ตรงกัน

9. หน้าต่างนี้ยังแสดง Example request พร้อมตัวอย่างคำขอ POST คลิก Copy ในบล็อกตัวอย่างเพื่อคัดลอกคำขอทั้งหมด ใช้เพื่อส่งคำขอทดสอบและยืนยันว่า Pushwoosh ยอมรับ webhook หรือแชร์กับทีมของคุณเพื่อใช้เป็นเทมเพลตสำหรับการผสานรวม

หลังจากที่คุณเปิดใช้งาน webhook แล้ว webhook จะปรากฏในรายการ Webhooks พร้อมสถานะเปิดใช้งานและเริ่มรับคำขอ

รายการ Webhooks

รายการ Inbound webhook จะแสดง webhook ทั้งหมดในโปรเจกต์ของคุณ

แต่ละแถวจะแสดง:

• Name: ชื่อ webhook
• Event: Pushwoosh event ที่จะเริ่มทำงานเมื่อ webhook ได้รับคำขอที่ถูกต้อง
• Status: Enabled หรือ Disabled
• Received: จำนวนคำขอที่ webhook ได้รับ
• Last updated: เวลาที่ webhook ถูกเปลี่ยนแปลงล่าสุด

จัดการ webhooks

เปิดเมนูของแถวเพื่อ:

• Edit settings: เปิดการกำหนดค่า webhook เพื่อให้คุณสามารถเปลี่ยนชื่อ, event, การจับคู่ฟิลด์, และการระบุผู้ใช้
• Copy URL: เปิดหน้าต่าง Webhook URL ที่มี URL และ Secret เพื่อให้คุณสามารถคัดลอกได้อีกครั้ง
• Activity log: เปิดบันทึกคำขอสำหรับ webhook นี้
• Delete: ลบ webhook ออกจากรายการ

สำหรับ webhook ที่เปิดใช้งานอยู่ คลิก Disable เพื่อปิดการใช้งานโดยไม่ลบการกำหนดค่า สำหรับ webhook ที่ปิดใช้งานอยู่ คลิก Enable เพื่อเริ่มรับคำขออีกครั้ง

ดูบันทึกกิจกรรม

บันทึกกิจกรรมจะแสดงคำขอที่เข้ามาทั้งหมดสำหรับ webhook ที่เลือก

แผงสรุป

ที่ด้านบน ตรวจสอบสรุปสำหรับ 24 ชั่วโมงที่ผ่านมา:

• Hits: จำนวนคำขอที่เข้ามาทั้งหมดที่ได้รับ
• Success: คำขอที่การตรวจสอบสิทธิ์ผ่าน, พบผู้ใช้, และ event เริ่มทำงาน
• Failed: คำขอที่ไม่ได้รับการประมวลผล คำขอที่ล้มเหลวจะไม่หยุด webhook Pushwoosh จะยังคงรับและประมวลผลคำขอที่ตามมา

สาเหตุของความล้มเหลว	ความหมาย
Auth rejected	shared secret ไม่ตรงกับการกำหนดค่า webhook หากคำขอห้ารายการติดต่อกันล้มเหลวด้วยข้อผิดพลาดนี้ Pushwoosh จะส่งการแจ้งเตือนถึงคุณ อัปเดต secret เพื่อดำเนินการต่อ ไม่จำเป็นต้องเปิดใช้งานใหม่
User identifier field missing	ฟิลด์ payload ที่จับคู่ไว้สำหรับการระบุผู้ใช้ไม่มีอยู่ในคำขอ

รายการคำขอ

แต่ละรายการจะแสดงตัวระบุผู้ใช้ (เช่น User ID หรือ Email), ป้ายสถานะ Success หรือ Failed, การประทับเวลาของคำขอ, และตัวอย่างของ JSON payload ที่ได้รับ คลิก Show เพื่อขยายรายละเอียดคำขอทั้งหมด

ดู event ที่เริ่มโดย webhook ใน User Explorer

เมื่อคำขอ webhook ได้รับการประมวลผลสำเร็จ Pushwoosh จะบันทึก event ใน User Explorer ตำแหน่งที่ปรากฏขึ้นอยู่กับว่าคุณระบุผู้ใช้อย่างไร:

• User ID, Email, หรือ Phone: event จะถูกบันทึกในโปรไฟล์ผู้ใช้ เปิดผู้ใช้และไปที่ Events history
• HWID: event จะถูกบันทึกในอุปกรณ์ที่ตรงกัน เปิดผู้ใช้, ค้นหาอุปกรณ์ใน Active user devices, และไปที่แท็บ Events history ของอุปกรณ์นั้น

ค้นหา event ตามชื่อและขยายเพื่อดู attribute ที่จับคู่ไว้ (เช่น price หรือ products) และ attribute __webhook ที่มี ID ของ webhook

ใช้ Inbound webhook กับ Journey

หลังจากที่ webhook ถูกเปิดใช้งานและเริ่ม event ได้สำเร็จแล้ว ให้ใช้ event ที่เลือกเป็น trigger-based journey entry เมื่อ webhook ได้รับคำขอที่ถูกต้อง Pushwoosh จะเริ่ม event ที่จับคู่ไว้ Journey ใดๆ ที่ใช้ event นี้เป็นทริกเกอร์เริ่มต้นจะเริ่มทำงานโดยอัตโนมัติสำหรับผู้ใช้ที่ตรงกัน