Neat Pulse Integration Guide

This document serves as a comprehensive guide that outlines the steps required to integrate a Neat Pulse tenant with the NetSpeek platform.

Prerequisites

Before beginning the integration, confirm the following:

  • 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 (Neat documentation: Managing Neat Pulse Users).
  • Your Neat Pulse tenant is on a paid plan with access to the Neat Pulse API.
  • You have access to your NetSpeek tenant with permission to manage 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 the image below, only the first few characters e32eab are shown, and 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: Configure Neat Pulse in NetSpeek (Tenant Integration)

  1. In the NetSpeek portal, navigate to Tenant Management (settings cog icon)→ Integrations within your desired tenant (you may have access to multiple tenants / sub-tenants – if so, ensure you are configuring the integration in the proper place).
  2. Click “+ Add Integration”
  3. Enter an Integration Name (as an example format, Neat Pulse – YourOrgName - YourTenantID).
  4. Set Integration Type = Neat Pulse
  5. (Optional) Enter an Integration description, with details other NetSpeek users may need to know.
  6. Set Integration State = Active.
  7. Enter your Organization ID and API Key.
    • The Organization ID is also known as your Neat Pulse tenant identifier. The API Key is created in your Pulse tenant’s settings as described in the prior step, to allow an external application (in this case NetSpeek) to connect to your Neat devices. For more details on these topics, see Neat’s API management documentation.
  8. Click Create new integration / Update integration.

Step 3: Gather IDs from Pulse-Enrolled Devices

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 and large groups of devices.

3. Open the CSV file and copy the Pulse ID (also called “Device ID”) of the device you want to onboard.

Step 4: Add Device to NetSpeek Room Canvas

  1. In the NetSpeek Console, navigate to Room Management
  2. Select the room you wish to add your Neat Device to
  3. Click Launch Room Canvas
  4. Click Add device to room
  5. Choose your desired device from the manufacturer → device model list.
  6. Configure the appropriate values, and in the “Integrations” section, select the previously created Neat Pulse integration from Step 2.
    • Paste the Device ID copied from the CSV in Step 3.

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 the relevant settings described above 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. It is generally advisable to test by dispatching a non-intrusive command such as a Get Status.
  • 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.