Skip to content
English
  • There are no suggestions because the search field is empty.

HaloPSA Integration Guide

A step-by-step guide to getting HaloPSA connected

Here are the minimum requirements for on-premise environments.

  1. Fully Chained SSL Certificate.
  2. The latest stable version of HaloPSA.
  3. If your Halo instance restricts access based on IP, our IPs are 3.23.117.12 &  3.138.54

Note: On-premise users can populate the Tenant field by typing in the words Not set.

Connecting HaloPSA

 

  1. Register Gradient
  2. Create Role
  3. Configure Agent
  4. Create New Application
  5. Finish Gradient Connection

Register Gradient

 

Upon initial registration of your new account, select HaloPSA and click Next. You will then be given a connection checklist. Please gather these items before progressing to the next page. Let's head over to HaloPSA.


Create Role

 

Roles can be accessed by navigating to Configurations > Teams and Agents > Roles. You can create a new Role called Gradient.

Press save.

Go to the permissions tab, and give the following permissions:

  1. Clients Access Level - Read Only
  2. Items Access Level - Read and Modify
  3. Invoices Access Level - Read, Create and Modify
  4. Client Contracts Access Level - Read and Modify

Save this role, then proceed to creating a new Agent. 


Configure Agent

 

Navigate back to the Configurations page. Now go to Teams & Agents > Agents.

On this page, we will create a new Agent. Press the New button in the top right.

- Username will be Gradient
- Select Gradient under Roles
- Select the API only agent option
- Default Team can be *No Default Team*
- Work hours will be Default Working Hours

Scroll to the bottom and hit save. Now proceed to creating a new Application.

 


Create New Application


Login to HaloPSA.

Navigate to Configuration > Integrations > HaloPSA API > View Applications

View_applications_menu

Click New in the top right.

On the Details tab, enter "Application Name" with Gradient MSP.

Set the "Authentication Method" to Client ID and Secret (Services).

Copy the Client ID and Client Secret into Gradient. 

Set the Login Type to Agent.

add_application_details

Select an Agent to log in as. This will be "Gradient" as we created the Agent in the earlier step.

Press Save. Press OK if you get a permissions pop-up.

On the Permissions tab, enable the following permissions:

  1. Read: Customers
  2. Read: Contracts
  3. Edit: Contracts
  4. Read: Items
  5. Edit: Items
  6. Read: Invoices
  7. Edit: Invoices

Press save.

set_application_permissions

There is one more step inside of Halo before we can finalize the connection to Gradient.


Finish Gradient Connection

 

Within Halo PSA, navigate to Configuration > Integrations > HaloPSA API

Copy the Resource Server, Authorization Server and Tenant into Gradient.

gather_resource_server_authorization_server_and_tenant_info

 

Be sure when you paste Authorization Server you insert a / at the end of the URL, so it should say /auth/ . If you forget the / at the end, the test will fail.

Now you should have all of the items populated inside of Gradient, so you can press Save and Test. 


When you press continue the wizard will run the initial sync, which will take a few minutes, before asking you to continue to your dashboard.

Congratulations, you've successfully connected your PSA!

Top