เหตุการณ์ Webhooks (Webhooks events)

คู่มือนี้จะแสดงรายการเหตุการณ์ webhook ของ Logto ที่แตกต่างกันและอธิบายว่าแต่ละเหตุการณ์เกิดขึ้นเมื่อใด

เหตุการณ์ webhook จากการโต้ตอบของผู้ใช้

ประเภทเหตุการณ์	คำอธิบาย
PostRegister	ผู้ใช้สร้างบัญชีใหม่สำเร็จผ่านอินเทอร์เฟซ UI
PostSignIn	ผู้ใช้ลงชื่อเข้าใช้สำเร็จผ่านอินเทอร์เฟซ UI
PostResetPassword	รหัสผ่านของผู้ใช้ถูกรีเซ็ตสำเร็จผ่านขั้นตอน “ลืมรหัสผ่าน”

เหตุการณ์ webhook จากการเปลี่ยนแปลงข้อมูล

ผู้ใช้ (User)

ประเภทเหตุการณ์	คำอธิบาย
User.Created	มีการสร้างบัญชีผู้ใช้ใหม่
User.Deleted	มีการลบบัญชีผู้ใช้ออก
User.Data.Updated	ข้อมูลโปรไฟล์ผู้ใช้ถูกอัปเดต เช่น อีเมล, อวาตาร์, custom.data, ตัวระบุโซเชียล ฯลฯ
User.SuspensionStatus.Updated	สถานะการระงับบัญชีผู้ใช้ถูกเปลี่ยน (ระงับหรือเปิดใช้งานใหม่)

บทบาท (Role)

ประเภทเหตุการณ์	คำอธิบาย
Role.Created	มีการสร้างบทบาทใหม่
Role.Deleted	มีการลบบทบาทออก
Role.Data.Updated	ข้อมูลของบทบาทถูกอัปเดต เช่น ชื่อบทบาท, คำอธิบาย, สถานะบทบาทเริ่มต้น
Role.Scopes.Updated	มีการเพิ่มหรือลบสิทธิ์ (permissions) ที่กำหนดให้กับบทบาท

สิทธิ์ (ขอบเขต) (Permission (Scope))

ประเภทเหตุการณ์	คำอธิบาย
Scope.Created	มีการสร้างสิทธิ์ API ใหม่
Scope.Deleted	มีการลบสิทธิ์ API ออก
Scope.Data.Updated	ข้อมูลของสิทธิ์ API ถูกอัปเดต เช่น คำอธิบายสิทธิ์

องค์กร (Organization)

ประเภทเหตุการณ์	คำอธิบาย
Organization.Created	มีการสร้างองค์กรใหม่
Organization.Deleted	มีการลบองค์กรออก
Organization.Data.Updated	ข้อมูลขององค์กรถูกอัปเดต เช่น ชื่อองค์กร, คำอธิบาย, custom.data ฯลฯ
Organization.Membership.Updated	มีการเพิ่มหรือลบผู้ใช้หรือแอปพลิเคชันออกจากองค์กร Payload จะมี ฟิลด์ delta ของสมาชิก

บทบาทขององค์กร (Organization role)

ประเภทเหตุการณ์	คำอธิบาย
OrganizationRole.Created	มีการสร้างบทบาทขององค์กรใหม่
OrganizationRole.Deleted	มีการลบบทบาทขององค์กรออก
OrganizationRole.Data.Updated	ข้อมูลของบทบาทองค์กรถูกอัปเดต เช่น ชื่อบทบาทองค์กรและคำอธิบาย
OrganizationRole.Scopes.Updated	มีการเพิ่มหรือลบสิทธิ์ที่กำหนดให้กับบทบาทขององค์กร

สิทธิ์ขององค์กร (ขอบเขต) (Organization permission (scope))

ประเภทเหตุการณ์	คำอธิบาย
OrganizationScope.Created	มีการสร้างสิทธิ์ขององค์กรใหม่
OrganizationScope.Deleted	มีการลบสิทธิ์ขององค์กรออก
OrganizationScope.Data.Updated	ข้อมูลของสิทธิ์ขององค์กรถูกอัปเดต เช่น คำอธิบายสิทธิ์ขององค์กร

อุปกรณ์ที่เชื่อถือได้ (Trusted device)

ประเภทเหตุการณ์	คำอธิบาย
TrustedDevice.Created	มีการสร้างระเบียนอุปกรณ์ที่เชื่อถือได้หลังจากการยืนยันตัวตนสำเร็จ
TrustedDevice.Deleted	ผู้ใช้หรือผู้ดูแลระบบลบระเบียนอุปกรณ์ที่เชื่อถือได้ออก

การหมดอายุโดยธรรมชาติจะไม่ส่ง webhook TrustedDevice.Expired เพราะการหมดอายุเป็นการเปลี่ยนแปลงความถูกต้องตามเวลา ไม่ใช่การเปลี่ยนแปลงข้อมูลโดยแอปพลิเคชัน Payload ของ TrustedDevice.Created จะมี expiresAt เพื่อให้ผู้ใช้งานสามารถคำนวณเวลาหมดอายุที่คาดไว้ได้ การใช้งานสำเร็จและการเปลี่ยนนโยบายอุปกรณ์ที่เชื่อถือได้จะไม่ส่ง lifecycle webhook

เหตุการณ์ที่ถูกกระตุ้นโดย Management API

API endpoint	เหตุการณ์
POST /users	User.Created
DELETE /users/:userId	User.Deleted
PATCH /users/:userId	User.Data.Updated
PATCH /users/:userId/custom-data	User.Data.Updated
PATCH /users/:userId/profile	User.Data.Updated
PATCH /users/:userId/password	User.Data.Updated
PATCH /users/:userId/is-suspended	User.SuspensionStatus.Updated
POST /roles	Role.Created, (Role.Scopes.Update)
DELETE /roles/:id	Role.Deleted
PATCH /roles/:id	Role.Data.Updated
POST /roles/:id/scopes	Role.Scopes.Updated
DELETE /roles/:id/scopes/:scopeId	Role.Scopes.Updated
POST /resources/:resourceId/scopes	Scope.Created
DELETE /resources/:resourceId/scopes/:scopeId	Scope.Deleted
PATCH /resources/:resourceId/scopes/:scopeId	Scope.Data.Updated
POST /organizations	Organization.Created
DELETE /organizations/:id	Organization.Deleted
PATCH /organizations/:id	Organization.Data.Updated
PUT /organizations/:id/users	Organization.Membership.Updated
POST /organizations/:id/users	Organization.Membership.Updated
DELETE /organizations/:id/users/:userId	Organization.Membership.Updated
PUT /organizations/:id/applications	Organization.Membership.Updated
POST /organizations/:id/applications	Organization.Membership.Updated
DELETE /organizations/:id/applications/:applicationId	Organization.Membership.Updated
PUT /organization-invitations/:id/status (Accepted)	Organization.Membership.Updated
POST /organization-roles	OrganizationRole.Created, (OrganizationRole.Scopes.Updated)
DELETE /organization-roles/:id	OrganizationRole.Deleted
PATCH /organization-roles/:id	OrganizationRole.Data.Updated
POST /organization-scopes	OrganizationScope.Created
DELETE /organization-scopes/:id	OrganizationScope.Deleted
PATCH /organization-scopes/:id	OrganizationScope.Data.Updated
PUT /organization-roles/:id/scopes	OrganizationRole.Scopes.Updated
POST /organization-roles/:id/scopes	OrganizationRole.Scopes.Updated
DELETE /organization-roles/:id/scopes/:organizationScopeId	OrganizationRole.Scopes.Updated

เหตุการณ์ที่ถูกกระตุ้นโดย Experience API

การกระทำของผู้ใช้	เหตุการณ์
การเชื่อมโยงอีเมล/โทรศัพท์ของผู้ใช้	User.Data.Updated
การเชื่อมโยง MFA ของผู้ใช้	User.Data.Updated
การเชื่อมโยงโซเชียล/SSO ของผู้ใช้	User.Data.Updated
การรีเซ็ตรหัสผ่านของผู้ใช้	User.Data.Updated
การลงทะเบียนผู้ใช้	User.Created
ผู้ใช้ถูกจัดเตรียมเข้าสู่องค์กรโดยอัตโนมัติผ่าน Just-in-Time provisioning (โดเมนอีเมลตรงหรือ SSO connector)	Organization.Membership.Updated

เหตุการณ์ webhook ข้อยกเว้น

ความปลอดภัย (Security)

ประเภทเหตุการณ์	คำอธิบาย
Identifier.Lockout	บัญชีผู้ใช้ถูกล็อกเนื่องจากพยายามยืนยันตัวตนผิดติดต่อกันหลายครั้ง สามารถเกิดขึ้นได้ในขั้นตอน: ตรวจสอบรหัสผ่านผิด ตรวจสอบรหัสยืนยันผิด ตรวจสอบโทเค็นแบบใช้ครั้งเดียวผิด
Message.RateLimited	ผู้ใช้ปลายทางส่งคำขอรับรหัสยืนยันเกิน ขีดจำกัดการส่งต่อผู้รับ จะถูกส่งเฉพาะเส้นทางส่งของผู้ใช้ปลายทาง (Experience API และ Account API) โดย payload คือ { action, recipient }
Grant.LimitExceeded	การอนุญาต (Authorization) สำเร็จทำให้ผู้ใช้เกิน จำนวนอุปกรณ์ที่ลงชื่อเข้าใช้พร้อมกันสูงสุดต่อแอป (maxAllowedGrants) Logto จะเพิกถอน grant ที่เก่าที่สุดของแอปนั้น

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

ความแตกต่างระหว่าง PostRegister กับ User.Created คืออะไร?

PostRegister จะถูกกระตุ้นเมื่อผู้ใช้สร้างบัญชีใหม่สำเร็จผ่านขั้นตอนลงทะเบียนของผู้ใช้ ส่วน User.Created จะถูกกระตุ้นเมื่อมีการสร้างบัญชีผู้ใช้ใหม่ผ่าน Management API