How to create an HaloPSA API User

How to create an HaloPSA API User

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)
Idea
It's a best practice to specify only the minimum security rights required by any third party provider

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
  4. Go to "Permissions" tab and set the permissions as shown below:
    1. Feature Access
      1. Tickets Access Level: Read and Modify
      2. Customers Access Level: Read Only
      3. Assets Access Level: Read and Modify
      4. Calendars and Appointments Access Level: Read and Modify
      5. Products (or Items) Access Level: Read Only
      6. Sales Access Level: Read and Modify
      7. Invoices Access Level: Read Only
      8. Customer Agreements Access Level: Read Only
    2. Tickets Permissions
      1. Can add new Tickets: Yes
      2. Can view Unassigned Tickets: Yes
      3. Can view Tickets that are assigned to other Agents: Yes
    3. Asset Type Restrictions
      1. Allow use of all Asset Types: Yes
    4. Calendars and Appointments Permissions
      1. Adding New Appointments: Can Add All Appointments
      2. Visibility of Appointments: Can View All Appointments
  5. Go to "Client Restrictions" tab:
    1. Set "Allow use of all Customers": Yes

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 / Agent to log in as = "Propel Your MSP"

  7. Go to "Permissions" tab and set the permissions as shown below
    1. all:teams
    2. edit:tickets
    3. edit:calendar
    4. read:customers
    5. read:contracts
    6. read:items
    7. edit:sales
    8. read:invoices
    9. read:assets
    10. edit:assets
  8. Save your changes