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.

Overview

Before data can be sent from Nexthink to any Nexthink supported, third-party application for communication, new credentials must be created and defined to connect and enable third-party tools. This way, these newly created credentials can be utilized when a webhook is configured.

This first step in the configuration process will be explained in this section.

Configuring credentials for the first time

Follow these steps to access the Webhook Credentials page:

  • Click on the Administration icon in the main menu.

  • Click on Connectors.

Configuring credentials
  • The list contains all connectors available in Nexthink for that environment. To access the credential page, click on Webhook Credentials.

Select Webhook Credentials

If the Webhook Credentials row is not displayed, please reach out to Nexthink Support to enable this functionality as it might be hidden.

When the Webhook Credentials page is accessed for the first time, it displays an empty list. As soon as a credential is created, it is listed on this page and a total number of existing credentials is displayed.

Creating a new credential

The following steps will take you through the process of creating a new credential:

  • Click on the New webhook credential button located in the top right corner of the screen to create a new entry.

Creating a new credential
  • A new page with a Webhook credentials form is displayed for you to fill out.

Webhook credentials form

The following points describe the items in the form:

  • Instance alias: the unique name of the credential being created

  • Instance URL: the URL of the third-party written in the following format http://{host}:{port}/ from the http protocol to the first slash / , both need to be included. Examples of instance URLs:

Third-party Tool

Full URL

Instance URL (credential field)

ServiceNow

https://<instancename>.service-now.com/api/now/table/{tableName}

https://ven01063.service-now.com/

BMC

https://serverName:port/api/arsys/v1/entry/{formName}

https://serverName:port/

Cherwell

https://host.domain/CherwellAPI/api/V1/savebusinessobject

https://host.domain/

Ivanti

https://{tenant url}/api/rest/ServiceRequest/new

https://{tenant url}/

Freshservice

https://api.freshservice.com/v1/#update_ticket_priority

https://api.freshservice.com/

4me

https://api.4me.com/v1/requests

https://api.4me.com/

Jira service desk

https://<instancename>.atlassian.net/rest/servicedeskapi/request

https://<instancename>.atlassian.net/

Keep in mind that each third-party tool may compose the instance in a different way. It is important to revisit the third-party documentation to avoid inserting a wrong value.

  • Authorization type: type of authorization that the user wants to use when calling the third-party tool

Supported authorization mechanisms

There are currently two types of authorization mechanisms supported by the Webhook feature, which can be chosen using the Authorization type drop-down menu.

  • Basic: uses basic credentials, normally a username and password to connect to the third-party tool.

Basic authorization mechanism
  • Bearer token: uses an API token, normally generated by the third-party tool. It is added automatically into the header when the request is launched. The Header prefix can be configured manually, but if it is not defined, the Bearer will be the default value inserted here.

API token authorization

OAuth 2.0 is not currently supported.

Please refer to the documentation of the third-party tool to ensure the supported authorization mechanism and values that apply to each webhook are correct.

Saving a new credential

  • Once the form has been completed, click on the Save button to save it. If all goes smoothly you will be redirected to the Webhook Credentials page with the list of existing credentials. The new credential should be part of the list.

  • If you get an error, it will be displayed on the top of the form with the fields in question highlighted in the form, see the illustration below.

Saving a new credential
  • Click on Cancel to stop the process of creating a new credential. You will return to the list of Webhook Credentials without saving the information in the form.

Editing a credential

  • You can update a credential by selecting the pencil icon located on the right side of the credential entry on the Webhooks Credentials list.

Editing a credential
  • Once clicked, you are redirected to the Webhook Credentials form with prefilled values for the credential.

The values that appear hidden in the Token or Password fields cannot be copied as they don’t represent the real values for these fields. This has been done for security reasons.

  • By clicking the Save button, the current values of the credential are updated and you are redirected back to the Webhook Credentials page. If there is a problem with the information you have entered, an error message is displayed on the top of the page indicating the nature of the problem.

  • By clicking the Cancel button, you return to the list of credentials without updating the values of the form.

Deleting a credential

If a credential is no longer needed or valid, it can be removed using the trash bin icon on the right side of each credential in the list.

Deleting a credential
  • When the trash icon is clicked, a pop-up opens to confirm the delete action.

  • To confirm, click on the Delete webhook credential. The credential will be removed regardless of having a Webhook linked to it.

  • Click Cancel if you wish to abort the operation.

Delete webhook credentials confirmation

In the current version of the Webhook Integration feature, if a credential is linked to at least one webhook, that webhook will stay in an inconsistent state. It will not send any notifications to the third-party tool until a new or existing credential is assigned to it.