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.

Note: Setting All permissions on step 10 will cause authentication to fail.

Connecting HaloPSA

 

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

Register Gradient

 

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


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, populate "Application Name" with Gradient MSP.

Set the "Authentication Method" to Client ID and Secret (Services) and Record the Client ID and Client Secret. Keep a record of the Client ID and Client Secret.

Set the Login Type to Agent.

add_application_details

Select an Agent to log in as. This must be an Agent who has a Role with appropriate permissions, as outlined in the Configure Agent step later in this document.

Press Save.

On the Permissions tab, enable the following permissions:

  1. Read: Customers
  2. Read and edit: Contracts
  3. Read and edit: Items
  4. Read and edit: Invoices

set_application_permissions


Configure Agent

 

Navigate back to the Configurations page. Now go to Teams & Agents > Agents, and ensure Feature Access is enabled for Clients Access Level for the agent you are using.


set_agent_permissions_client_access_level

Save the API Application.

Roles can be accessed by navigating to Configurations > Teams and Agents > Roles. You can create a new Role for the Agent you are using, or edit an existing one. Ensure the Role that your Agent will be using has the following permissions:

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

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

Record the Resource Server, Authorization Server and Tenant.

gather_resource_server_authorization_server_and_tenant_info


Finish Gradient Connection


Return to Gradient, select HaloPSA and insert the following information:

  1. Client ID
  2. Client Secret
  3. Resource Server
  4. Authorization Server
  5. Tenant (On-premise users can populate the Tenant field by typing in the words Not set)

Select Save and Test to confirm that the integration is configured properly. The wizard will run the initial sync, which may take a few minutes, before prompting you to continue to your dashboard.

Warning: Authorization Server requires a forward slash "/" at the end of the URL https://domain.halopsa.com/auth/

Congratulations, you've successfully connected your PSA!

Top