Skip to main content
Skip table of contents

Managing webhooks

Connector credentials

Before Nexthink can export data to any third-party supported tools, you must create and define new credentials to connect and enable such communication and then apply the credentials when configuring a webhook. Refer to the Connector credentials documentation for more information.

Nexthink uses a mechanism that regulates the delivery of messages sent to third-party tools in order to prevent them from getting overloaded with data. This means that the delivery of information is not immediate and some delays may occur.

Configuring webhooks for the first time

In order to configure a Webhook, you must have Central Administrative privileges and the Integrations module enabled.

Follow these steps to access Webhooks:

  1. Click on the Administration icon in the main menu.

  2. Select Outbound connectors from the Integrations section.

  3. Click on Webhooks from the list of outbound connectors.

Accessing webhooks.

When you access the Webhooks page for the first time, no elements are displayed on the page. The system lists all created webhooks and their total number.

Webhooks overview.

The fields shown for each webhook are:

  • Active: Toggle that enables a webhook to listen to the occurrence of an alert or event in order to perform an action

  • Name: Name of the webhook

  • Credentials: Defines the credentials from the third-party tool that the webhook will push the data to

  • Description: Meaningful description of the action performed by the webhook

Creating a new webhook

  1. Click the New webhook button located to open the webhook configuration page.

  2. Fill out the form:

    • Name the webhook being created.

    • Description of the action performed by the webhook.

    • NQL Conditions is a NQL query that specifies the condition of an alert or event that triggers an action configured in the Request method section. Refer to the Configuring webhook NQL conditions documentation.

    • Credentials specifies the credentials of the third-party tool that is intended to be targeted

    • Request method, Resource and Payload define the information that represents the action executed on the third-party tool. Refer to the Configuring webhook fields: Method, Resource, and Payload documentation for information about request methods, Resource API and Payload.

    • Send test: Refer to the Testing a webhook section on this page.

The image below displays an example of webhook configuration fields.

Creating webhooks.

Testing a webhook

Send Test to verify the correct configuration of Credentials, Request method, Resource and Payload.

The system informs of any mistakes or missing configuration fields.

Testing does not replace any use of variables within the payload, i.e.: {{variable_name}}. The system treats all variables as plain strings.

Testing webhooks.

The image below shows the ServiceNow incident created using the Sent Test button

ServiceNow incident created using Sent test button

In the future, another mechanism will be provided that will replace the placeholders with real values when the Sent Test button is pressed.

Editing a webhook

  1. Edit webhooks by clicking on the pencil icon on the right side of the webhook description.

  2. From the configuration page, modify any of the available fields.

  3. Save or Cancel changes. Keep in mind that the system executes all validations upon saving.

Editing webhooks.

Deleting a webhook

Delete webhooks that are no longer necessary to limit the amount of information sent out to third-party tools.

  1. Click on the trash icon on the right side of the webhook item to remove it from the webhook list.

  2. Once the trash icon is clicked, a pop-up confirms the action.

Deleting a webhook cannot be undone.

Deleting webhooks.

Disabling a webhook

Disabling a webhook disengages the third-party tool even if the NQL conditions satisfy the alert setting requirements.

You can switch off the Active toggle for a webhook in two different places:

  • In the Active column of the list of webhooks on the Webhooks page.

  • On the Webhook edit page by editing the webhook Active property.

Disabling webhooks.

RELATED TASK

Connector credentials

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.