เหตุการณ์ Webhooks

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

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

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

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

ผู้ใช้

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

บทบาท

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

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

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

องค์กร

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

บทบาทขององค์กร

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

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

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

เหตุการณ์ที่ถูกกระตุ้นโดย 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 (การจับคู่โดเมนอีเมลหรือผู้ให้บริการ SSO ขององค์กร)	Organization.Membership.Updated

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

ความปลอดภัย

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

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

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

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