Halo Integration Setup

This document outlines the requirements and setup for the Halo integration.

This Integration supports multiple instances

Check out the instructions to set up multiple instances here.

Setting up the API account

Before configuring the Rewst integration you must generate an API user. Here is the instruction for the generation of the integration user:

1. Log in to Halo PSA as an Administrator.

2. Go to Configuration → Agents → New.

3. Create an Agent for Rewst to use. We suggest naming this user Rewst API or similar.

4. Grant the user permissions according to what you would like Rewst to do for you.

5. Navigate to Configuration → Integrations → HaloPSA API (Halo Authorization Docs).

6. Create an Application.

7. Select View Applications.

8. Click the New button.

9. Use the authentication method for Client ID and Secret (Services).

10. Navigate to the permissions tab.

11. Select the all option.

12. Navigate to the following location: Teams & Agents > Agents > "API's Selected Agent" > Departments & Teams

13. Click Edit on the top left and within Teams select Add

14. Select all of the Teams and click Save

Required for Mapping Customers in the Integration

When creating the API Agent, ensure that the Allow use of all Customers Client Restriction setting is set to Yes if you want to allow Rewst to interact with your customer records.

Configuring the Integration

Once you have created an API account, you will need to configure the integration within the Rewst platform.

Follow the below steps to configure a new integration:

1. Log in to the Rewst platform.

2. Go to the Configuration → Integrations in the left sidebar.

3. Click on or search for Halo PSA.

4. Complete the form with the details you created:

   1. Resource Server Hostname: Halo PSA Resource Server hostname, e.g. example.halopsa.com.

   2. Client ID: ID for the Application registered in Halo PSA

   3. Tenant ID: When using a cloud-hosted Halo PSA instance this must be specified. This value can be found in the Halo PSA web application under Configuration → Integrations → HaloPSA API → API Details.

   4. Auth Server Hostname: Halo PSA Auth Server hostname, e.g. example.halopsa.com/auth, if different from Resource Server Hostname

   5. Client Secret: Authentication secret for the Application registered in Halo PSA

   6. Is On-Premise?: Whether or not the Halo PSA instance is hosted on an on-premise server

5. Save the configuration. Rewst will do a quick validation of your input.

Beneath that integration authentication section you will see the following options:

1. Suggest Values: This option will attempt to generate mappings between Rewst organizations and child organizations in this integration.

2. Refresh Options: This will re-read the potential mapping options - both organizations and companies in Halo.

3. Save Mappings This will apply mapping configuration changes.