跳至主要內容

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）​

事件類型描述
Scope.Created創建新的 API 權限。
Scope.Deleted刪除 API 權限。
Scope.Data.Updated更新 API 權限的資料，例如權限描述。

組織​

事件類型描述
Organization.Created創建新組織。
Organization.Deleted刪除組織。
Organization.Data.Updated更新組織資料，例如組織名稱、描述、custom.data 等。
Organization.Membership.Updated使用者或應用程式被新增或移除出組織。負載包含 membership delta fields。

組織角色​

事件類型描述
OrganizationRole.Created創建新組織角色。
OrganizationRole.Deleted刪除組織角色。
OrganizationRole.Data.Updated更新組織角色資料，例如組織角色名稱和描述。
OrganizationRole.Scopes.Updated為組織角色分配的權限被新增或移除。

組織權限（Scope）​

事件類型描述
OrganizationScope.Created創建新的組織權限。
OrganizationScope.Deleted刪除組織權限。
OrganizationScope.Data.Updated更新組織權限的資料，例如組織權限描述。

Management API 觸發的事件​

API 端點事件
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
PUT /organizations/:id/applicationsOrganization.Membership.Updated
POST /organizations/:id/applicationsOrganization.Membership.Updated
DELETE /organizations/:id/applications/:applicationIdOrganization.Membership.Updated
PUT /organization-invitations/:id/status (Accepted)Organization.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
使用者 MFA 連結User.Data.Updated
使用者社交/SSO 連結User.Data.Updated
使用者密碼重設User.Data.Updated
使用者註冊User.Created
使用者透過 即時佈建 (JIT, Just-in-Time provisioning) 自動佈建到組織（匹配電子郵件域或企業級 SSO 連接器）Organization.Membership.Updated

異常 hook 事件​

安全性​

事件類型描述
Identifier.Lockout使用者帳戶因連續身份驗證失敗而被鎖定。可能在以下流程中觸發：
  • 密碼驗證失敗
  • 代碼驗證失敗
  • 一次性權杖驗證失敗

常見問題​

PostRegister 和 User.Created 有什麼區別？​

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