Skip to main content

​
Overview

This guide explains how to set up the HaloPSA Integration in Thread.

​
Set up the integration

1

Step 1: Prepare Your Workspace

If this is your first time setting up your workspace, refer to Create your workspace for detailed instructions.
  1. When you initially set up your workspace in Thread, you will be prompted to configure your ticketing system. If you select HaloPSA, you will be directed to a screen where you must enter your API credentials. Keep this screen open; we will return to it later.
HaloPSA API credentials screen in Thread workspace setup
  1. Open a new browser tab or window to proceed to the next step: Creating an API-Only Agent.
2

Step 2: Creating an API-Only Agent

  1. Login to Halo.
  2. Navigate to the Configuration section.
  3. Go to Team & Agents → Agents.
  4. Click New in the top-right corner to create a new agent.
  5. Give it a username (e.g., Thread API Agent).
  6. Set the Is an API-only Agent checkbox to selected. API-only agents do not take up a license.
  7. Select No Default Team under the Default Team dropdown.
  8. Select Default Working Hours from the dropdown and click save.
  9. Click the Permissions tab, select the following permissions, and click Save.
  1. Click Save to save the newly created API-only Agent.
3

Step 3: Creating an Integrator Application

  1. Navigate to the Configuration section.
  2. Go to Integrations → HaloPSA API.
  3. Click View Applications.
  4. Click New in the top-right corner to create a new application.
  5. Enter an application name (e.g., Thread API Application).
  6. For Authentication Method select Client ID and Client Secret (Services).
  7. Make sure to keep the Client ID and Client Secret in a safe place for later.
  8. Login Type should be selected as Agent.
  9. Select the API-only Agent previously created under Agent to log in as.
Selecting the API-only Agent for the HaloPSA integrator application
  1. Click the Permissions tab, select the following permissions, and click Save.
    The all:teams permission was introduced in HaloPSA v2.148.1 to grant API access to all Teams/Departments. If you don’t have it, upgrade to v2.148 or newer. If you can’t upgrade, edit the API-only Agent created earlier, open the Teams & Departments tab, and grant access to all Teams/Departments.
  2. Click Save to save the newly created application.
4

Step 4: Create Actions for Key Events

To ensure seamless integration between Thread and HaloPSA, you need to map three specific actions in the subsequent steps for the following events:
  1. Action for sending customer-facing notes
  2. Action for sending internal notes
  3. Action for emailing contacts
For detailed instructions on configuring actions, please refer to the guide by clicking the button below. Ensure you have created and mapped these custom actions before proceeding to the next step.

Action Mapping Configuration with Thread

Configure and map the custom HaloPSA actions Thread needs to sync notes, emails, and messages.
5

Step 5: Continue Your Workspace Setup

  1. Head back to your other tab from Step 1: Prepare Your Workspace.
  2. Enter your HaloPSA API Base URL. (e.g., https://threadsandbox.halopsa.com).**Important**: To ensure full functionality, ensure no trailing ’/’, subdirectory, or parameter is appended to the url.
  3. Copy and paste the Client ID and Client Secret retrieve from Step 2: Creation an API-Only Agent.
  4. Click Continue. Next, design your customer chat experience.
Continue button in the HaloPSA workspace setup
See Integrations updates in the changelog.

Related topics

Set Up the Autotask PSA Ticketing IntegrationSet Up the ConnectWise PSA Ticketing IntegrationSet Up Email Support for Magic Agents and Inbox