Configuring Webhooks

To configure a Webhook, complete the following steps:

  1. On the HPE Aruba Networking Central landing page or in the MSP Global Overview page, click the menu icon.

    The Menu page is displayed with multiple menu items represented as cards.

  2. In the API Gateway card, click Manage.

    The API Gateway landing page is displayed. By default, REST API option is selected.

  3. In the side navigation panel, click Webhooks.

    The Webhooks page is displayed.

  4. Click Create Webhooks.

    The Create Webhook side panel is displayed.

  5. Configure the following information:

    • Name—Name of the Webhooks.

      Note:

      The system restricts the creation of webhooks with reserved names such as admin, root, system, webhook, API, test, null, and undefined. Ensure that you assign a unique and non-reserved name when creating a webhook.

    • Target URL—is an HTTP or HTTPS endpoint on the receiver’s server that listens for incoming webhook requests.

      The following conditions apply when configuring a Target URL:

      • Alerts are not delivered when Slack or Microsoft Teams URLs are configured as the Target URL.

      • HTTP URLs are not supported.

      • The Target URL must use HTTPS and include a valid Fully Qualified Domain Name (FQDN).

      • The webhook server must use port 443. Custom ports are not supported.

    • Message Format—Select the format for the notification message either JSON, or Slack. Select Slack as the message format if the target URL is configured as a Slack URL.

    • Authentication Method—Select any one of the authentication methods. The two types of authentication methods are:

      • API Key—An API key is a unique identifier used to authenticate webhook requests between systems. When a webhook is triggered, the API key is included in the request header or payload. This helps verify that the request originates from a trusted source and ensures secure communication between the sender and the receiver.

        Note:

        • The authorization header must be in the format Authorization: Bearer <apikey>. Custom headers are not supported.

        • Authentication credentials embedded in the target URL are not supported.

      • OIDC—OpenID Connect (OIDC) authentication is an identity layer built on top of the OAuth 2.0 protocol that enables secure authentication of webhook requests. On selecting OIDC as the authentication method you must provide the Client ID, Client Secret, and Well-known URL.a

      Note:

      Sensitive authentication credentials, such as the Client Secret and API Key, are displayed in a masked format after they are configured. To unmask the credentials click on the eye icon.

  6. Click Create.

    The newly created Webhook is added to the webhook table.