Skip to content

Commit 0404f4a

Browse files
committed
docs: add 'Identifier.Lockout' webhook event
1 parent af15620 commit 0404f4a

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/developers/webhooks/events.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,14 @@ This guide list the different Logto webhook events and explains when each event
116116
| User password reset | User.Data.Updated |
117117
| User registration | User.Created |
118118

119+
## Exception hook events
120+
121+
### Security
122+
123+
| Event type | Description |
124+
| ------------------ | ----------------------------------------------------------------- |
125+
| Identifier.Lockout | A user account is locked due to multiple failed sign-in attempts. |
126+
119127
## FAQs \{#faqs}
120128

121129
<details>

docs/developers/webhooks/request.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ type UserEntity = {
4545
```tsx
4646
type ApplicationEntity = {
4747
id: string;
48+
type: ApplicationType;
4849
name: string;
4950
description?: string;
5051
};
@@ -203,3 +204,23 @@ type OrganizationScope = {
203204
| OrganizationScope.Created | data | OrganizationScope | | The created organization scope entity. |
204205
| OrganizationScope.Data.Updated | data | OrganizationScope | | The updated organization scope entity. |
205206
| OrganizationScope.Deleted | data | null | / | |
207+
208+
## Exception hook events request body
209+
210+
Available events: `Identifier.Lockout`
211+
212+
The request body is a JSON object that contains the standard request body fields and additional fields as below:
213+
214+
| Field | Type | Optional | Notes |
215+
| ---------------- | ------------------- | -------- | ------------------------------------------------------------------ |
216+
| hookId | `string` | | The identifier in Logto. |
217+
| event | `string` | | Which event that triggers this hook. |
218+
| createdAt | `string` | | The create time of payload in ISO format. |
219+
| userAgent | `string` || The user-agent for the request. |
220+
| ip | `string` || The IP address for the request. |
221+
| interactionEvent | `string` || The interaction event that triggers this hook. |
222+
| sessionId | `string` || The Session ID (not Interaction ID) for this event, if applicable. |
223+
| applicationId | `string` || The related Application ID for this event, if applicable. |
224+
| application | `ApplicationEntity` || The related application info for this event, if applicable. |
225+
| type | `SignInIdentifier` | | The user's identifier type, e.g., email, phone or username. |
226+
| value | `string` | | The user's identifier value that triggered the lockout. |

0 commit comments

Comments
 (0)