diff --git a/docs/developers/webhooks/configure-webhooks.mdx b/docs/developers/webhooks/configure-webhooks.mdx index 796028f5280..94416482eda 100644 --- a/docs/developers/webhooks/configure-webhooks.mdx +++ b/docs/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ To create a new webhook in the Logto Console, follow these steps: 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. - Create webhook + Create webhook 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. diff --git a/docs/developers/webhooks/events.mdx b/docs/developers/webhooks/events.mdx index c4c0c8530aa..78cc9084093 100644 --- a/docs/developers/webhooks/events.mdx +++ b/docs/developers/webhooks/events.mdx @@ -116,6 +116,14 @@ This guide list the different Logto webhook events and explains when each event | User password reset | User.Data.Updated | | User registration | User.Created | +## Exception hook events + +### Security + +| Event type | Description | +| ------------------ | ----------------------------------------------------------------- | +| Identifier.Lockout | A user account is locked due to multiple failed sign-in attempts. | + ## FAQs \{#faqs}
diff --git a/docs/developers/webhooks/request.mdx b/docs/developers/webhooks/request.mdx index 1066318c41c..db971629ef9 100644 --- a/docs/developers/webhooks/request.mdx +++ b/docs/developers/webhooks/request.mdx @@ -43,8 +43,18 @@ type UserEntity = { ``` ```tsx +enum ApplicationType { + Native = 'Native', + SPA = 'SPA', + Traditional = 'Traditional', + MachineToMachine = 'MachineToMachine', + Protected = 'Protected', + SAML = 'SAML', +} + type ApplicationEntity = { id: string; + type: ApplicationType; name: string; description?: string; }; @@ -203,3 +213,31 @@ type OrganizationScope = { | OrganizationScope.Created | data | OrganizationScope | | The created organization scope entity. | | OrganizationScope.Data.Updated | data | OrganizationScope | | The updated organization scope entity. | | OrganizationScope.Deleted | data | null | / | | + +## Exception hook events request body + +Available events: `Identifier.Lockout` + +The request body is a JSON object that contains the standard request body fields and additional fields as below: + +```tsx +enum SignInIdentifier { + Email = 'email', + Phone = 'phone', + Username = 'username', +} +``` + +| Field | Type | Optional | Notes | +| ---------------- | ------------------- | -------- | ------------------------------------------------------------------ | +| hookId | `string` | | The identifier in Logto. | +| event | `string` | | Which event that triggers this hook. | +| createdAt | `string` | | The create time of payload in ISO format. | +| userAgent | `string` | ✅ | The user-agent for the request. | +| ip | `string` | ✅ | The IP address for the request. | +| interactionEvent | `string` | ✅ | The interaction event that triggers this hook. | +| sessionId | `string` | ✅ | The Session ID (not Interaction ID) for this event, if applicable. | +| applicationId | `string` | ✅ | The related Application ID for this event, if applicable. | +| application | `ApplicationEntity` | ✅ | The related application info for this event, if applicable. | +| type | `SignInIdentifier` | | The user's identifier type, e.g., email, phone or username. | +| value | `string` | | The user's identifier value that triggered the lockout. | diff --git a/i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index 44a45217aba..2645a765c1b 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/de/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ Um einen neuen Webhook in der Logto Console zu erstellen, folge diesen Schritten 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. - Webhook erstellen + Webhook erstellen 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. diff --git a/i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index f69547760d1..f301922843a 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/es/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ Para crear un nuevo webhook en Logto Console, sigue estos pasos: 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. - Crear webhook + Crear webhook 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. diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index 53589e4cafb..9f1c4903de4 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/fr/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ Pour créer un nouveau webhook dans Logto Console, suivez ces étapes : 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. - Créer un webhook + Créer un webhook 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éé. diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index dba2a1bf7a4..440b8c47753 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ Logto コンソールで新しい webhook を作成するには、次の手順 4. **イベント**: 表示されるモーダルで、この webhook をトリガーする [イベント](/developers/webhooks/webhooks-events) を選択します。サーバーの受信を圧倒しないように、要件を満たす少数のイベントを選択することをお勧めします。Webhook を作成した後、選択したイベントをいつでも変更できます。 - Webhook を作成する + Webhook を作成する 5. **無効化 / 再有効化**: デフォルトでは、Webhook は作成直後にすぐに有効化されます。Webhook を一時的に停止したい場合は、作成後にヘッダーの右上隅にある「三点リーダー」メニューを使用して無効化または再有効化できます。 diff --git a/i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index fb5565afe9d..2a1daa01beb 100644 --- a/i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/ko/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ Logto Console 에서 새로운 웹훅을 생성하려면 다음 단계를 따르 4. **이벤트**: 나타나는 모달에서 이 웹훅을 트리거할 [이벤트](/developers/webhooks/webhooks-events)를 선택하세요. 서버 수신을 과부하시키지 않도록 요구 사항을 충족하는 적은 수의 이벤트를 선택하는 것이 좋습니다. 웹훅을 생성한 후 언제든지 선택한 이벤트를 변경할 수 있습니다. - 웹훅 생성 + 웹훅 생성 5. **비활성화 / 재활성화**: 기본적으로 웹훅은 생성 직후 즉시 활성화됩니다. 웹훅을 일시적으로 중단하려면 생성 후 헤더의 오른쪽 상단에 있는 "Three-Dots" 메뉴를 사용하여 비활성화하거나 재활성화할 수 있습니다. diff --git a/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index 156fb52c915..1ee00d8c579 100644 --- a/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ Para criar um novo webhook no Logto Console, siga estas etapas: 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. - Criar webhook + Criar webhook 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. diff --git a/i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index f8264f73dd4..c9894d52fcf 100644 --- a/i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/th/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ sidebar_position: 2 4. **เหตุการณ์ (Event)**: ในหน้าต่าง modal ที่ปรากฏขึ้น ให้เลือก [เหตุการณ์](/developers/webhooks/webhooks-events) ที่ต้องการให้ trigger webhook นี้ แนะนำให้เลือกเฉพาะเหตุการณ์ที่จำเป็นเพื่อลดภาระการรับข้อมูลของเซิร์ฟเวอร์ คุณสามารถเปลี่ยนเหตุการณ์ที่เลือกได้ตลอดเวลาหลังสร้าง webhook แล้ว - Create webhook + Create webhook 5. **ปิดใช้งาน / เปิดใช้งานอีกครั้ง**: โดยปกติ webhook จะถูกเปิดใช้งานทันทีหลังสร้าง หากต้องการหยุดใช้งานชั่วคราว คุณสามารถปิดหรือเปิดใช้งานอีกครั้งได้ผ่านเมนู "Three-Dots" ที่มุมขวาบนของหัวข้อหลังจากสร้างแล้ว diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index 774587b195a..1a56cf111fd 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ sidebar_position: 2 4. **事件**：在出现的模态中，选择将触发此 Webhook 的所需[事件](/developers/webhooks/webhooks-events)。建议选择满足你要求的较少数量的事件，以避免服务器接收过多请求。创建 Webhook 后，你可以随时更改所选事件。 - 创建 Webhook + 创建 Webhook 5. **禁用 / 激活**：默认情况下，Webhook 在创建后立即激活。如果你想暂时暂停 Webhook，可以使用创建后位于标题右上角的“三点”菜单禁用或重新激活它。 diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx index 0f0f19ff9d6..84ecc5d3535 100644 --- a/i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/developers/webhooks/configure-webhooks.mdx @@ -29,7 +29,7 @@ sidebar_position: 2 4. **事件**：在出現的模態中，選擇將觸發此 Webhook 的 [事件](/developers/webhooks/webhooks-events)。建議選擇符合需求的較少數事件，以避免伺服器接收過多請求。建立 Webhook 後，你可以隨時更改選定的事件。 - Create webhook + Create webhook 5. **停用 / 啟用**：預設情況下，Webhook 在建立後會立即啟用。如果你想暫時暫停 Webhook，可以在建立後使用位於標題右上角的「三點」選單來停用或重新啟用它。 diff --git a/static-localized/en/img/assets/create-webhook-page.png b/static-localized/en/img/assets/create-webhook-page.png deleted file mode 100644 index e28a797d06d..00000000000 Binary files a/static-localized/en/img/assets/create-webhook-page.png and /dev/null differ diff --git a/static-localized/en/img/assets/create-webhook-page.webp b/static-localized/en/img/assets/create-webhook-page.webp new file mode 100644 index 00000000000..9b20e52973f Binary files /dev/null and b/static-localized/en/img/assets/create-webhook-page.webp differ