Webhooks - Shifton Help

Webhooks ช่วยให้ Shifton ส่งการแจ้งเตือนแบบเรียลไทม์ไปยังระบบภายนอกของคุณเมื่อเหตุการณ์เฉพาะเกิดขึ้นในบริษัทของคุณ

นี่คืออะไร?

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

ข้อกำหนดเบื้องต้น

ข้อกำหนด	รายละเอียด
บทบาท	Owner หรือ
จุดปลายทาง	URL ที่เข้าถึงได้แบบสาธารณะบนเซิร์ฟเวอร์ของคุณเพื่อรับ webhook payloads
ความรู้	ความเข้าใจพื้นฐานเกี่ยวกับ HTTP requests และ webhooks (หรือมีนักพัฒนาที่เข้าถึงได้)

คำแนะนำทีละขั้นตอน

การเข้าถึงแท็บ Webhooks

จากแถบด้านซ้าย คลิก การผสานรวม

ไปที่หน้า นักพัฒนา

คลิกแท็บ เว็บฮุก

หากยังไม่มีการสร้าง webhook คุณจะเห็นสถานะว่างพร้อมภาพประกอบปริศนา

การสร้าง Webhook ใหม่

คลิกปุ่ม “เว็บฮุกใหม่”

กรอกการกำหนดค่า webhook:

ฟิลด์	คำอธิบาย
URL	URL จุดปลายทางที่ Shifton จะส่งข้อมูลเหตุการณ์
กิจกรรม	เลือกเหตุการณ์ Shifton ที่ควรทริกเกอร์ webhook นี้
ใช้งานอยู่	ตัวสลับเพื่อเปิดหรือปิดใช้งาน webhook

บันทึก webhook

Shifton จะส่ง HTTP POST requests ไปยัง URL ของคุณเมื่อเหตุการณ์ที่เลือกเกิดขึ้น

การจัดการ Webhooks ที่มีอยู่

ในแท็บ Webhooks คุณจะเห็นรายการ webhooks ทั้งหมดที่สร้างไว้

คลิกที่ webhook เพื่อแก้ไขการกำหนดค่า

คุณสามารถเปลี่ยน URL อัปเดตการเลือกเหตุการณ์ หรือสลับสถานะ active

หากต้องการลบ webhook ให้ใช้ตัวเลือกลบ

การทดสอบ Webhook

หลังจากสร้าง webhook ให้ทริกเกอร์เหตุการณ์ที่เกี่ยวข้องใน Shifton (ตัวอย่างเช่น สร้างกะทดสอบ)

ตรวจสอบบันทึกเซิร์ฟเวอร์จุดปลายทางเพื่อยืนยันว่าได้รับ webhook payload แล้ว

หาก payload ไม่มาถึง ให้ตรวจสอบว่า URL ถูกต้องและเข้าถึงได้แบบสาธารณะ

สิทธิ์การเข้าถึง

บทบาท	ดู Webhooks	สร้าง/แก้ไข Webhooks	ลบ Webhooks
Owner	ใช่	ใช่	ใช่
	ใช่	ใช่	ใช่
Manager	ไม่	ไม่	ไม่
Employee	ไม่	ไม่	ไม่

คำถามที่พบบ่อย

ถาม: กะon ใช้รูปแบบใดสำหรับ webhook ชำระเงินloads?
ตอบ: Webhooks ส่งเป็น HTTP POST requests พร้อม JSON body ดูเอกสาร API สำหรับโครงสร้าง payload ที่แน่นอนสำหรับแต่ละประเภทเหตุการณ์

ถาม: ฉันสามารถตั้งค่า เว็บฮุก หลายตัวสำหรับเหตุการณ์เดียวกันได้หรือไม่?
ตอบ: ได้ คุณสามารถสร้าง webhooks หลายตัวที่ฟังเหตุการณ์เดียวกัน โดยแต่ละตัวชี้ไปยัง URL ที่ต่างกัน

ถาม: จะเกิดอะไรขึ้นหากเซิร์ฟเวอร์ของฉันหยุดทำงานเมื่อ webhook ส่ง?
ตอบ: หากจุดปลายทางไม่สามารถเข้าถึงได้ การส่ง webhook อาจล้มเหลว ดูเอกสาร API สำหรับรายละเอียดเกี่ยวกับนโยบายการลองใหม่และการจัดการความล้มเหลว

ถาม: ฉันสามารถกรอง เว็บฮุก ให้ทริกเกอร์เฉพาะสำหรับพนักงานหรือโปรเจกต์ที่ระบุได้หรือไม่?
ตอบ: การเลือกเหตุการณ์ webhook โดยปกติอยู่ที่ระดับประเภทเหตุการณ์ คุณจะต้องกรองข้อมูลที่เข้ามาบนฝั่งเซิร์ฟเวอร์ของคุณเพื่อจัดการพนักงานหรือโปรเจกต์ที่ระบุ

ถาม: ฉันจะรักษาความปลอดภัยจุดปลายทาง webhook ของฉันได้อย่างไร?
ตอบ: พิจารณาใช้ secret token หรือการตรวจสอบลายเซ็นเพื่อยืนยันว่าคำขอที่เข้ามามาจาก Shifton จริง ดูเอกสาร API สำหรับคำแนะนำด้านความปลอดภัย

ปัญหาที่อาจเกิดขึ้นและวิธีแก้ไข

ปัญหา	สาเหตุที่เป็นไปได้	วิธีแก้ไข
Webhook ไม่ทริกเกอร์	Webhook ถูกตั้งเป็น inactive	แก้ไข webhook และตรวจสอบว่าตัวสลับ Active เปิดใช้งานอยู่
จุดปลายทางส่งคืนข้อผิดพลาด	URL ไม่ถูกต้องหรือเซิร์ฟเวอร์หยุดทำงาน	ตรวจสอบว่า URL ถูกต้องและเซิร์ฟเวอร์ทำงานและเข้าถึงได้แบบสาธารณะ
ไม่ได้รับ Payload	ไฟร์วอลล์บล็อกคำขอที่เข้ามา	ตรวจสอบการตั้งค่าไฟร์วอลล์ของเซิร์ฟเวอร์เพื่ออนุญาต POST requests ที่เข้ามาจาก Shifton
Webhook ทริกเกอร์แต่ข้อมูลไม่ครบ	เลือกประเภทเหตุการณ์ผิด	แก้ไข webhook และตรวจสอบว่าเลือกเหตุการณ์ที่ถูกต้อง
แสดงสถานะว่างแม้มี webhooks อยู่	หน้าไม่ได้รีเฟรช	รีเฟรชแท็บ Webhooks เพื่อโหลดข้อมูลล่าสุด
ไม่เห็นปุ่ม “เว็บฮุกใหม่”	สิทธิ์ไม่เพียงพอ	ตรวจสอบว่าคุณมีบทบาท Owner หรือ