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.
Accessing webhooks
In order to configure a Webhook, you must have Central Administrative privileges and the Integrations module enabled.
Follow these steps to access Webhooks:
Open Administration > Outbound connectors from the main menu.
Select Webhooks from the list of outbound connectors.
The system lists all existing webhooks. Therefore, when you access the Webhooks page for the first time, no elements are displayed
Find below the table fields on the Webhooks page:
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 and testing a webhook
From the Administration > Outbound connectors > Webhooks page:
Click New webhook button located to open the webhook configuration page.
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 specify the credentials of the third-party tool that you intend to target.
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 to verify the correct configuration of Credentials, Request method, Resource and Payload.
The system warns you of any mistakes or missing configuration fields.
Testing does not replace any use of placeholders within the payload, for example:
{{variable_name}}. The system treats all variables as plain strings.
The image below displays an example of webhook configuration fields.
The image below shows the ServiceNow incident created using the Sent Test button from the webhook configuration page.
Editing an existing webhook
From the Administration > Outbound connectors > Webhooks page:
Edit webhooks by clicking on the pencil icon on the right side of the webhook description.
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
Last updated
