HaloPSA Integration: Dashboard Configuration

Generate the API Token

The API Key is used to authenticate against the Public API. If you regenerate a new key, anything that uses the existing key to authenticate against the Public API will stop working. If you already have an API Key, we recommend you use it.

  1. Log in to the N-sight RMM Dashboard as a Superuser or (non-Classic) Administrator level access, or using a login with the required General permissions enabled, or using the Agent Key (if enabled)
  2. Go to Settings > General Settings > API
  3. Click Generate (or Regenerate when you are creating a new API Key) and record the API Key for future use

    You can generate the API Key as often as required. Each regeneration overwrites the existing key.

  4. Enter the recipient email address in the Email API Token to (optional) field and click Email Token (Optional)

    The sent email includes the API Key and the server URL to query.

  5. Select OK to apply

Configure the Alert Recipient

HaloPSA uses the Dashboard generated Alert and Recovery emails to open and automatically close a ticket within their system.

As such, the first stage of the integration is to configure the recipient address, as well as ensure the unique identifiers are included for these emails.

This can be achieved via Settings > Alerts > Settings on the Dashboard.

In the Alert RoutingSettings section edit the recipient to an email address polled by HaloPSA.

To include the unique identifiers in the email notifications (required) simply tick the "Include Check ID's" under the Email Headers section.

Where this option is enabled, the Dashboard generated emails will contain the following non-editable identifiers:


Click OK once complete to save changes.


Select the Alert generating Checks

The next stage is to choose the Checks that will generate an Alert and subsequent ticket in HaloPSA

Whilst in the Edit Alert Settings dialog, go to the Server Alert Settings and / or Workstation Alert Settings

Select the required checks under the Update column to change the Alerting behavior on all existing devices.

Click Apply to save.

The Default Settings are also be amended from this dialog, with these applied to any newly installed devices.

The Alert settings may also be amended on an individual device by selecting the machine on the Dashboard. Click show Alert Options (where not already displayed) and enable or disable the Alerting options under the relevant column, as required. Click on Save Changes to apply.

In addition to Checks, server overdue notifications can be configured on the Dashboard from the Columns menu above the North-pane, Email Alerts and / or SMS Alerts as required. Select to display and amend the settings in the North-pane. Then, deselect once complete to hide the alerting columns.