ข้ามไปยังเนื้อหา
เอกสารสำหรับนักพัฒนาการสนับสนุน ขอสาธิต เข้าสู่ระบบ
Pushwoosh.com

Webhook

Webhook ช่วยให้คุณสามารถส่งข้อมูล Journey ไปยังบริการภายนอก เช่น ระบบวิเคราะห์, ระบบ CRM และเครื่องมือทางการตลาด คุณสามารถ:

  • แจ้งเตือนระบบภายนอกเมื่อลูกค้าดำเนินการบางอย่างใน Journey
  • ส่งข้อมูลลูกค้าไปยังเครื่องมือวิเคราะห์
  • ทริกเกอร์อีเมล, SMS หรือ WhatsApp ของบุคคลที่สามตามเหตุการณ์ Journey ที่ระบุ

วิธีการตั้งค่าองค์ประกอบ Webhook

Anchor link to

เพิ่มองค์ประกอบ Webhook

Anchor link to

ลากและวางองค์ประกอบ Webhook ไปยัง canvas วาง Webhook ที่ใดก็ได้ที่คุณต้องการ โดยคำนึงถึงข้อมูล Journey ที่คุณจะส่งไปยังบริการของบุคคลที่สาม

องค์ประกอบ Webhook บน canvas พร้อมการตั้งค่าชื่อและคำขอ

ตั้งชื่อขั้นตอน Webhook และระบุ URL และประเภทของคำขอ

Anchor link to

ในช่อง STEP NAME ให้ป้อนชื่อสำหรับ webhook อาจเป็นประโยชน์ในการตั้งชื่อ webhook ตามบริการที่ส่งข้อมูลไปหรือตามกรณีการใช้งาน

ถัดไป ในช่อง URL ให้ระบุ URL ของคำขอที่จะส่งข้อมูลไป ถัดจากช่อง URL ให้เลือกประเภทของคำขอจากเมนูแบบเลื่อนลง REQUEST TYPE: GET หรือ POST

อินเทอร์เฟซการกำหนดค่า Webhook ที่แสดงช่อง URL และเมนูแบบเลื่อนลง REQUEST TYPE สำหรับเลือกเมธอด GET หรือ POST

กำหนดค่า Headers

Anchor link to

ในส่วน HEADERS ให้ตั้งค่าประเภทเนื้อหา

โดยค่าเริ่มต้น ประเภทเนื้อหาคือ application/json หากบริการที่คุณกำลังส่ง webhook ไปต้องการประเภทเนื้อหาอื่น ให้ป้อนประเภทที่เหมาะสมในค่า header Content-Type

ตัวอย่างของประเภทเนื้อหาคือ:

  • x-www-form-urlencoded
  • text/plain
  • text/xml

เพิ่ม header เพิ่มเติมหากจำเป็นโดยคลิก + ADD HEADER คุณสามารถลบ header ใดก็ได้โดยคลิกที่ไอคอน ‘x’ ที่อยู่ถัดไป

ตัวอย่างเช่น API บางตัวอาจต้องการ HTTP Basic authentication ในการรับรองความถูกต้องของคำขอดังกล่าว ให้ทำดังต่อไปนี้:

  1. เปิดโปรแกรมแก้ไขข้อความธรรมดาและพิมพ์ชื่อผู้ใช้และรหัสผ่านของคุณโดยไม่มีเว้นวรรค คั่นด้วยเครื่องหมายโคลอน ตัวอย่างเช่น: myuser:mypass
  2. เข้ารหัสสตริงนี้เป็น Base64
  3. คัดลอกสตริง Base64 ที่ได้ (ตัวอย่างเช่น bXl1c2VyOm15cGFzcw==)
  4. ในการตั้งค่า webhook ให้เพิ่ม header Authorization พร้อมค่า: Basic <YOUR BASE64 STRING> ตรวจสอบให้แน่ใจว่ามีเว้นวรรคหลังคำว่า “Basic”
ตัวอย่าง header Authorization สำหรับ Basic authentication ในการตั้งค่า webhook ที่แสดง header Content-Type และ Authorization

เพิ่ม JSON request body

Anchor link to

ในส่วน DATA ให้ป้อน JSON request body ของคุณ ตรวจสอบให้แน่ใจว่า request body อยู่ในรูปแบบ JSON ที่ถูกต้อง

ตัวอย่าง:

{
  "hwid": "{{device:hwid}}"
}

ใช้ข้อมูลไดนามิกและมาโคร

Anchor link to

แผง DATA BUILDER ช่วยให้คุณสามารถแทรกข้อมูลไดนามิก (เช่น ข้อมูลผู้ใช้, อุปกรณ์, แท็ก หรือเหตุการณ์) ลงใน JSON request body ของคุณได้โดยตรง ด้วย Dynamic Data คุณสามารถรวมค่าเฉพาะสำหรับผู้ใช้แต่ละรายที่กำลังดำเนินไปใน Journey ได้

สำหรับสิ่งนี้:

  1. เลือก หมวดหมู่ คุณสามารถดึงข้อมูลจากสามหมวดหมู่:

  • Device: ใช้ข้อมูลอุปกรณ์เมื่อคุณต้องการข้อมูลทางเทคนิคที่ผูกกับอุปกรณ์ของผู้ใช้

  • Tag: ใช้ข้อมูลแท็กเมื่อคุณต้องการส่งข้อมูลที่จัดเก็บไว้ในโปรไฟล์ผู้ใช้

  • Event: ใช้ข้อมูลเหตุการณ์เมื่อ webhook ควรส่งค่าจากเหตุการณ์ที่ทริกเกอร์ Journey

  1. เลือก พารามิเตอร์ (ตัวอย่างเช่น HWID, หมวดหมู่โปรด ฯลฯ)
  2. Pushwoosh จะสร้างมาโครที่มีลักษณะดังนี้:
{{tag:Language}}
  1. คัดลอกมาโครและวางลงใน JSON body ของคุณในส่วน DATA

เมื่อ webhook ทำงานใน Journey ที่เผยแพร่แล้ว Pushwoosh จะแทนที่มาโครด้วยค่าจริงสำหรับผู้ใช้นั้นโดยอัตโนมัติ

แทรกตัวยึดตำแหน่ง Dynamic Data ลงใน request body ของ webhook

แมปข้อมูลการตอบกลับของ webhook กับตัวแปร

Anchor link to

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

ในส่วน RESPONSE MAPPING คลิก + ADD MAPPING และกรอกข้อมูลในสองช่องสำหรับแต่ละค่าที่คุณต้องการจับ:

  • Path: ตำแหน่งของค่าภายใน response JSON body
  • Attribute: ชื่อที่คุณใช้อ้างอิงถึงค่านี้ในภายหลังใน Journey
ส่วนการแมปการตอบกลับพร้อมช่อง Path และ Attribute และปุ่ม Add mapping ในการตั้งค่า webhook

ตัวอย่างเช่น หาก CRM ของคุณตอบกลับด้วย:

{
  "data": {
    "user": {
      "id": "789xyz"
    }
  }
}

ตั้งค่า Path เป็น data.user.id และ Attribute เป็น crm_user_id เพื่อจับ ID นั้น

การใช้ข้อมูลการตอบกลับของ webhook ใน Journey ของคุณ

ทดสอบ Webhook

Anchor link to

คลิก Test webhook เพื่อตรวจสอบว่าการกำหนดค่า webhook ของคุณถูกต้องและคำขอถูกส่งสำเร็จ

บันทึกการกำหนดค่าของคุณ

Anchor link to

คลิก Apply เพื่อบันทึกการกำหนดค่า webhook ของคุณ