Webhooks イベント
このガイドでは、Logto の異なる Webhook イベントを一覧にし、それぞれのイベントが発生するタイミングを説明します。
ユーザーインタラクションフックイベント
| イベントタイプ | 説明 |
|---|---|
| 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 エンドポイント | イベント |
|---|---|
| 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 |
インタラクション API によってトリガーされるイベント
| ユーザーインタラクションアクション | イベント |
|---|---|
| ユーザーのメール / 電話のリンク | User.Data.Updated |
| ユーザーの MFA のリンク | User.Data.Updated |
| ユーザーのソーシャル / SSO のリンク | User.Data.Updated |
| ユーザーのパスワードリセット | User.Data.Updated |
| ユーザー登録 | User.Created |
よくある質問
PostRegister と User.Created の違いは何ですか？
PostRegister と User.Created の違いは何ですか？PostRegister は、ユーザーがサインアップフローを通じて新しいアカウントを正常に作成したときにトリガーされます。User.Created は、Management API を通じて新しいユーザーアカウントが作成されたときにトリガーされます。