Configuring webhook fields: Method, Resource, and Payload
The main advantage of configuring a Webhook is that Nexthink data from alerts or events can be pushed into various third-party tools, depending on the destination.
Method
Resource
Payload
The following sections explain how to configure the attributes to execute an action on the third-party tool.
Selecting the Method
Select one option from the Method dropdown: POST, PUT or PATCH. See the table below.
Optionally, review the pertinent third-party software documentation to identify the semantics of each method clearly.
Do not assume all methods are similarly used by all vendors and providers of third-party tools.
The REST standard is used over HTTP, comprising a major portion of the uniform interface constraint and provide the request methods available for webhooks.
*CRUD is an acronym for create, read, update, and delete.
Filling in the Resource field
Special considerations for resources:
Resources are data sets accessible via endpoints that can be used with APIs.
Resources relate to other resources and are limited by the operations that can be carried out on them.
Resources are presented as endpoint groups based on related data, or the objects they can work with.
Resources have simple names, making it easy for users to find the right endpoints. However, this may lead to overlooking essential functionality.
Paste the Resource value which is the action specified by the third-party REST API.
The Resource value can contain parameters (key=value) that the third-party tool requires.
Examples of valid Resource values
Writing the Payload
The Payload is the data pack sent with the POST/PUT/PATCH method in HTTP.
Include in the Payload the crucial information you submit to the server when requesting the API.
Optionally, review the pertinent third-party fields and values as the Payload depends on the tool used in the webhook.
The Payload field only accepts JSON format.
Using data model variables as placeholders in the payload
One of the most significant advantages of pushing data from Nexthink into third-party tools is the ability to pass information about an event that has taken place.
To use Nexthink data model variables as placeholders within the Payload:
Reference Nexthink variables using the placeholder
{{variable_name}}
within any field reported in the payload.Remember, the NQL data model is organized by namespace > table > field.
If needed, use special placeholders not strictly defined in the NQL data model, that are included on this page, and also referenced in the Allowed placeholders in the Nexthink web interface:
The image below is an example of a payload with placeholders referencing Nexthink data-model variables. Note how the system lists the Allowed placeholders for this case.
The system cannot replace placeholders with empty values or invalid. In these cases, {{variable_name}}
appears as is.
Special placeholders for Alerts data model variables
This table includes special placeholders for alerts not strictly defined in the NQL data properties.
Special placeholders for Remote actions data model variables
This table includes special placeholders for remote actions not strictly defined in the NQL data properties.
Examples of Method, Resource and Payload from multiple providers and tools
ITSM Tools
Creating an incident for ServiceNow
Method: POST
Resource: api/now/v1/table/incident
Payload:
Updating ServiceNow incident ticket from Amplify
Method: PATCH
Resource: api/now/v1/table/incident/{{remote_action.execution.external_reference}}
Payload (message):
Creating a problem for ServiceNow
Method: POST
Resource: api/now/v1/table/problem
Payload:
Creating an incident for BMC
Method: POST
Resource: api/arsys/v1/entry/HPD:IncidentInterface_Create?fields=values(Incident Number , Request ID, First_Name)
Payload:
Creating an incident for 4me
Method: POST
Resource: v1/requests
Payload:
Creating a service request for Jira Service Desk
Method: POST
Resource: rest/servicedeskapi/request
Payload:
Alerting Tools
Creating an incident for Pager Duty
Method: POST
Resource: incidents
Payload:
Messaging Tools
Posting a message on an MS Teams channel
Method: POST
Resource: webhookb2/5d4e17ca-3fb8-4799-b1a6-9e393959c4b3@13387b29-82d9-4ca5-9fa0-b7b5635742ef/IncomingWebhook/7465efe12998418d99784436abcbc451/4b9c1496-7e0f-421e-95de-31183103d005
Payload:
Posting a message on a specific channel for Slack
Method: POST
Resource: services/T01S01V0HB3/B02GY9BKZ7G/DIDFWXuCAeFfqkgNntQqJV7e
Payload:
Posting a message in Zoom
Method: POST
Resource: chat/webhooks/incomingwebhook/dSUcla-dQaGYgqGuBk3BsQ
.
The URL resource above is for illustration purposes only as it depends on the Endpoint URL you directly configure in Zoom.
Payload: Add the message you want to send to Zoom. See the example below.
Productivity Tools
Creating a bug on a specific project for Jira
Method: POST
Resource: services/T01S01V0HB3/B02GY9BKZ7G/DIDFWXuCAeFfqkgNntQqJV7e
Payload:
Data Platforms
Sending an event to the event collector for Splunk
Method: POST
Resource: services/collector?index=_main
Payload:
Last updated