Webhooks - เอกสารประกอบ

ภาพรวม

Webhooks ช่วยให้แอพการผสานการทำงานแบบกำหนดเองสามารถสมัครรับข้อมูลเหตุการณ์ต่างๆ ใน Workplace และรับข้อมูลอัพเดตแบบเรียลไทม์ได้ เมื่อมีการเปลี่ยนแปลงเกิดขึ้นใน Workplace ระบบจะส่งคำขอ HTTPS POST ไปยัง URL การเรียกกลับของแอพการผสานการทำงานแบบกำหนดเองแต่ละรายการที่ได้สมัครรับข้อมูลหัวข้อ Webhook ที่เกี่ยวข้องไว้

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

การรองรับ Webhook สำหรับ Workplace มาจากเฟรมเวิร์กเดียวกันกับที่สนับสนุน Webhooks สำหรับ Facebook

การสมัครรับข้อมูลหัวข้อ Webhook

กล่องโต้ตอบแก้ไขการผสานการทำงานแบบกำหนดเองจะให้แท็บต่างๆ สำหรับหัวข้อ Webhook แต่ละหัวข้อที่แอพใช้งานได้บน Workplace

แท็บ Webhooks ในกล่องโต้ตอบ "แก้ไขการผสานการทำงานแบบกำหนดเอง"

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

คุณสามารถสมัครรับข้อมูล URL ได้ 1 รายการต่อ 1 หัวข้อ Webhook แต่คุณสามารถใช้ URL เดียวกันสำหรับหลายหัวข้อได้

การจัดการคำขอให้ตรวจสอบยืนยัน

เมื่อคุณเพิ่มการสมัครรับข้อมูลใหม่ หรือแก้ไขการสมัครรับข้อมูลที่มีอยู่ เซิร์ฟเวอร์ Facebook จะสร้างคำขอ GET ไปยัง URL การเรียกกลับของคุณเพื่อตรวจสอบยืนยันความถูกต้องของเซิร์ฟเวอร์การเรียกกลับ

ระบบจะนำสตริงการสืบค้นมาต่อท้าย URL นี้โดยมีพารามิเตอร์ต่อไปนี้

hub.mode - สตริง "subscribe" ได้รับการส่งผ่านในพารามิเตอร์นี้
hub.challenge - สตริงแบบสุ่ม
hub.verify_token - ค่า verify_token ที่คุณระบุในตอนที่สร้างการสมัครรับข้อมูล

เมื่อได้รับคำขอ HTTP GET ใน URL การเรียกกลับ คุณสามารถใช้พารามิเตอร์ verify_token เพื่อตรวจสอบว่าคำขอนั้นมาจากเซิร์ฟเวอร์ Facebook

การรักษาความปลอดภัยด้วย Webhook

การเรียกใช้ Webhook ไปยัง URL การเรียกกลับที่ผู้พัฒนากำหนดไว้จะดำเนินการผ่าน HTTPS ทั้งหมด ซึ่งช่วยให้มีการรักษาความปลอดภัยที่ระดับการส่งสำหรับเพย์โหลด Webhook

หากต้องการเสริมการรักษาความปลอดภัยเพิ่มเติม ส่วนหัว HTTPX-Hub-Signature-256 จะรวมอยู่ในเพย์โหลด POST แต่ละรายการ ซึ่งคุณควรใช้เพื่อตรวจสอบยืนยันว่าเพย์โหลดมาจากเซิร์ฟเวอร์ Facebook

หากต้องการรายละเอียดทั้งหมดของลักษณะการทำงานเช่นนี้ โปรดดูเอกสารประกอบเกี่ยวกับเฟรมเวิร์ก Webhook ของ Facebook

หัวข้อ Webhook

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

ในปัจจุบัน Workplace นำเสนอ Webhooks สำหรับหัวข้อและกลุ่มต่อไปนี้

เพจ

ข้อมูลเพิ่มเติมมีอยู่ในเอกสารอ้างอิงสำหรับหัวข้อของเพจ

ช่องการสมัครรับข้อมูล	ลักษณะการทำงาน
`mention`	ทริกเกอร์เมื่อมีการกล่าวถึงเพจการผสานการทำงานแบบกำหนดเอง (บอท) ในกลุ่ม
`messages`	ทริกเกอร์เมื่อมีการส่งข้อความถึงเพจการผสานการทำงานแบบกำหนดเอง (บอท) ใน Work Chat
`message_deliveries`	ทริกเกอร์เมื่อข้อความที่ส่งจากเพจการผสานการทำงานแบบกำหนดเอง (บอท) ไปถึงผู้รับแล้ว
`messaging_postbacks`	ทริกเกอร์เมื่อมีการกดปุ่มโพสต์ย้อนกลับใน Work Chat
`message_reads`	ทริกเกอร์เมื่อผู้รับอ่านข้อความจากเพจการผสานการทำงานแบบกำหนดเอง (บอท) แล้ว

กลุ่ม

ข้อมูลเพิ่มเติมมีอยู่ในเอกสารอ้างอิงสำหรับหัวข้อของกลุ่ม

ช่องการสมัครรับข้อมูล	ลักษณะการทำงาน
`posts`	ทริกเกอร์เมื่อมีการเพิ่ม อัพเดต หรือลบโพสต์ในกลุ่ม
`comments`	ทริกเกอร์ทุกครั้งที่มีการเพิ่มความคิดเห็นใหม่ รวมถึงการอัพเดตหรือลบความคิดเห็นบนโพสต์ในกลุ่ม
`membership`	ทริกเกอร์เมื่อการเป็นสมาชิกในกลุ่มเปลี่ยนแปลงไป

ผู้ใช้

ข้อมูลเพิ่มเติมมีอยู่ในเอกสารอ้างอิงสำหรับหัวข้อของผู้ใช้

ช่องการสมัครรับข้อมูล	ลักษณะการทำงาน
`status`	ทริกเกอร์เมื่อผู้ใช้โพสต์หรือแก้ไขการอัพเดตสถานะในโปรไฟล์ของตนเอง
`events`	ทริกเกอร์ทุกครั้งที่ผู้ใช้สร้าง ยอมรับ หรือปฏิเสธงานกิจกรรม
`message_sends`	ทริกเกอร์ทุกครั้งที่ผู้ใช้ส่งข้อความใน Workplace Chat

ลิงก์

ข้อมูลเพิ่มเติมมีอยู่ในเอกสารเกี่ยวกับพรีวิวที่ได้รับอนุญาต

ช่องการสมัครรับข้อมูล	ลักษณะการทำงาน
`preview`	ทริกเกอร์เมื่อ Workplace จำเป็นต้องดึงข้อมูลเกี่ยวกับ URL
`collection`	เกี่ยวข้องเฉพาะกับแอพในรายการที่อนุญาต ซึ่งรองรับการนำทางในช่องเขียนโพสต์แบบตามลำดับชั้น

การรักษาความปลอดภัย

ข้อมูลเพิ่มเติมมีอยู่ในเอกสารอ้างอิงสำหรับหัวข้อของการรักษาความปลอดภัย

`sessions`

เหตุการณ์ทริกเกอร์เมื่อมีบุคคลเข้าสู่ระบบหรือออกจากระบบ Workplace

เหตุการณ์ ลักษณะการทำงาน

เหตุการณ์	ลักษณะการทำงาน
`log_in`	ผู้ใช้ได้เข้าสู่ระบบ Workplace โดยใช้รหัสผ่านหรือ SSO ไม่ว่าจะใน www หรือแอพมือถือ
`log_out`	ผู้ใช้ได้ออกจากระบบ Workplace โดยใช้รหัสผ่านหรือ SSO ไม่ว่าจะใน www หรือแอพมือถือ โดยไม่รวมการบังคับให้ออกจากระบบที่ผู้ดูแลเป็นผู้เริ่มดำเนินการ (ดู `admin_force_log_out`)

log_in

ผู้ใช้ได้เข้าสู่ระบบ Workplace โดยใช้รหัสผ่านหรือ SSO ไม่ว่าจะใน www หรือแอพมือถือ

log_out

ผู้ใช้ได้ออกจากระบบ Workplace โดยใช้รหัสผ่านหรือ SSO ไม่ว่าจะใน www หรือแอพมือถือ

โดยไม่รวมการบังคับให้ออกจากระบบที่ผู้ดูแลเป็นผู้เริ่มดำเนินการ (ดู admin_force_log_out)

`passwords`

เหตุการณ์ทริกเกอร์เมื่อมีคนเปลี่ยนรหัสผ่านของตนหรือขอรีเซ็ตรหัสผ่าน

เหตุการณ์	ลักษณะการทำงาน
`password_change`	มีการเปลี่ยนรหัสผ่านของผู้ใช้ ซึ่งเป็นผลจากการกู้คืนรหัสผ่านเสร็จสมบูรณ์หรือผ่านการตั้งค่าบัญชีของผู้ใช้รายดังกล่าว
`password_reset_request`	มีการเริ่มต้นขั้นตอนการกู้คืนรหัสผ่านของผู้ใช้ และมีการส่งรหัสไปยังอีเมลของผู้ใช้ดังกล่าว
`password_reset_wrong_code`	ผู้ใช้ป้อนรหัสกู้คืนสำหรับรีเซ็ตรหัสผ่านไม่ถูกต้อง
`password_reset_success`	ขั้นตอนการกู้คืนรหัสผ่านของผู้ใช้รายหนึ่งเสร็จสมบูรณ์แล้ว

`admin_activity`

เหตุการณ์ทริกเกอร์เมื่อมีการเพิ่มหรือลบผู้ดูแลออกจากชุมชน Workplace

เหตุการณ์	ลักษณะการทำงาน
`admin_set_to_unclaimed`	ผู้ดูแลได้ตั้งค่าสถานะบัญชีของผู้ใช้เป็นยังไม่ได้ขอรับสิทธิ์จากแผงควบคุมสำหรับผู้ดูแลหรือผ่าน API การจัดการบัญชี
`admin_force_log_out`	ผู้ดูแลได้บังคับให้ผู้ใช้ออกจากระบบในอุปกรณ์ทั้งหมดจากแผงควบคุมสำหรับผู้ดูแล
`admin_deactivate`	ผู้ดูแลได้ปิดใช้งานบัญชีจากแผงควบคุมสำหรับผู้ดูแลหรือผ่าน API การจัดการบัญชี
`admin_activate_account`	ผู้ดูแลได้เปิดใช้งานบัญชีจากแผงควบคุมสำหรับผู้ดูแลหรือผ่าน API การจัดการบัญชี
`force_password_reset`	ผู้ดูแลได้บังคับให้ผู้ใช้รีเซ็ตรหัสผ่านของตนจากแผงควบคุมสำหรับผู้ดูแล
`admin_create_account`	ผู้ดูแลได้สร้างบัญชีจากแผงควบคุมสำหรับผู้ดูแล

`two_factor`

เหตุการณ์ทริกเกอร์เมื่อมีคนเปิดหรือปิดใช้งานการยืนยันตัวตนแบบสองชั้น

เหตุการณ์ ลักษณะการทำงาน

เหตุการณ์	ลักษณะการทำงาน
`two_factor_enable`	ผู้ใช้ได้เปิดใช้งานการยืนยันตัวตนแบบสองชั้นจากแท็บการตั้งค่า ทั้งนี้ รายการนี้จะไม่บันทึกเวลาที่มีผู้ยืนยันโทรศัพท์หนึ่งๆ แต่จะระบุว่าฟีเจอร์ดังกล่าวได้ถูกเปิดใช้งาน
`two_factor_disable`	ผู้ใช้ได้ปิดใช้งานการยืนยันตัวตนแบบสองชั้นจากแท็บการตั้งค่า ทั้งนี้ รายการนี้จะไม่บันทึกเวลาที่มีผู้ปิดใช้งานการยืนยันตัวตนแบบสองชั้นสำหรับโทรศัพท์หนึ่งๆ แต่จะระบุว่าฟีเจอร์ดังกล่าวได้ถูกปิดใช้งาน

two_factor_enable

ผู้ใช้ได้เปิดใช้งานการยืนยันตัวตนแบบสองชั้นจากแท็บการตั้งค่า ทั้งนี้ รายการนี้จะไม่บันทึกเวลาที่มีผู้ยืนยันโทรศัพท์หนึ่งๆ แต่จะระบุว่าฟีเจอร์ดังกล่าวได้ถูกเปิดใช้งาน

two_factor_disable

ผู้ใช้ได้ปิดใช้งานการยืนยันตัวตนแบบสองชั้นจากแท็บการตั้งค่า ทั้งนี้ รายการนี้จะไม่บันทึกเวลาที่มีผู้ปิดใช้งานการยืนยันตัวตนแบบสองชั้นสำหรับโทรศัพท์หนึ่งๆ แต่จะระบุว่าฟีเจอร์ดังกล่าวได้ถูกปิดใช้งาน