Webhooks 事件

本指南列出不同的 Logto Webhook 事件並解釋每個事件發生的時機。

使用者互動 Hook 事件

事件類型	描述
PostRegister	使用者透過 UI 介面成功創建新帳戶。
PostSignIn	使用者透過 UI 介面成功登入。
PostResetPassword	使用者的密碼透過「忘記密碼」流程成功重設。

資料變更 Hook 事件

使用者

事件類型	描述
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 端點	事件
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
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

Interaction API 觸發的事件

使用者互動操作	事件
使用者電子郵件 / 電話連結	User.Data.Updated
使用者 MFA 連結	User.Data.Updated
使用者社交 / 單一登入 (SSO) 連結	User.Data.Updated
使用者密碼重設	User.Data.Updated
使用者註冊	User.Created

常見問題

PostRegister 和 User.Created 有什麼區別？

PostRegister 是在使用者透過使用者註冊流程成功創建新帳戶時觸發；User.Created 是在透過 Management API 創建新使用者帳戶時觸發。