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:
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.
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.
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
Click the New webhook button located to open the webhook configuration page.
Fill out the form:
Name: name of the webhook being created.
Description: meaningful description of the action performed by the 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. Refer to the Webhooks NQL examples documentation.
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. Refer to the 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.
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.
The image below shows the ServiceNow incident created using the 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
Edit webhooks by clicking on the pencil icon on the right side of the webhook description.
From the configuration page, modify any of the available fields.
Save or Cancel changes. Keep in mind that the system executes all validations upon saving.
Deleting a webhook
Delete webhooks that are no longer necessary to limit the amount of information sent out to third-party tools.
Click on the trash icon on the right side of the webhook item to remove it from the webhook list.
Once the trash icon is clicked, a pop-up confirms the action.
Deleting a webhook cannot be undone.
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.
RELATED TASK