Configure Webhooks to Receive Event Notifications

You use webhooks to automate sending event notifications from a source application to a destination application. You can configure webhooks to enable Routing Director to send notifications to third-party applications, such as Slack, when the events that you have subscribed to are triggered on the managed devices.

Note:

Internet connectivity is required for Routing Director to connect to third-party applications.

The following section describes how to configure webhooks to receive event notifications in Slack.

To receive webhook notifications in a format that is compatible with Slack, you need to configure an intermediary that can interact with the sending and receiving applications, in this case, Routing Director and Slack. The recommended intermediary platform is Make. To process notifications, Make uses a workflow called Scenario, which converts the notifications to a format that Slack supports. Each event notification is sent to a URL that is generated for the Scenario in Make. The notification is then converted into a format that Slack supports and delivered to the configured Slack channel.

For information about Scenario in Make, see Scenario.

To configure webhooks in Routing Director to send notifications to a Slack channel:

  1. Log in to Make https://www.make.com/en/login. From the home page, navigate to Scenario on the left navigation menu.
  2. Configure the scenario settings as described, see Creating a Scenario.

    Make generates a URL. Whenever an event is triggered, Routing Director sends webhook notifications to this URL.

  3. In the Routing Director GUI, navigate to Organization Settings (Settings Menu > System Settings).

    The Organization Settings page appears.

  4. In the Webhooks tile, enable Webhooks.
  5. Configure the webhooks settings. See Table 1 for webhooks field descriptions.
    Note:

    • In the URL field, enter the URL generated in step 2.

    • Fields marked * are mandatory.

  6. (Optional) Verify Webhook-Slack integration by logging in to the CLI of a device and generating an event.

    For example, run the following commands in the device CLI to generate an alert.

  7. (Optional) Verify that:

    • The event you generated is listed on the Events page (Observability > Events).

    • You received a notification for the event in the Slack channel.

      Note:

      • You must have access to the Slack channel to view event notifications in Slack.

      • You must be an administrator with the Network Admin role to perform corrective action.
    Table 1: Parameters to Configure Webhooks
    Field Description
    Name*

    Enter a name for the webhook. The name can contain alphanumeric and special characters.
    URL*

    Enter the URL generated in Make for the scenario.
    Verify SSL Cert*

    Click to enable or disable (default) verifying SSL certificates of the Webhook destination.
    Secret

    Enter the secret to validate that the notifications received are from valid hosts.

    The secret can contain a string of alphanumeric and special characters.
    Webhook Header

    Webhook custom headers are key-value pairs that provide additional information about the notifications.

    You can add multiple custom headers to:

    • Provide additional information in plain text, along with the default headers, about the webhook notifications being sent to the configured endpoint.

    • Provide security, such as API keys, to verify end-to-end data integrity, for authorization, and so on.

    Click the Add icon (+) to add webhook headers.

    The Webhook Header page appears.

    • Header Key*—Enter a unique key.

    • Header Value*—Enter a unique value for the key. The value can contain alphanumeric characters.

    Click the Delete icon (trash can) to remove the webhook headers.

    Note:

    Use of SHA-1 algorithm to generate webhook algorithm is being deprecated from Routing Director Release 2.10.0. Use SHA-256 algorithm to generate the webhook header. See Deprecation of SHA1-based Webhook Signature Header

    Streaming APIs

    Enable the events for which you want to receive notifications.

    You can subscribe to events such as, alerts, audits, device status, and device alarms to get real-time notifications when the event occurs.

    • Alerts—Click to enable or disable receiving notifications when subscribed alerts are generated on the managed devices. Alerts notification is disabled by default.

    • Audits—Click to enable or disable receiving notifications when a user accesses an organization or modifies organization settings. Audits notification is disabled by default.

    • Device Status—Click to enable or disable receiving notifications when the device status changes due to events such as a link going up or down, or the device getting disconnected from Routing Director, and so on. The Device Status notification is disabled by default.

    • Device Alarms—Click to enable or disable receiving notifications when subscribed alarms are generated on the managed devices. Device Alarm notification is disabled by default.

Deprecation of SHA1-based Webhook Signature Header

When Routing Director sends a webhook event to a configured webhook endpoint, the request includes signature headers that allow the receiving application to verify that the request originated from Routing Director and that the payload has not been modified in transit. Starting from Release 2.10.0, these webhook requests include the following signature headers for verifying signature authenticity:

The SHA1-based X-Mist-Signature header is being deprecated due to weaker security of hashing algorithm. To support existing integrations, both SHA1-based and SHA256-based signature headers are currently included in webhook requests.

To help identify the deprecation, webhook requests also include the following headers:

You should update your webhook validation logic to use X-Mist-Signature-v2 (HMAC-SHA256) and avoid relying on the legacy X-Mist-Signature header.

Note:

We recommend you to migrate to X-Mist-Signature-v2 as soon as possible to ensure uninterrupted webhook validation when the legacy header is retired in future releases.

Related Documentation