1. Home
  2. Halo PSA
  3. Step 1: Creating an API User and Integration in Halo PSA

Step 1: Creating an API User and Integration in Halo PSA

Introduction

Configuring MSP Process and HaloPSA to work with one another is a quick and easy process that is composed of a few steps:

  • Creating an Agent in HaloPSA that has the appropriate roles and permissions.
  • Creating an Application within the HaloPSA API
  • Providing MSP Process with the appropriate URL and tokens to communicate with HaloPSA.
  • Creating a custom tab in HaloPSA that will display the MSP Process Pod

Once you've completed the steps in this KB article, you'll have MSP Process and HaloPSA communicating with one another, and you'll be ready to move on to the next KB article:  Step 2: Setup the MSP Process "Custom Tab" in Halo.

Creating an Agent in HaloPSA

  1. Sign into your HaloPSA system
  2. Navigate to Configuration -> Teams and Agents -> Agents
  3. Click the New button to add a new agent
  4. Provide a name for the agent; we recommend MSP Process Agent
  5. Specify a password that meets your organizations security rules
  6. Assign the agent a Role; we recommend the default Role called 1st Line Support (or your equivalent if you’re modified the Roles in your Halo PSA instance)
  7. Enable the Is an API-only agent option
  8. Fill out any other mandatory fields (such as the Team and Working Hours fields)
  9. Click Save
  10. Edit the MSP Process Agent account; on the Permissions tab, enable the "Can Delete Tickets" option:

  11. Click Save

NOTE: The ability to delete tickets is only needed when setting up a Ticket Default in MSP Process, as validating the Ticket Default involves creating and then deleting a ticket in Halo PSA. Once the ticket default has been setup, you can disable the "Can Delete Tickets" option.

Creating an Application within the HaloPSA API

  1. From the Halo PSA UI, navigate to Configuration -> Integrations -> HaloPSA API
  2. Take note of the Resource Server URL; you'll need it (including the https:// prefix, but without the /api at the end) during one of the configuration steps with MSP Process
  3. Within the Applications portion of the page, click the View Applications button
  4. Click the New button to add a new application
  5. Specify a name for the application; we recommend MSP Process
  6. Within the Authorization Method section, select Client ID and Secret (Services)
  7. Copy the ClientID and Client Secret; you'll need it during one of the configuration steps with MSP Process
  8. Ensure that the Login Type drop-down menu is set to Agent
  9. Open the Agent to log in as drop-down menu, and choose the Agent you configured in the Creating an Agent in HaloPSA section
  10. Click the Save button
  11. Dismiss any permissions-related messages that appear; we'll be configuring those next
  12. On the Permissions tab, click the Edit button and enable the following permissions:
    1. read:tickets
    2. edit:tickets
    3. read:customers
    4. edit:customers
    5. read:crm
    6. edit:crm
    7. read:items
    8. edit:items
  13. Click the Save button

Providing MSP Process with the appropriate URL and tokens to communicate with HaloPSA

  1. Login to the MSP Process UI (https://app.mspprocess.com) 
  2. Navigate to Integrations -> PSA Integrations
  3. Click on the Add new PSA icon
  4. Click the HaloPSA icon
  5. Specify the ClientID and Secret that you obtained in step 7 of the Creating an Application within the HaloPSA API section
  6. Specify the Resource Server URL (remove the /api at the end) that you obtained in step 2 of the Creating an Application within the HaloPSA API section. Note that the URL must start with https://
  7. Click Submit to save the HaloPSA configuration settings
  8. Finally, fill in the ticketing default fields; these values will be used when leveraging MSP Process to create tickets
  9. Click Submit to finish setting up the HaloPSA module in MSP Process