Skip to content

Commit 4e581b1

Browse files
authored
docs: update webhook docs (#1295)
* docs: update create webhook screenshot * docs: add 'Identifier.Lockout' webhook event
1 parent 0103fae commit 4e581b1

File tree

14 files changed

+56
-10
lines changed

14 files changed

+56
-10
lines changed

docs/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To create a new webhook in the Logto Console, follow these steps:
2929

3030
4. **Event**: In the modal that appears, select the desired [events](/developers/webhooks/webhooks-events) that will trigger this webhook. It is recommended to choose a smaller number of events that meet your requirements to avoid overwhelming the server reception. You can change the selected events at any time after creating the webhook.
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Create webhook" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Create webhook" />
3333

3434
5. **Disable / Reactive**: By default, the webhook is activated immediately after creation. If you want to suspend the webhook temporarily, you can disable or reactivate it using the "Three-Dots" menu located in the top-right corner of the header after creating it.
3535

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: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,18 @@ type UserEntity = {
4343
```
4444

4545
```tsx
46+
enum ApplicationType {
47+
Native = 'Native',
48+
SPA = 'SPA',
49+
Traditional = 'Traditional',
50+
MachineToMachine = 'MachineToMachine',
51+
Protected = 'Protected',
52+
SAML = 'SAML',
53+
}
54+
4655
type ApplicationEntity = {
4756
id: string;
57+
type: ApplicationType;
4858
name: string;
4959
description?: string;
5060
};
@@ -203,3 +213,31 @@ type OrganizationScope = {
203213
| OrganizationScope.Created | data | OrganizationScope | | The created organization scope entity. |
204214
| OrganizationScope.Data.Updated | data | OrganizationScope | | The updated organization scope entity. |
205215
| OrganizationScope.Deleted | data | null | / | |
216+
217+
## Exception hook events request body
218+
219+
Available events: `Identifier.Lockout`
220+
221+
The request body is a JSON object that contains the standard request body fields and additional fields as below:
222+
223+
```tsx
224+
enum SignInIdentifier {
225+
Email = 'email',
226+
Phone = 'phone',
227+
Username = 'username',
228+
}
229+
```
230+
231+
| Field | Type | Optional | Notes |
232+
| ---------------- | ------------------- | -------- | ------------------------------------------------------------------ |
233+
| hookId | `string` | | The identifier in Logto. |
234+
| event | `string` | | Which event that triggers this hook. |
235+
| createdAt | `string` | | The create time of payload in ISO format. |
236+
| userAgent | `string` || The user-agent for the request. |
237+
| ip | `string` || The IP address for the request. |
238+
| interactionEvent | `string` || The interaction event that triggers this hook. |
239+
| sessionId | `string` || The Session ID (not Interaction ID) for this event, if applicable. |
240+
| applicationId | `string` || The related Application ID for this event, if applicable. |
241+
| application | `ApplicationEntity` || The related application info for this event, if applicable. |
242+
| type | `SignInIdentifier` | | The user's identifier type, e.g., email, phone or username. |
243+
| value | `string` | | The user's identifier value that triggered the lockout. |

i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Um einen neuen Webhook in der Logto Console zu erstellen, folge diesen Schritten
2929

3030
4. **Ereignis**: Wähle im erscheinenden Modal die gewünschten [Ereignisse](/developers/webhooks/webhooks-events) aus, die diesen Webhook auslösen. Es wird empfohlen, eine kleinere Anzahl von Ereignissen auszuwählen, die deinen Anforderungen entsprechen, um eine Überlastung des Serverempfangs zu vermeiden. Du kannst die ausgewählten Ereignisse jederzeit nach der Erstellung des Webhooks ändern.
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Webhook erstellen" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Webhook erstellen" />
3333

3434
5. **Deaktivieren / Reaktivieren**: Standardmäßig wird der Webhook unmittelbar nach der Erstellung aktiviert. Wenn du den Webhook vorübergehend aussetzen möchtest, kannst du ihn über das "Drei-Punkte"-Menü in der oberen rechten Ecke der Kopfzeile nach der Erstellung deaktivieren oder reaktivieren.
3535

i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Para crear un nuevo webhook en Logto Console, sigue estos pasos:
2929

3030
4. **Evento**: En el modal que aparece, selecciona los [eventos](/developers/webhooks/webhooks-events) deseados que activarán este webhook. Se recomienda elegir un número menor de eventos que cumplan con tus requisitos para evitar sobrecargar la recepción del servidor. Puedes cambiar los eventos seleccionados en cualquier momento después de crear el webhook.
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Crear webhook" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Crear webhook" />
3333

3434
5. **Desactivar / Reactivar**: Por defecto, el webhook se activa inmediatamente después de su creación. Si deseas suspender el webhook temporalmente, puedes desactivarlo o reactivarlo usando el menú de "Tres Puntos" ubicado en la esquina superior derecha del encabezado después de crearlo.
3535

i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Pour créer un nouveau webhook dans Logto Console, suivez ces étapes :
2929

3030
4. **Événement** : Dans la fenêtre modale qui apparaît, sélectionnez les [événements](/developers/webhooks/webhooks-events) souhaités qui déclencheront ce webhook. Il est recommandé de choisir un nombre réduit d'événements qui répondent à vos besoins pour éviter de surcharger la réception du serveur. Vous pouvez modifier les événements sélectionnés à tout moment après la création du webhook.
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Créer un webhook" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Créer un webhook" />
3333

3434
5. **Désactiver / Réactiver** : Par défaut, le webhook est activé immédiatement après sa création. Si vous souhaitez suspendre temporairement le webhook, vous pouvez le désactiver ou le réactiver en utilisant le menu "Trois points" situé dans le coin supérieur droit de l'en-tête après l'avoir créé.
3535

i18n/ja/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Logto コンソールで新しい webhook を作成するには、次の手順
2929

3030
4. **イベント**: 表示されるモーダルで、この webhook をトリガーする [イベント](/developers/webhooks/webhooks-events) を選択します。サーバーの受信を圧倒しないように、要件を満たす少数のイベントを選択することをお勧めします。Webhook を作成した後、選択したイベントをいつでも変更できます。
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Webhook を作成する" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Webhook を作成する" />
3333

3434
5. **無効化 / 再有効化**: デフォルトでは、Webhook は作成直後にすぐに有効化されます。Webhook を一時的に停止したい場合は、作成後にヘッダーの右上隅にある「三点リーダー」メニューを使用して無効化または再有効化できます。
3535

i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Logto Console 에서 새로운 웹훅을 생성하려면 다음 단계를 따르
2929

3030
4. **이벤트**: 나타나는 모달에서 이 웹훅을 트리거할 [이벤트](/developers/webhooks/webhooks-events)를 선택하세요. 서버 수신을 과부하시키지 않도록 요구 사항을 충족하는 적은 수의 이벤트를 선택하는 것이 좋습니다. 웹훅을 생성한 후 언제든지 선택한 이벤트를 변경할 수 있습니다.
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="웹훅 생성" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="웹훅 생성" />
3333

3434
5. **비활성화 / 재활성화**: 기본적으로 웹훅은 생성 직후 즉시 활성화됩니다. 웹훅을 일시적으로 중단하려면 생성 후 헤더의 오른쪽 상단에 있는 "Three-Dots" 메뉴를 사용하여 비활성화하거나 재활성화할 수 있습니다.
3535

i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Para criar um novo webhook no Logto Console, siga estas etapas:
2929

3030
4. **Evento**: No modal que aparece, selecione os [eventos](/developers/webhooks/webhooks-events) desejados que acionarão este webhook. Recomenda-se escolher um número menor de eventos que atendam aos seus requisitos para evitar sobrecarregar a recepção do servidor. Você pode alterar os eventos selecionados a qualquer momento após criar o webhook.
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Criar webhook" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Criar webhook" />
3333

3434
5. **Desativar / Reativar**: Por padrão, o webhook é ativado imediatamente após a criação. Se você quiser suspender o webhook temporariamente, pode desativá-lo ou reativá-lo usando o menu "Três Pontos" localizado no canto superior direito do cabeçalho após criá-lo.
3535

i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ sidebar_position: 2
2929

3030
4. **เหตุการณ์ (Event)**: ในหน้าต่าง modal ที่ปรากฏขึ้น ให้เลือก [เหตุการณ์](/developers/webhooks/webhooks-events) ที่ต้องการให้ trigger webhook นี้ แนะนำให้เลือกเฉพาะเหตุการณ์ที่จำเป็นเพื่อลดภาระการรับข้อมูลของเซิร์ฟเวอร์ คุณสามารถเปลี่ยนเหตุการณ์ที่เลือกได้ตลอดเวลาหลังสร้าง webhook แล้ว
3131

32-
<img src="/img/assets/create-webhook-page.png" alt="Create webhook" />
32+
<img src="/img/assets/create-webhook-page.webp" alt="Create webhook" />
3333

3434
5. **ปิดใช้งาน / เปิดใช้งานอีกครั้ง**: โดยปกติ webhook จะถูกเปิดใช้งานทันทีหลังสร้าง หากต้องการหยุดใช้งานชั่วคราว คุณสามารถปิดหรือเปิดใช้งานอีกครั้งได้ผ่านเมนู "Three-Dots" ที่มุมขวาบนของหัวข้อหลังจากสร้างแล้ว
3535

0 commit comments

Comments
 (0)