Skip to main content
Skip table of contents

HTTP API Exporter

The HTTP API Exporter improves workplace technology experiences by exporting raw data and insights from Nexthink into third-party tools, such as a Configuration Management Data Base (CMDB) and Operation tools like SIEM, IT Ops, AI Ops, Logging, Monitoring and others.

By integrating Nexthink API data exports with third-party tools, you can combine, aggregate and manipulate data to:

  • Create powerful up-to-date visualizations with the evolution of specific indicators over time.

  • Ensure consistency in the data granularity.

  • Combine data from multiple sources to meet compliance and security standards.

  • Automate systematic updates for configuration items during and after changes.

Overall, the HTTP API Exporter aims to enhance your understanding of service usage to reduce costs within your organization, for example, by saving service-desk time.

Prerequisites

This integration requires:

  • A third-party tool with a public API that allows the system to send multiple records via JSON payload.

  • The authorization mechanism to connect to the third-party tool API must be either BASIC, Bearer Token or (Client Credential) OAuth 2.0.

  • The JSON payload of the public API third-party tool must support one of the following formats:

    • Collection of JSON objects:

      CODE
      {"property_a":"value_a", "property_b":"value_b"}
      {"property_c":"value_c", "property_d":"value_d"}
      {"property_e":"value_e", "property_f":"value_f"}
    • An array with multiple JSON objects within:

      CODE
      [{"property_a":"value_a", "property_b":"value_b"},
      {"property_c":"value_c", "property_d":"value_d"},
      {"property_e":"value_e", "property_f":"value_f"}]
    • A JSON object with properties and one array:

      CODE
      {
      "property_a":"value_a",
      "property_b":"value_b",
      "records":[
      {"property_c":"value_c", "property_d":"value_d"},
      {"property_e":"value_e", "property_f":"value_f"}
      ]}

Creating a new exporter

To configure the data exporter you must have administrative rights.
Refer to the Profiles documentation for more information about user profiles.

To access Data Export:

  1. Select Administration from the main menu.

  2. Select Outbound connectors from the Integrations section of the navigation panel.

Location of the Outbound connectors on the Navigation panel
  1. Select Data Exporter from the list of Outbound connectors. The Data Exporter page lists the total number of created data exporters.

The Data Export page remains empty until you create your first data exporter.

  1. Click on the New Exporter button in the top-right corner of the page to create a new data exporter, and select the CMDB & Ops tools/HTTP API (Payload) option.

  1. Fill out the General tab and Data tab on the New exporter page.

  2. Click on the Test Load up to 20 records button to execute the NQL query from the Data tab.

  3. Click on the Save button at the bottom of the page to validate and create the new data exporter.

Filling out the General tab

View of the General Tab in the New Exporter Page
  • Name: enter a name for the data exporter.

  • Description (optional): enter a meaningful goal for the data exporter.

  • Credentials: define the credentials from the third-party tool to enable Nexthink data exports.
    Refer to Connector credentials for more information.

  • Method: define the method the public API supports for sending out data, for example POST, PUT, PATCH.

  • Resource: enter the name of the public API endpoint without the protocol and instance, as listed in the following table:

Full URL

Resource Value

https://ven01063.service-now.com/api/now/import/u_infinity_file/insertMultiple

api/now/import/u_infinity_file/insertMultiple

https://prd-p-h68d1.splunkcloud.com:8088/services/collector?index=main

services/collector?index=main

  • Recurrence: select the frequency with which to execute the list of NQL queries. The available options are hourly, daily and weekly.

    • Hourly: executes the list of queries based on the value selected in the drop-down menu. For instance, every 1h, 2h, 3h and more.

    • Daily: executes the list of queries every day at 00:00 UTC.

    • Weekly: executes the list of queries on the same day of the week at 00:00 UTC. Select only one day at a time.

Regardless of what frequency you choose, the system may delay the execution of the data exporter to ensure data completeness. This guarantees there is no data missing at the time of the export process.

You must select a value for the Recurrence option because the system does not generate a default value and cannot inform you that the value is missing during the validation process.

Filling out the Data tab

  • NQL query: define the data exported from the Nexthink web interface into the destination using an NQL query.

  • Payload structure: select the payload structure to be sent into the third-party tool API.
    Check, in advance, that the public API being targeted supports one of the payload structures referred to on this page.

  • Payload (JSON): write the payload structure to be sent to the third-party tool in JSON format. Specify the payload for only one object.

  • Payload content helpers: list the variables from the NQL query that the system can use within the payload.

The exporter replicates the object structure as many times as results are generated by the NQL query.

Testing query configuration

Click on the Test load up to 20 records button to execute the query configured in the Data tab. The system sends the result to the destination set up in the General tab.

The test sends a maximum of 20 records.

If the NQL query returns more than 20 records, the exporter sends the first 20 records registered.

Test load outcomes

  • Valid query: a message appears at the top of the page indicating that the system successfully executed the query.

  • Invalid query: a message appears at the top of the page highlighting the errors that the system found in the query.

The following screenshots of Data tabs show different examples of valid queries.

Example of a valid query (JSON object)

Example of a valid query (array)

Example of a valid query (JSON object with an array)

Click here to expand...

Saving a new Exporter

Click on the Save button at the bottom of the New Exporter page to validate all configured fields and create a new Exporter.

The following fields on the General tab and Data tab are mandatory:

General tab mandatory fields

Data tab mandatory fields

  • Name

  • Credentials

  • Method

  • Resource

  • NQL query

  • Payload

Missing or invalid fields in the General tab and/or Data tab trigger validation messages, directly highlighting the issues on the page.

The following screenshots show different examples of failed validations.

Example of a failed validation due to missing fields

Example of a failed validation due to query configurations

The system displays the following validation message if a time-bound NQL query does not match the scheduling setup in the General tab.

Example of a failed validation due to Payload (JSON)

The system displays the following validation message if the Payload (JSON) does not match the Payload structure.

Example of a failed validation due to Payload content helpers

If you use a placeholder that is not present in the Payload content helpers, the system will display the following validation message at the top of the page.

Editing an existing data export

  1. Navigate to the Data Exporter page.

  2. Hover over a specific exporter and select the edit icon on the right side of the table row.

  3. Modify the prefilled fields in the General tab and/or Data tab on the Exporter edit page.

  4. Save or cancel the modifications to go back to the Data Exporter page.

The system validates all fields when you save the form.

Deleting an existing data export

You can constrain the amount of information that the system sends out to third-party tools by removing data exporters that are no longer necessary. To do so, follow the steps listed below:

  1. Navigate to the Data Exporter page.

  2. Hover over a specific exporter and select the delete icon on the right side of the table row.

  3. A pop-up appears on the Data Exporter page to confirm the action.

The action of removing a data exporter cannot be undone. The exporter's configuration cannot be recovered.

F.A.Q.

Can I add a payload that is not supported by the CMDB and Ops tools?

No, a validation error occurs if your payload structure does not match any of the three options available on Nexthink.

Are the keys inserted in the payload message validated against a ServiceNow import set table?

If you try to insert a key within the payload that is not a column on the import set table in ServiceNow, it will not be inserted.

What if I need to use a payload format that is not available?

Feel free to reach out to your Nexthink representative and suggest an idea to support a new payload format.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.