From d5174f8cc76012a629556c38f5b85da1247ee1cc Mon Sep 17 00:00:00 2001 From: Arnab Dutta Date: Mon, 15 Jan 2024 21:04:08 +0530 Subject: [PATCH] docs: webhooks in admin-ui #1538 Signed-off-by: Arnab Dutta --- docs/admin/admin-ui/webhooks.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/admin/admin-ui/webhooks.md b/docs/admin/admin-ui/webhooks.md index c73807227..c13cfa0e5 100644 --- a/docs/admin/admin-ui/webhooks.md +++ b/docs/admin/admin-ui/webhooks.md @@ -9,7 +9,7 @@ tags: Gluu Flex Admin UI serves as a powerful web interface designed to streamline the management and configuration of the Janssen Authentication Server. To further extend its capabilities, Gluu Flex Admin UI integrates the use of webhooks, enabling the execution of custom business logic during the creation, update, and deletion of information on the Janssen Authentication Server. The seamless integration of webhooks into this interface enhances its functionality, offering a dynamic and extensible solution. -Webhooks are a mechanism for automating workflows by allowing external systems to be notified of specific events. In the context of Gluu Flex Admin UI, webhooks can be mapped to crucial operations such as creating, updating, or deleting information on the Janssen Authentication Server. This opens up possibilities for executing custom business logic say of creation/update/delete of a new/existing user, scope, oidc client, custom script etc. To leverage the power of webhooks in Gluu Flex Admin UI, administrators can map one or more webhooks to specific operations within the interface. This mapping establishes a connection between the Admin UI and external systems, ensuring that designated webhooks are triggered when relevant actions take place. +Webhooks are a mechanism for automating workflows by allowing external systems to be notified of specific events. In the context of Gluu Flex Admin UI, webhooks can be mapped to various Admin UI features to execute custom business logic when events associated with those features occur. Administrators can map one or more webhooks to specific feature events using the user interface. ## Webhook management on the UI @@ -17,7 +17,7 @@ The webhook create/update form consists for following fields. |Field|Description|Required| |--|--|--| -|Webhook Id|The unique identifier of webhook|Generated by Admin UI| +|Webhook Id|The unique identifier of webhook|Yes. Generated by Admin UI| |Webhook Name|The name give to webhook|Yes| |URL|The webhook url|Yes| |HTTP Method|The type HTTP request (e.g. GET, POST, PUT, PATCH, DELETE )|Yes| @@ -54,6 +54,6 @@ The webhooks can be mapped with one or more Admin UI feature(s) using the [webho |Users|Add/Edit|https://jans.io/oauth/config/user.write| |Users|Delete|https://jans.io/oauth/config/user.delete| -When the feature action is performed (such as submitting the "create new user" form), the Admin UI displays the consent model with a list of webhooks that will be triggered upon submitting the form. If the user clicks on the Accept button, all the mapped and enabled webhooks will be triggered during user creation. +When the feature action is performed (e.g. submitting the "create new user" form), the Admin UI displays the consent dialog with a list of webhooks that will be triggered upon the successful execution of the event. If the user clicks on the Accept button, all the mapped and enabled webhooks will be triggered during the event execution. ![image](../../assets/admin-ui/webhooks-trigger.png) \ No newline at end of file