A step-by-step guide to getting HaloPSA connected
Here are the minimum requirements for on-premise environments.
- Fully Chained SSL Certificate.
- The latest stable version of HaloPSA.
- 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
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
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.
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:
- Read: Customers
- Read and edit: Contracts
- Read and edit: Items
- Read and edit: Invoices
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.
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:
- Clients Access Level - Read Only
- Invoices Access Level - Read and Modify
- Client Contracts Access Level - Read and Modify
- Items Access Level - Read and Modify
Within Halo PSA, navigate to Configuration > Integrations > HaloPSA API
Record the Resource Server, Authorization Server and Tenant.
Finish Gradient Connection
Return to Gradient, select HaloPSA and insert the following information:
- Client ID
- Client Secret
- Resource Server
- Authorization Server
- 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!