Creating a New HaloPSA Agent

When connecting your Alternative Payments (API) application to HaloPSA, you'll need to link an agent account that the integration can authenticate with. By default, we recommend using an agent with full admin permissions, but we understand that's not always the right fit for every organization.

If your team has security or compliance requirements that restrict the use of admin-level accounts for third-party integrations, you can instead create a dedicated agent with a specific, limited set of permissions. This article walks you through creating that agent and configuring the minimum permissions required for the API integration to function correctly.

Step 1 - Create a New Agent in HaloPSA

Start by creating a brand-new agent account that will be used exclusively by the API integration. We recommend keeping this agent separate from any human user accounts to make it easier to manage access and audit activity.

1. Log in to your HaloPSA instance as an administrator.

2. Navigate to Configuration → Teams & Agents → Agents.

3. Click New.

4. Fill in the required agent details. We suggest a descriptive name such as Alternative Payments API to make its purpose immediately clear to other admins.

5. Save the agent.

Step 2 - Configure the Required Permissions

Once the agent is created, you'll need to assign the following permission levels. These are the minimum permissions required for the API integration to read and update client, invoice, and contract data within HaloPSA. Click on Edit to set the following permissions:

• Client Access level: Read and Modify

• Invoice Access Level: Read, Create and Modify

• Client Contracts Level: Read and Modify

Step 3 - Link the Agent to Your API Application

Follow our HaloPSA Integration Set-Up Guide to associate newly the agent to the API application you create to successfully integrate with Alternative Payments.