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.19.3.152 &  3.19.4.238

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

  1. 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.
  2. Within Halo PSA, navigate to Configuration > Integrations > HaloPSA API > View Applications.
  3. Click New in the top right.
  4. On the Details tab, populate "Application Name".
  5. Set the "Authentication Method" to Client ID and Secret (Services) and Record the Client ID and Client Secret.
  6. Set the Login Type to Agent.
  7. Select an Agent to log in as.
    1. Ensure the Agent has a Role with the following permissions.
      1. Admin level
      2. Read and modify permissions for all feature access options. Tickets, Clients, Users, CRM, Assets, Items, Invoices etc. 
      3. Allow users of all Asset types.
      4. Configuration options should all be set to Yes.  
  8. Keep a record of the Client ID and Client Secret. Press Save
  9. On the Permissions tab, enable the following permissions:
    1. Admin 
    2. Read and Edit to: Customers, Contracts, Items, Invoices, Software, Assets
  10. Navigate back to the Configurations page. Now go to Teams & Agents > Agents, and ensure Feature Access is enabled for Clients Access Level for the agents you are using. 
  11. Save the API Application.
  12. Within Halo PSA, navigate to Configuration > Integrations > HaloPSA API and record the Resource Server, Authorization Server and Tenant.
  13. 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).
  14. Select Save and Test to confirm that the integration is configured properly.

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!