Please note that this is a Technical Preview and consequently that all documentation, content, or updates may contain errors and are provided for limited evaluation only. The Technical Preview, the documentation, and any updates are provided on an ‘as-in’ and ‘as-available’ basis without warranty of any kind, whether express, implied, by operation of law or otherwise. Nexthink specifically disclaims all implied warranties of merchantability, fitness for a particular purpose and non-infringement.

Configuring webhooks for the first time

In order to configure Webhooks you must have Central Admin privileges and the Integrations module enabled.

Follow these steps to access Webhooks:

  • Click on the Administration icon in the main menu.

  • Select Webhooks from the Integrations section.

Accessing Webhooks from the Administration menu

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, see the illustration below.

Webhooks administrative page

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: The 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 for an alert

Click on the New webhook button located on the right side of the page to create a new webhook.

New webhook button

Once clicked, a new page is introduced with the following form:

Creating a new webhook
  • Name: The name of the webhook being created

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

  • Enabled: Whether the webhook is listening to the occurrence of an alert or event in order to perform the configured actions

  • Type: Type of event the webhook is listening to

Currently, webhooks can only listen to alert events that are defined within Nexthink. In the upcoming releases, it will be possible to enable any event to trigger a webhook.

When the Alert type is selected, additional sections of the form appear, see the illustration below:

Form for creating a new webhook
  • 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 NQL Conditions examples section.

  • Connection: 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 Methods, Resources, and Payloads 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.

Editing a webhook

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

Editing a webhook

Once clicked, the configuration page opens with a pre-filled form containing information regarding the webhook.

Editing a 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.

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.

Confirmation pop-up for deleting a webhook

The action of removing a webhook cannot be undone. If the information needs to be retrieved, the webhook will have to be created from scratch.

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

Enabling a webhook on the Webhooks page
  • On the Webhook edit page by editing the webhook Enabled property

Enabling a webhook on the edit page

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.

Testing a webhook

If all the values are properly filled in, the result of calling the third-party tool will be displayed next to the Send Test button:

Successful test message

Unsuccessful call into the third-party tool using Send Test:

Unsuccessful call into the third-party tool using Send Test

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.