跳至主要內容

Webhooks 事件

本指南列出各種 Logto Webhook 事件，並說明每個事件發生的時機。

使用者互動 Hook 事件​

事件類型說明
PostRegister使用者透過 UI 介面成功建立新帳號。
PostSignIn使用者透過 UI 介面成功登入。
PostResetPassword使用者透過「忘記密碼」流程成功重設密碼。

資料變更 Hook 事件​

使用者​

事件類型說明
User.Created建立新使用者帳號。
User.Deleted刪除使用者帳號。
User.Data.Updated更新使用者個人資料，例如電子郵件、頭像、custom.data、社交識別碼等。
User.SuspensionStatus.Updated使用者停權狀態變更（停權或重新啟用）。

角色 (Role)​

事件類型說明
Role.Created建立新角色 (Role)。
Role.Deleted刪除角色 (Role)。
Role.Data.Updated更新角色 (Role) 資料，例如角色名稱、描述、預設角色狀態。
Role.Scopes.Updated指派給角色 (Role) 的權限 (Permissions) 被新增或移除。

權限 (Permission, Scope)​

事件類型說明
Scope.Created建立新的 API 權限 (Permission)。
Scope.Deleted刪除 API 權限 (Permission)。
Scope.Data.Updated更新 API 權限 (Permission) 資料，例如權限描述。

組織 (Organization)​

事件類型說明
Organization.Created建立新組織 (Organization)。
Organization.Deleted刪除組織 (Organization)。
Organization.Data.Updated更新組織 (Organization) 資料，例如組織名稱、描述、custom.data 等。
Organization.Membership.Updated組織 (Organization) 成員被新增或移除。

組織角色 (Organization role)​

事件類型說明
OrganizationRole.Created建立新組織角色 (Organization role)。
OrganizationRole.Deleted刪除組織角色 (Organization role)。
OrganizationRole.Data.Updated更新組織角色 (Organization role) 資料，例如名稱與描述。
OrganizationRole.Scopes.Updated指派給組織角色 (Organization role) 的權限 (Permissions) 被新增或移除。

組織權限 (Organization permission, scope)​

事件類型說明
OrganizationScope.Created建立新組織權限 (Organization permission)。
OrganizationScope.Deleted刪除組織權限 (Organization permission)。
OrganizationScope.Data.Updated更新組織權限 (Organization permission) 資料，例如描述。

Management API 觸發事件​

API endpoint事件
POST /usersUser.Created
DELETE /users/:userIdUser.Deleted
PATCH /users/:userIdUser.Data.Updated
PATCH /users/:userId/custom-dataUser.Data.Updated
PATCH /users/:userId/profileUser.Data.Updated
PATCH /users/:userId/passwordUser.Data.Updated
PATCH /users/:userId/is-suspendedUser.SuspensionStatus.Updated
POST /rolesRole.Created, (Role.Scopes.Update)
DELETE /roles/:idRole.Deleted
PATCH /roles/:idRole.Data.Updated
POST /roles/:id/scopesRole.Scopes.Updated
DELETE /roles/:id/scopes/:scopeIdRole.Scopes.Updated
POST /resources/:resourceId/scopesScope.Created
DELETE /resources/:resourceId/scopes/:scopeIdScope.Deleted
PATCH /resources/:resourceId/scopes/:scopeIdScope.Data.Updated
POST /organizationsOrganization.Created
DELETE /organizations/:idOrganization.Deleted
PATCH /organizations/:idOrganization.Data.Updated
PUT /organizations/:id/usersOrganization.Membership.Updated
POST /organizations/:id/usersOrganization.Membership.Updated
DELETE /organizations/:id/users/:userIdOrganization.Membership.Updated
POST /organization-rolesOrganizationRole.Created, (OrganizationRole.Scopes.Updated)
DELETE /organization-roles/:idOrganizationRole.Deleted
PATCH /organization-roles/:idOrganizationRole.Data.Updated
POST /organization-scopesOrganizationScope.Created
DELETE /organization-scopes/:idOrganizationScope.Deleted
PATCH /organization-scopes/:idOrganizationScope.Data.Updated
PUT /organization-roles/:id/scopesOrganizationRole.Scopes.Updated
POST /organization-roles/:id/scopesOrganizationRole.Scopes.Updated
DELETE /organization-roles/:id/scopes/:organizationScopeIdOrganizationRole.Scopes.Updated

Experience API 觸發事件​

使用者互動行為事件
使用者綁定電子郵件 / 電話User.Data.Updated
使用者綁定 MFAUser.Data.Updated
使用者綁定社交 / SSOUser.Data.Updated
使用者重設密碼User.Data.Updated
使用者註冊User.Created

例外 Hook 事件​

安全性 (Security)​

事件類型說明
Identifier.Lockout由於連續身分驗證失敗，使用者帳號被鎖定。可在以下流程中觸發：
  • 密碼驗證失敗
  • 驗證碼驗證失敗
  • 一次性權杖驗證失敗

常見問題​

PostRegister 與 User.Created 有什麼不同？​

PostRegister 於使用者透過註冊流程成功建立新帳號時觸發；User.Created 則於透過 Management API 建立新使用者帳號時觸發。