This guide walks through connecting HaloPSA to WorkSights. Unlike most integrations, there is no OAuth redirect - you create an API Application inside your own HaloPSA tenant and paste the credentials into WorkSights. The process takes around five minutes.

HaloPSA and HaloITSM both use the same API. Self-hosted Halo instances are also supported.

Connecting HaloPSA

Step 1: Create an API Application in HaloPSA

In your HaloPSA tenant, navigate to Configuration → Integrations → API. Create a new API Application with the following settings:

• Authentication Method: Client ID and Secret (Services)
• Login Type: Agent
• Agent to log in as: Application Identity
• Identity Role: sys-all-permissions

Note: “Administrator” as the Identity Role will not work. Sys-all-permissions is required.

Once the application is created, click the Permissions tab and tick each of the following scopes individually. Scopes are not granted automatically. Even with the sys-all-permissions selected, the application has no access until each scope is manually checked:

• read:tickets
• read:customers
• read:assets
• read:contracts
• read:projects
• read:kb
• admin:webhooks

Save the application. Copy the Client ID and Client Secret - you will need these in the next step.

Step 2: Connect in WorkSights

In WorkSights, go to Settings → Services and select HaloPSA. Enter the following:

• Tenant URL: Your HaloPSA tenant address (e.g., yourcompany.halopsa.com). For HaloITSM tenants, use your haloitsm.com address. For self-hosted instances, use your custom hostname.
• Client ID: From the API Application you created in Step 1.
• Client Secret: From the API Application you created in Step 1.

WorkSights will validate your credentials and register the webhook automatically. Once validation succeeds, the connection is established.

Step 3: Agent Mapping

After connecting, WorkSights imports your agent list from HaloPSA and presents a mapping screen. Match each Halo agent to the corresponding WorkSights user by email where possible. WorkSights will attempt automatic matching first.

Only mapped agents will have their ticket activity attributed on the timeline. Agents who are not mapped will not generate any activity in WorkSights, regardless of their ticket volume.

What Happens Next

Once the connection is established and agents are mapped, WorkSights begins receiving ticket events in real time. New tickets, status changes, agent updates, and user replies will start appearing on your team’s timeline as they happen in HaloPSA.

There is no backfill. Only events that occur after the connection is established will appear in WorkSights. Ticket activity that predates the connection will not be imported.

Agent mappings can be reviewed and updated at any time from the HaloPSA integration page in Settings → Services. If new agents are added to your Halo tenant after the initial connection, use Refresh Connection to re-pull the agent list and map them.

Related Guides

HaloPSA Integration Overview