Syncing your HaloPSA Users with BizRatings: Setup Guide

This guide walks you through connecting your HaloPSA instance to BizRatings. Once connected, BizRatings synchronizes your HaloPSA Agent IDs and their first and last names so your agents appear in BizRatings User Management. The integration reads Agent IDs and names only.

The setup has two halves: you first create API credentials inside HaloPSA, then enter those credentials in BizRatings and test the connection. The whole process takes about 15 minutes.

At a glance, you will:

1. Create an API-only agent in HaloPSA.
2. Locate your HaloPSA API connection details.
3. Register an application that uses a Client ID and Secret.
4. Give the application the permissions BizRatings needs.
5. Enter your credentials in BizRatings and test the connection.
6. Sync your technicians in User Management.

Who can do this

You need administrative access to your HaloPSA portal (Configuration > Teams & Agents and Configuration > Integrations), and administrator access to your BizRatings account.

Tip: Have a secure place ready (such as your team's password manager) before you start. Part 3 generates a Client Secret that HaloPSA only shows once.

Part 1: Create an API-only agent in HaloPSA

BizRatings connects to HaloPSA through a dedicated agent account that is used only for API access. Because it is API-only, it cannot log in to the HaloPSA web or mobile apps and cannot be assigned tickets.

1. In HaloPSA, go to Configuration > Teams & Agents > Agents.
2. Click New at the top of the agents list.

3. Under Account Details, enter a Username (for example, bizratings agent), an Email Address, and a Password.
4. Check Is an API-only Agent. HaloPSA displays a notice that API-only agents cannot log in to the Web or Mobile Applications or be assigned tickets, and that they do not take up a licence.

5. Scroll down to Agent Details. HaloPSA fills in the first name and surname from the username. Complete the remaining required fields: set Work Hours (we used 24 Hours) and, if prompted, Default Team. In our walkthrough, Default Team was left at *No Default Team*.

6. Scroll to the bottom of the page and click Save.
7. On the agent's record, confirm that Is an API-only Agent shows Yes.

Note: BizRatings reads your agent list through this account. If the connection test later reports that the API agent lacks permission (a 403 error), open the agent in HaloPSA and make sure it has a role that allows it to view agents.

Part 2: Find your HaloPSA API connection details

Next, locate the three values BizRatings uses to reach your HaloPSA instance.

1. In HaloPSA, go to Configuration, scroll down to the Advanced section, and click Integrations.
   
   
   

Under Featured, click HaloPSA API.

The API Details section lists your Resource Server, Authorisation Server, and Tenant. Copy each of these and keep them handy. You will enter them in BizRatings in Part 5.

Note: In the example above, yourcompany stands in for your own HaloPSA address and tenant name. The Resource Server URL ends in /api and the Authorisation Server URL ends in /auth.

Part 3: Register an application and generate your Client ID and Secret

1. On the same HaloPSA API page, under Applications, click View Applications.
2. In the list that opens, click + New item. The Add an Application page opens.
3. Enter an Application Name (for example, BizRatings Integration) so your team knows what the application is for. A Description is optional. Leave Active checked.

4. Under Authentication Method, select Client ID and Secret (Services). A Client ID and Client Secret appear below the options.
5. Click Copy next to the Client Secret and store it somewhere secure, along with the Client ID.
6. Set Login Type to Agent.
7. In Agent to log in as, select the API-only agent you created in Part 1.
8. Click Save.

Important: Do not select Authorisation Code or Implicit Flow. BizRatings runs automated background syncs and needs service-level credentials, so only Client ID and Secret (Services) will work.

Important: HaloPSA only shows the Client Secret once. If you navigate away without copying it, you will need to click Generate to create a new one, and generating a new Client Secret stops the old one from working.

9. HaloPSA will tell you that the application has no permissions yet. Click Ok. You will set permissions in Part 4.

Part 4: Give the application the permissions BizRatings needs

1. On the application you just saved, open the Permissions tab and click Edit at the top of the page.
2. Check read:tickets. HaloPSA requires this permission on the application for BizRatings to connect, and the BizRatings connection test checks for it.
3. Check all:teams. This lets BizRatings read your list of agents (their Agent IDs and names) for the sync.
4. Click Save.

On the Permissions tab, click Edit and check the boxes next to read:tickets and all:teams. Leave every other permission unchecked, then click Save. When you return to the Permissions tab, read:tickets and all:teams should both show Yes.

Important: If these permissions are not checked, the connection test in BizRatings will fail with a permissions error.

Part 5: Enter your credentials in BizRatings

1. Log in to BizRatings as an administrator and open API Settings page. (Integration Settings or the Settings Menu, depending on which BizRatings version you are using > API Settings).
2. If your organization has more than one company or location in BizRatings, choose the right one from the company dropdown at the top of the page. The page reloads that company's credentials.
3. Complete the Halo PSA API Credentials form using the values you collected:

The Halo PSA API Credentials form has five fields, from top to bottom: Resource Server URL, Authorization Server URL, Tenant, Client ID, and Client Secret. Below the fields are the Enable Halo PSA Integration for this company checkbox and the Test Connection and Save Configuration buttons. A status badge at the top right of the card shows whether the integration is active.

Test the connection

4. Click Test Connection. BizRatings checks two things: that HaloPSA issues a secure access token for your credentials, and that the application can see your active agents.
5. If both checks pass, a green banner confirms the connection. If you see an error instead, see the troubleshooting table below.

Save your configuration

6. Click Save Configuration. BizRatings runs the same connection check again before saving, so credentials that fail the test are never saved.
7. A Configuration Saved message appears. Click OK.
8. The status badge at the top right of the card changes to Integration Active, and a Secret saved badge confirms your Client Secret is stored securely.

Note: Your Client Secret is never shown again after you save it. When you reopen the page, the Client Secret field is blank and the Secret saved badge tells you a secret is stored.

Part 6: Sync your technicians in User Management

1. Click the User Management button at the top of the API Settings page  (or open the User Management page from your BizRatings navigation).
2. Look for the Halo PSA integration badge in the bar at the top of the page.
3. Click Sync now. A progress window shows BizRatings connecting to Halo PSA and importing your agents.
4. When the sync finishes, your agents appear in the employee roster with their Agent IDs and names. From there you can assign permissions and licenses. See the BizRatings User Management guide for details.

Note: If the User Management link in your BizRatings navigation opens the older (legacy) page, look for the banner image at the top of that page. Click it to open the new User Management experience, where you can sync, license and set permissions for your HaloPSA technicians.

Managing the integration

Temporarily turn the integration off

If you need to pause the agent sync, for example during maintenance or a migration:

1. Open the Halo PSA Integration page.
2. Uncheck Enable Halo PSA Integration for this company.
3. Click Save Configuration. The badge changes to Integration Disabled.

Your credentials stay saved. To turn the integration back on, check the box again and click Save Configuration.

Update or rotate the Client Secret

1. In HaloPSA, open your BizRatings application and click Generate next to the Client Secret. Copy the new value.
2. In BizRatings, open the Halo PSA Integration page and paste the new secret into the Client Secret field. Leaving the field blank keeps the secret you already saved.
3. Click Test Connection, then Save Configuration.

Troubleshooting

If Test Connection or Save Configuration shows an error, find the message below.

Frequently asked questions

Will this use up one of our HaloPSA agent licences?
No. HaloPSA states that API-only agents do not take up a license.

What does BizRatings do with this connection?
BizRatings reads only your HaloPSA Agent IDs and their first and last names, and uses them to build your employee roster in User Management. It does not read or change anything else in HaloPSA. To send BizRatings CSAT surveys, you add the BizRatings survey snippet to your HaloPSA closed email template — see Inserting BizRatings CSAT Survey HTML Snippet into Halo Email Templates.

Why do the URLs need to end in /api and /auth?
HaloPSA handles sign-in tokens at /auth and data requests at /api. If you enter only the base address, BizRatings reaches the HaloPSA web page instead of the API.

Why is my Client Secret blank when I reopen the page?
For security, BizRatings never sends the saved secret back to your browser. As long as you see the Secret saved badge, your secret is stored.

I lost my Client Secret. What do I do?
Generate a new one in HaloPSA (Configuration > Integrations > HaloPSA API > View Applications), paste it into BizRatings, then test and save. The old secret stops working as soon as a new one is generated.

Can I use different HaloPSA instances for different companies?
Yes. Each company in the company dropdown has its own saved credentials, so you can connect separate HaloPSA instances or tenants.

Will turning the integration off delete my credentials?
No. Unchecking Enable Halo PSA Integration for this company pauses the agent sync but keeps your credentials saved.

Can the API-only agent log in to HaloPSA or be assigned tickets?
No. API-only agents cannot log in to the HaloPSA web or mobile applications and cannot be assigned tickets. This is expected.

How do I remove BizRatings' access later?
Open the application in HaloPSA and click Remove this Application.

Related articles

• BizRatings User Management: How to Manage Users, Licenses, and Permissions
• Inserting BizRatings CSAT Survey HTML Snippet into Halo Email Templates

Still stuck? Email support@bizratings.com and include the exact error message shown in BizRatings.