< img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=3131724&fmt=gif" />

Set Up Webhook Notification

This section describes how to set up Webhook notification.

Prerequisites

  • You should have the Platform Settings Management permission on the KubeSphere platform. For more information, refer to "Platform Roles".

  • WhizardTelemetry Notification should have been installed and enabled.

  • You should get the access parameters for the Webhook in advance. For more information, please contact your Webhook administrator.

Steps

  1. Log in to the KubeSphere web console with a user who has the Platform Settings Management permission.

  2. Click cogwheel in the upper-right corner of the KubeSphere web console to enter the Platform Settings page.

  3. Click Notification Management > Notification Channels in the left navigation pane.

  4. On the Notification Channels page, click the Webhook tab, set the Webhook notification parameters, and then click OK.

    • Server Settings

      ParameterDescription

      Webhook URL

      The access URL of the Webhook.

      Authentication Type

      The authentication type of the Webhook.

      • No Authentication: No authentication is required.

      • Bearer Token: Use a URL Bearer token for authentication. If you choose this type, you need to further set the token used for authentication.

      • Basic Authentication: Use a username and password for authentication. If you choose this type, you need to further set the username and password used for authentication.

      Skip TLS Verification (Insecure)

      Whether to skip TLS verification when calling the Webhook.

    • Filter Conditions

      The notifications sent by KubeSphere are presented in the form of key-value pairs. When the key and value filled in here match the key and value in the label settings of the alert rules in rule groups, the notifications can be filtered by labels and alert notifications that meet specific label conditions can be sent to receivers. Click Add to set multiple conditions.

      ParameterDescription

      Key

      The key in the notification content. Click the dropdown list to select a preset key, or input a custom key in the dropdown list.

      Operator

      The operator for the filter condition.

      • Contains: The value corresponding to the key contains a specific string.

      • Does Not Contain: The value corresponding to the key does not contain a specific string.

      • Exists: The specific key exists in the notification content.

      • Does Not Exist: The specific key does not exist in the notification content.

      • Regex Match: Filter notifications that meet the conditions through a regular expression.

      Values

      The value corresponding to the key must include the specified string. Press Enter to set multiple strings. If the value corresponding to the key contains any of these strings, the condition is met.

    • Click Send Test Message to confirm that the notification channel is working properly.

  5. In the upper-right corner of the Webhook tab, click the toggle switch to set the Webhook notification function to Enabled.

Receive the latest news, articles and updates from KubeSphere


Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

What’s on this Page