HaloITSM Integration: Dashboard Configuration

Generate the API Token

The integration uses the API to transfer Client, Site and Device information into HaloITSM.

This can be created via Settings, General Settings, API Key when logged on to the Dashboard as a Superuser or (non-Classic) Administrator level access, a login with the required General permissions enabled or the Agent Key (where Dashboard access is enabled.

Simply select Generate Key to create the API key.

To email the API key, enter the recipient address in the Email API Key section and OK to send. The email includes not only the API Key itself, but also the respective server URL to query.

Generate the API Key as often as required, with each generation overwriting the current key. If the key changes, then anything authenticating against this key for the Public API will stop working.


Configure the Alert Recipient

HaloITSM 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 HaloITSM.

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 HaloITSM

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 panel, Email Alerts and / or SMS Alerts as required. Select to display and amend the settings in the north panel. Then, deselect once complete to hide the alerting columns.