How to create an HaloPSA API User

How to create an HaloPSA API User

Alert
This feature is currently is development

Connect your HaloPSA Instance to Propel Your MSP

To connect your HaloPSA instance to Propel Your MSP, you will need the following information:
  1. Your instance's domain name (typically something like yourcompany.halopsa.com)
  2. The API's Client ID and Client Secret (see below)

1- Creating an API-only Agent

  1. Login to your HaloPSA account
  2. Navigate to  Configuration>Teams & Agents>Agents and click "New"
  3. Fill in the following information:
    1. Username = Propel Your MSP
    2. Active = checked
    3. Is an API-only Agent = checked
    4. First Name = Propel
    5. Last Name = Your MSP
    6. Initials = PYM
    7. Can approve Purchase Orders = unchecked
    8. Can approve Invoices = unchecked

2- Creating Your API Key

You need to generate HaloPSA API keys so that Propel Your MSP can sync data with your PSA.
Warning
Be sure to make a copy of both the Client ID and Client Secret because the Client Secret will only be displayed once.
  1. Login to your HaloPSA account
  2. Navigate to  Configuration > Integrations > HaloPSA API > Applications and click "New"
  3. Fill in the following information:
    1. Application Name = Propel Your MSP
    2. Active = checked
    3. Authentication Method = Client ID and Secret (Services)
  4. Copy the Client ID and Client Secret in a secure location
  5. Login Type = Agent
  6. Agent to log in as = "Propel Your MSP"
  7. Go to "Permissions" tab and set the permissions as shown below
  8. Save your changes

Permissions

Idea
It's a best practice to specify only the minimum security rights required by any third party provider
Make sure the following permissions are checked:
  1. read:tickets
  2. edit:tickets
  3. edit:calendar
  4. read:customers
  5. read:crm
  6. read:contracts
  7. read:items
  8. read:sales
  9. read:invoices
  10. read:assets
  11. edit:assets


    • Related Articles

    • How to create an Autotask API User?

      Connect your Autotask PSA Instance to Propel Your MSP To connect your Autotask PSA instance to Propel Your MSP, you will need the following setup: Setup a security role for the "Propel Your MSP" user Create an API User (Key & Secret) Security Role We ...

    • How to create a ConnectWise Manage API Member Key?

      Connect your ConnectWise Manage Instance to Propel Your MSP To connect your ConnectWise Manage instance to Propel Your MSP, you will need the following information: Your instance's domain name (typically connect.yourcompany.com) The Company ID ...

    • Autotask PSA: Import Manufacturer and Model Number from the Autotask Product

      Autotask PSA Propel Your MSP, if no User Defined Field has been set in PSA Integration / Asset Mapping , will now import the Manufacturer and Model Number from the Autotask Product assigned to the Configuration Item. This often has more ...

    • ConnectWise Manage Integration error "You do not have security permission to perform this action."

      Are you are seeing this error about your ConnectWise Manage integration when signing in to Propel Your MSP? The reason is because in ConnectWise Manage v2020.4, a new "Table Setup" security permission, introduced in v2020.3 has started throwing the ...

    • PSA to Propel Your MSP Asset Mapping

      Concept Assets in the PSA normally have an associated type (Workstation, Firewall, Switch, etc.). Each type can be (but does have to be) mapped to an Asset Category in Propel Your MSP. Example: You can create / modify Asset Categories to better suit ...