Neat Pulse Integration Guide

This document serves as a comprehensive guide that outlines the necessary steps to successfully set up a Neat Pulse integration with the NetSpeek platform.

Prerequisites

  • Neat devices are powered on, connected to the network, and registered to your Neat Pulse tenant.
  • You have Owner access to your Neat Pulse tenant, in order to manage API Keys (Managing Neat Pulse Users).
  • You have access to your NetSpeek tenant with permission to manage Customer Integrations.

Step 1: Prepare the Neat Pulse Environment

The Neat Pulse documentation guides the Neat device administrator through the various steps of tenant orchestration, such as managing users, configuring location hierarchy, and enrolling devices. This guide assumes these steps have been completed, and that devices are enrolled and operational in Neat Pulse.

Create an API Key in Pulse for use in the NetSpeek integration

In Neat Pulse, navigate to Settings → API Keys and click “Create API Key”

In the interface to create an API key, give the key an identifiable name, and ensure the Scopes of both read and write are enabled (this is necessary for NetSpeek to fully orchestrate Neat devices, including the use of control commands).

In the following screen, you are shown a confirmation of the key’s creation and given the opportunity to copy the key and close the window. Store the key according to your organization’s policies – as shown in the next image, the key will not be fully visible again after this step.

Note that in this example, only the first few characters e32eab are shown, but the full key from above is no longer visible. You will need the full key to paste into the NetSpeek interface in Step 2.

Step 2: Connect Neat Pulse to NetSpeek (Customer Integration)

1. In the NetSpeek web app, click your User Avatar (bottom-left) → Settings.

2. Click Tenant Management (1), and select your Organization (2)

3. Click Integrations (3) then click Add Integration (4)

  1. Click + Add Integration.
  2. Enter a Name (e.g., Neat Pulse – Tenant ABCD1234).
  3. Set Integration Type = Neat Pulse.
  4. Set Integration State = Active.
  5. Enter your Organization ID and API Key.
    1. The Organization ID is also known as your Neat tenant identifier. The API Key is created in your Neat tenant’s settings to allow an external application (in this case NetSpeek) to connect to your Neat environment. For more details on these topics, see Neat’s API management documentation.

6. Click Create/ Update Integration.

Step 3: Onboard Pulse-Enrolled Devices to NetSpeek

1. In the Neat Pulse Dashboard, use hierarchy navigation or filters to create a view containing the device(s) you want to onboard into NetSpeek.

2. Open the Settings (three dots) menu → Export CSV.

This procedure is shown in this example for a single room with two hardware devices (Neat Bar and Neat Pad) but the csv file export can be applied as a bulk action to multiple rooms.

3. Open the CSV file and copy the Device ID of the device you want to onboard.

4. In the NetSpeek platform, go to Room Management.

5. Select a Room you wish to assign the Neat devices to, then click Launch Room Canvas

6. Click Add Device to Room.

7. Select the Manufacturer and Model.

8. Choose the previously created Neat Pulse Integration.

9. Enter the Device ID you copied from the CSV.

10. Click Add Device. The device will now appear in your room in NetSpeek and is ready to be managed.

Note

For rooms with multiple pieces of Neat hardware, the device ID from Neat Pulse will need to be added individually to NetSpeek for each hardware item. In this example, this means that the Neat Pad with device ID ending 8f88 must be added and saved, then a new device must be added to the NetSpeek Room Canvas for the Neat Bar with device ID ending 50f0. For rooms with additional peripherals such as Neat Centers, multiple Neat Pads, or Neat Boards acting as companion systems, all hardware devices must be configured into the NetSpeek Room Canvas with their individual device ID values from Neat Pulse.

Verification

Once credentials are configured:

  • To validate the integration, select a Neat device in the NetSpeek console, open the Device Actions Tab, and select an available device action.
  • On the device, observe the selected action occurring.

Support

If you run into any issues during onboarding or have questions, contact NetSpeek Support at support@netspeek.com.