Skip to main content

Setup Overview

Setting up the HaloPSA integration involves three main steps:

Creating an Agent Resource

Set up a dedicated agent in HaloPSA that Neo Agent will use for time entries, ticket assignments, and action attribution.

Creating an API Application

Configure API credentials with the right scopes for Neo Agent to access your HaloPSA system programmatically.

Connecting to Neo Agent

Configure the connection between your HaloPSA system and Neo Agent using API credentials and integration settings.

Webhook Events

The ticket events Neo Agent subscribes its webhook to, created for you on connect.

Optional Capabilities

Letting Neo Manage Email Rules

Let an agent block repeat spam senders at source with an Ignore Email rule, instead of closing the same spam ticket over and over. Needs one extra OAuth scope.

How Permissions Work

Neo Agent uses two layers of access control: the HaloPSA API application’s OAuth scopes set the maximum API access (configured during setup), while the Neo Agent dashboard controls what Neo actually does — which areas it can read, write, or ignore, and whether actions require technician approval.

Mandatory Fields

HaloPSA lets you mark any field mandatory, and it enforces that on API writes as well as in the web interface. When an agent creates something that omits one — an action on a ticket, a new ticket, a contact, a knowledge base article — Halo refuses the write with a message such as Categories is mandatory. Neo reads that refusal, tells the agent which field Halo asked for, and lets it look up the valid values for your instance and retry. Two things follow from this:
  • Keep the picklist behind a mandatory field populated. If Halo requires a category but the list has no option the agent may select, the write cannot succeed and the agent reports the refusal instead.
  • A mandatory field on an action belongs to the action, not to the ticket. Supplying it does not change the ticket’s own categories, so it does not conflict with an agent instruction that forbids editing a ticket’s triage fields.
If you would rather agents never have to supply a field, clear its mandatory flag in HaloPSA under Configuration for that entity.

Prerequisites

Before starting the integration setup, ensure you have:
  • Admin Access: Administrative access to your HaloPSA system (Configuration section)
  • API Access: An active HaloPSA subscription with API access enabled
  • Named Licence: An available agent licence for the Neo Agent resource