HaloITSM Guides

Documentation to assist with the setup and configuration of the HaloITSM platform

Guides > PRTG Integration

PRTG Integration

In this guide we will cover:

- Configuring the PRTG Module

- Asset Imports

- Halo Integrator

- Webhooks

Configuring the PRTG Module

To enable the PRTG integration in Halo, go to Configuration > Integrations, and enable the module.

Fig 1. Enabling the module.

Once the module has been enabled, click the menu icon for the module to begin configuring it. You can also create multiple instances of PRTG when navigating to the PRTG Integration.

The first piece of configuration is to specify your PRTG server URL. You then need to supply the username and password (or passhash) of a PRTG user.

Fig 2. Connecting to PRTG.

Asset Imports

Before you can import Assets, there are some configuration steps that must be completed. The first option is to choose a default site and default asset type, so that if an Assets site has not been imported from PRTG before, the asset can still be created with the correct initial configuration.

Fig 3. Asset imports.

Once you have specified the above mappings, you can then move on to creating field mappings. Clicking the plus icon in the top right-hand corner of the field mapping table will open an input screen with 3 options.

Fig 4. Field mappings popup.

The first option is to choose what type of field you would like to map to in Halo. You can map to standard custom fields here, or you can map to Asset fields.

The next two options allow you to choose one of the pre-determined fields from PRTG to map to a Halo field. If you have chosen a field type of Asset Field, there is an additional option allowing you to create a field during the next import. If chosen, Halo will try to create a new field during your next import with the name equal to the PRTG field that you are mapping too. If a field with that name already exists, the mapping will be updated to map to the pre-existing field.

Once you are happy with your field mappings, there is one last configuration option to consider before you can begin importing, which is the Asset Matching Field. This contains your full list of asset fields.

Fig 5. Asset matching field selection.

The Asset Matching Field should be set to a value that is unique such as asset number or serial number as shown above.

This field should be unique. Halo will then use the value of this field to match pre-existing Assets and avoid creating duplicates of your data. Once happy with your configuration, use the "Import Assets" button to begin importing.

Halo Integrator

Once you are happy with the configuration, you can then setup regular imports using Halo Integrator.

Fig 6. Enabling the integrator.

Once you have enabled the PRTG for Halo Integrator, you will be able to use the importer for recurring imports:

Webhooks

Within the PRTG integration module you can now enable inbound webhooks. The purpose of them is to send alerts from PRTG to Halo and instantly create tickets. To enable this functionality, webhooks must be configured in PRTG by navigating to Setup > Account Settings > Notification Templates and creating a notification with 'Execute HTTP Action' enabled.

When creating the ticket in Halo, you can set the default ticket type.

You can also set a fall back user:

If the Alert can be linked to a Device with a User in Halo, the Ticket will be logged against this User.
If the Alert can be linked to a Device without a User in Halo, the Ticket will be logged against the default User of the Device's Site.
If the Alert cannot be linked to a Device, the Ticket will be logged against the Fallback User given below.

Fig 7. Selecting a fallback user.

Configuring the Webhook

Below is a payload containing all the supported PRTG placeholders. You must include secret=[Webhook Secret] and deviceid=%deviceid in the payload. laststatus=%laststatus is required for the auto-close functionality, all other variables are optional.

secret=[Webhook Secret]

&deviceid=%deviceid

&laststatus=%laststatus

&colorofstate=%colorofstate

&company=%company

&comments=%comments

&commentsdevice=%commentsdevice

&commentsgroup=%commentsgroup

&commentsprobe=%commentsprobe

&coverage=%coverage

&cumsince=%cumsince

&date=%date

&datetime=%datetime

&device=%device

&down=%down

&downtime=%downtime

&elapsed_lastcheck=%elapsed_lastcheck

&elapsed_lastdown=%elapsed_lastdown

&elapsed_lastup=%elapsed_lastup

&group=%group

&groupid=%groupid

&history=%history

&home=%home

&host=%host

&iconofstate=%iconofstate

&lastcheck=%lastcheck

&lastdown=%lastdown

&lastup=%lastup

&lastvalue=%lastvalue

&linkprobe=%linkprobe

&linkgroup=%linkgroup

&linkdevice=%linkdevice

&linksensor=%linksensor

&location=%location

&message=%message

&nodename=%nodename

&objecttags=%objecttags

&parenttags=%parenttags

&priority=%priority

&probe=%probe

&probeid=%probeid

&programname=%programname

&programversion=%programversion

&sensor=%sensor

&sensorid=%sensorid

&serviceurl=%serviceurl

&settings=%settings

&shortname=%shortname

&since=%since

&sitename=%sitename

&status=%status

&summarycount=%summarycount

&systemdatetime=%systemdatetime

&tags=%tags

&time=%time

&timezone=%timezone

&toaddress=%toaddress

&uptime=%uptime

Webhook Auto-closure Status

You can have this make the ticket in Halo close when a certain status is met in PRTG. It is only recommended to change the default value for bespoke setups.