Webhook ช่วยให้ระบบปลายทางของคุณสามารถรับข้อมูลเหตุการณ์จาก PEAK ได้แบบ Event-based เช่น เมื่อมีการสร้าง แก้ไข ยกเลิก หรือบันทึกชำระเอกสารที่เกี่ยวข้อง เพื่อให้ระบบภายนอกสามารถนำข้อมูลไปประมวลผลต่อได้รวดเร็วขึ้น
Webhook เหมาะสำหรับระบบที่ต้องการรับข้อมูลจาก PEAK โดยอัตโนมัติ เช่น ระบบ ERP, CRM, POS, E-Commerce, Data Warehouse หรือ Internal Dashboard
Webhook Setup Overview
| Step | เป้าหมาย |
|---|---|
| 1. Request Activation | แจ้งความประสงค์ขอเปิดใช้งาน Webhook |
| 2. Prepare Setup Information | เตรียมข้อมูล PEAK และ Endpoint ปลายทาง |
| 3. Configuration & Testing | ทีมงานตั้งค่าและให้ลูกค้าทดสอบ Payload |
Step 1: Request Webhook Activation
แจ้งความประสงค์ผ่านทางอีเมล
กรุณาส่งอีเมลเพื่อขอเปิดใช้งาน Webhook โดยระบุรายชื่อผู้รับดังนี้
| Field | รายละเอียด |
|---|---|
| To | [email protected] |
| CC | [email protected], [email protected] |
| Subject แนะนำ | Request to Activate PEAK Webhook - [ชื่อกิจการ / Company Name] |
หลังจากได้รับอีเมลแล้ว เจ้าหน้าที่จะตอบกลับพร้อมส่งแบบฟอร์มลงทะเบียน หรือแจ้งข้อมูลที่ต้องใช้เพิ่มเติมสำหรับการตั้งค่า Webhook
Step 2: Prepare Setup Information
เตรียมข้อมูลสำหรับการตั้งค่าระบบ
ทีม Developer ควรเตรียมข้อมูลล่วงหน้าเป็น 2 ส่วนหลัก ได้แก่
- ข้อมูลอ้างอิงจากระบบ PEAK
- ข้อมูลสำหรับเชื่อมต่อ Endpoint ปลายทางของลูกค้า
Part 1: PEAK Reference Information
| ข้อมูล | รายละเอียด |
|---|---|
| Token | Token ที่ใช้ระบุการเชื่อมต่อกับระบบ PEAK |
| Company Link | ลิงก์กิจการบนระบบ PEAK ที่ต้องการเปิดใช้งาน Webhook |
| Company Link Parameter | URL ต้องมีพารามิเตอร์ ?emi=... ต่อท้าย |
ตัวอย่าง Company Link
Part 2: Endpoint Setup Information
| ข้อมูล | รายละเอียด | ตัวอย่าง |
|---|---|---|
| Endpoint URL | URL ปลายทางที่ต้องการให้ PEAK ส่ง Payload ไปหา | https://api.yourcompany.com/peak/webhook |
| Header Auth | Header สำหรับยืนยันตัวตนของระบบปลายทาง | x-api-key |
| Header Value | Value หรือ Key ที่ระบบปลายทางใช้ตรวจสอบ Request | ควรส่งผ่านช่องทางที่ปลอดภัย |
| Action Type | เหตุการณ์ที่ต้องการรับข้อมูล | Create, Edit, Void, Paid หรือเหตุการณ์ที่ระบบรองรับ |
| Environment | ระบุว่าจะตั้งค่าบน UAT หรือ Production | UAT / Production |
หากต้องส่ง Header Auth, API Key หรือ Secret ให้ทีมงาน ควรส่งผ่านช่องทางที่ปลอดภัย และหลีกเลี่ยงการส่งข้อมูลลับในเอกสารหรืออีเมลที่มีผู้เกี่ยวข้องเกินความจำเป็น
Action Type & Event Handling
ปัจจุบันการตั้งค่า Webhook ของ PEAK จะส่งข้อมูลเหตุการณ์ตาม Action Type ทั้งหมดที่ระบบรองรับของแต่ละ ApiType ไปยัง Endpoint ปลายทางของลูกค้า
ดังนั้น ระบบปลายทางของลูกค้าควรออกแบบให้สามารถรับ Payload จากทุกเหตุการณ์ที่ PEAK ส่งไป และทำการคัดกรอง หรือ Filter เฉพาะ Event ที่ต้องการใช้งานภายในระบบของลูกค้าเอง
PEAK จะส่ง Webhook Event ตาม Action Type ที่รองรับของแต่ละ ApiType ไปยัง Endpoint ที่ตั้งค่าไว้ทั้งหมด หากต้องการใช้เฉพาะบางเหตุการณ์ เช่น Create หรือ PaidPayment แนะนำให้ระบบปลายทางเป็นผู้ Filter Event เองรวมถึงรายการสร้างทีมงานเข้ามาสร้างในระบบ PEAK เองโดยไม่ผ่าน API ก็จะถูกส่งด้วย Webhook ไปด้วย
Event Type
| Event Type | ความหมาย | ตัวอย่างการใช้งาน |
|---|---|---|
| Create | มีการสร้างข้อมูลหรือเอกสารใหม่ | Sync เอกสารใหม่ไปยัง ERP, CRM หรือ Data Platform |
| Edit | มีการแก้ไขข้อมูลหรือเอกสาร | Update ข้อมูลหรือสถานะในระบบปลายทาง |
| Void | มีการยกเลิกเอกสาร | Mark เอกสารเป็นยกเลิกในระบบปลายทาง |
| PaidPayment | มีการบันทึกชำระเงิน | Update Payment Status หรือ Reconcile ยอดรับชำระ |
| VoidPayment | มีการยกเลิกการชำระเงิน | Reverse Payment Status หรือแจ้งเตือนให้ตรวจสอบยอด |
Step 3: Configuration & Payload Testing
ระยะเวลาในการดำเนินการ
หลังจากลูกค้าส่งข้อมูลในแบบฟอร์มครบถ้วนแล้ว ทีมงานจะดำเนินการตั้งค่า Webhook และแจ้งกลับเพื่อเริ่มทดสอบการรับ Payload
| ขั้นตอน | ระยะเวลาโดยประมาณ |
|---|---|
| ตรวจสอบข้อมูลที่ลูกค้าส่งมา | หลังได้รับข้อมูลครบถ้วน |
| ตั้งค่า Webhook | ประมาณ 3–7 วันทำการ |
| แจ้งผลการตั้งค่า | หลังดำเนินการเสร็จ |
| Payload Testing | เริ่มทดสอบร่วมกับทีม Developer ของลูกค้า |
ระยะเวลา 3–7 วันทำการ เริ่มนับจากวันที่ทีมงานได้รับข้อมูลในแบบฟอร์มครบถ้วน หากข้อมูลไม่ครบหรือ Endpoint ปลายทางยังไม่พร้อม อาจทำให้ระยะเวลาดำเนินการขยายออกไป