diff --git a/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md b/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md index e1b2289f0..ab6c6f31f 100644 --- a/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md +++ b/content/en/docs/cluster-administration/platform-settings/notification-management/configure-webhook.md @@ -1,10 +1,40 @@ --- -title: "Configure Webhook" -keywords: 'KubeSphere, Kubernetes, custom, platform' -description: '' -linkTitle: "Configure Webhook" +title: "Configure Webhook Notifications" +keywords: 'KubeSphere, Kubernetes, custom, platform, webhook' +description: 'Configure a webhook server to receive platform notifications through the webhook.' +linkTitle: "Configure Webhook notifications" weight: 8725 --- -TBD +A webhook is a way for an app to send notifications triggered by specific events. It delivers information to other applications in real time, allowing users to receive notifications immediately. +This tutorial describes how to configure a webhook server to receive platform notifications. + +## Prerequisites + +You need an account granted the `platform-admin` role. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../../quick-start/create-workspace-and-project/). + +## Configure the Webhook Server + +1. Log in to the KubeSphere web console as the `platform-admin` user. + +2. Click **Platform** on the upper-left corner and select **Platform Settings**. + +3. In the left nevigation pane, click **Webhook** under **Notification Management**. + +4. On the **Webhook** page, configure your webhook server by filling in the text boxes. The parameters are described as follows: + + - **URL**: URL of the webhook server. + + - **Verification Type**: Select a verification method for security authentication. + - **No Auth**: Skip the authentication. It means that all notifications can be sent to the URL. + - **Bearer Token**: Add a token to the URL for unique identification. + - **Basic Auth**: Provide a username and password for authentication. + + {{< notice note>}}Currently, Kubesphere does not suppot TLS connections (https). You need to select the checkbox on the left of **Skip TLS Certification** if you use https. + + {{}} + +5. Click **Save** after you finish. + +6. (Optional) You can click / to turn on/off webhook notifications. After you finish, click **Update** to save the changes. diff --git a/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch-1.png b/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch-1.png new file mode 100644 index 000000000..2aa3b5976 Binary files /dev/null and b/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch-1.png differ diff --git a/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch.png b/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch.png new file mode 100644 index 000000000..5352f1cb5 Binary files /dev/null and b/static/images/docs/cluster-administration/platform-settings/notification-management/configure-webhook/toggle-switch.png differ