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

Configure Webhook Notifications

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 to prepare an account granted the platform-admin role. For more information, see Create Workspaces, Projects, Accounts and Roles.

Configure the Webhook Server

  1. Log in to the KubeSphere web console as the platform-admin user.

  2. Click Platform in 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 the following parameters:

    • URL: URL of the webhook server.

    • Verification Type: Webhook authentication method.

      • No Auth: Skips authentication. All notifications can be sent to the URL.
      • Bearer Token: Uses a token for authentication.
      • Basic Auth: Uses a username and password for authentication.

    Note

    Currently, KubeSphere does not suppot TLS connections (HTTPS). You need to select Skip TLS Certification if you use an HTTPS URL.
  5. Under Notification Settings, turn on/off the Receive Notifications toggle to start/stop sending notifications to the webhook.

  6. Click Save after you finish.


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.