Skip to main content
Skip table of contents

Manage 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:

  • Click on the Administration icon in the main menu.

  • Select Outbound connectors from the Integrations section.

  • 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. Once a webhook is created, it will be listed here along with a total number of created webhooks.

Webhooks dashboard

The fields shown for each webhook are:

  • Enabled: 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

  • Type: Type of event the webhook is listening to

  • Connection alias: 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

Click on any of the New webhook buttons located on the page to create a new webhook. A new page is introduced with the following form:

New webhook page
  • Name: name of the webhook being created.

  • Description: meaningful description of the action performed by the webhook.

  • Enabled: switch the toggle to enable or disable the webhook.

  • Type: choose whether the webhook is listening to an Alert or Event in order to perform the configured actions. Once you make a selection additional sections of the form appear.

  • NQL Conditions: NQL query that specifies the condition of an alert or event that should be met to trigger an action configured in the Request method section. To learn more on how to build a valid NQL condition, please refer to the Webhooks NQL examples section.

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

  • Request method: Defines the information that represents the action to be executed on the third-party tool. To learn more about how to configure these fields, please read the Method, resource, and payload documentation.

  • Send test: Please refer to the Testing a webhook section for details.

This action does not replace any use of variables within the payload, i.e.: {{variable_name}}. All variables are treated as plain strings.

Testing a webhook

Send Test is used to verify that the right credentials, method, resources and payload are being configured properly.

The button appears enabled by default. When clicked, it validates mandatory fields in order to execute the call. Any unfilled fields will generate an error on the page, highlighting the field in question.

Validating the form

This action does not process any alert or event. Therefore, the Nexthink variables that are contained in the payload referencing the alert or event values are displayed as plain strings.

The illustration below shows the Microsoft Teams message as tested using the Sent Test button.

Microsoft Teams message as tested using the Sent test button

The illustration 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 which will replace the placeholders with real values when the Sent Test button is pressed.

Editing a webhook

Webhooks can be edited by clicking on the pencil icon on the right side of the webhook’s description.

Editing an existing webhook

Once clicked, the configuration page opens with a pre-filled form containing information regarding the webhook. All the available fields can be modified. Saving or canceling the action takes you back to the Webhooks page. Keep in mind that all validations are executed upon saving the form.

Removing a webhook cannot be undone. You will have to recreate a webhook from scratch to use it again.

Deleting a webhook

Webhooks can be removed when they are no longer necessary, which will limit the amount of information that is sent out to third-party tools.

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

Deleting a webhook

Once the trash icon is clicked, a pop-up appears to confirm the action.

Removing a webhook cannot be undone. You will have to recreate a webhook from scratch to use it again.

Disabling a webhook

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

There may be valid reasons for disabling a webhook and stopping the information from being pushed to the third-party tools until the issue is resolved and the situation is stabilized.

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

  • In the Enabled column of the list of webhooks on the Webhooks page

  • On the Webhook edit page by editing the webhook Enabled property

Enabling and disabling a webhook

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.