The CloudRadial AutomationAI HaloPSA extension lets a workflow or agent work with your HaloPSA data: tickets and their actions, clients, sites, users, assets, billing, projects, appointments, the knowledge base, services, and reports, and, with approval, create and update tickets, clients, sites, users, assets, appointments, and knowledge base articles. This article covers what the extension can do, the API credentials it needs, which tools require approval, how to set ticket custom fields, the read-only variant, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
Version 1.3.1 adds ticket custom fields: a new approval-gated tool sets custom field values on an existing ticket, and the create and update ticket tools accept custom fields too. If you already have the extension installed, your workflows and agents pick up the change automatically; you do not need to reinstall it. See Setting Ticket Custom Fields.
- What the Extension Covers
- Creating HaloPSA API Credentials
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Setting Ticket Custom Fields
- The Read-Only Variant
- How Lists Are Paged
- Skills
- Tips for Working With HaloPSA Data
What the Extension Covers
The extension calls the HaloPSA API and provides 72 tools across these areas:
| Area | What you can automate |
|---|---|
| Tickets | Query and read tickets, create a ticket (optionally from a ticket template), update, reassign, or close a ticket, and set its custom fields |
| Ticket actions | Read a ticket's actions, attachments (metadata only), and to-dos, and add a note, public reply, private note, or time entry |
| Clients, sites, and users | Query and read clients, sites, and end users, read a client's CRM notes, and create or update a client, site, or user |
| Assets | Query and read assets and asset types, and create or update an asset |
| Billing | Read contracts, invoices, recurring invoices, items, quotes, sales orders, purchase orders, and suppliers. Read-only. |
| Projects and opportunities | Query and read projects and opportunities. Read-only. |
| Appointments and time | Query and read appointments, create or update an appointment, and read an agent's timesheet events |
| Knowledge base | Search and read knowledge base articles, and create or update an article |
| Services and reports | Read services and their current status, list saved reports, and run a saved report |
| Lookups | Resolve statuses, priorities, ticket types and their fields, categories, teams, agents, SLAs, outcomes, templates, and canned text |
Install it from Extensions like any other catalog extension. It appears in the catalog as Halo PSA. See Browsing and installing extensions for the general install flow.
Creating HaloPSA API Credentials
The extension signs in to HaloPSA with OAuth client credentials: a client ID and a client secret from a HaloPSA API application.
- In HaloPSA, go to Configuration > Integrations > Halo API, select View Applications, and create a new application with the Client ID and Secret (Services) authentication method
- Copy the Client ID and Client Secret, and store the secret somewhere safe
- Under Permissions on the same application, enable the permissions your automations need
The runner requests a HaloPSA access token with these credentials and sends it on every call. The token request asks for every scope, but HaloPSA grants only the permissions enabled on the API application and on the agent linked to it. Those permissions are what actually limit what the extension can do.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names:
| Secret | Value |
|---|---|
Halo-ApiUrl |
Your HaloPSA base URL, host only, for example https://yourname.halopsa.com. Do not add a path such as /api; the extension adds it. |
Halo-ClientId |
The client ID of your HaloPSA API application |
Halo-ClientSecret |
The client secret paired with that client ID |
For how to add these, see Accessing and updating your runner's Key Vault. The agent reads the credentials from the runner and never asks you for them. Once the secrets are in place, ask the AI Playground to list your HaloPSA ticket statuses to confirm the connection works.
Reads and Approval-Gated Changes
Of the 72 tools, 55 are read-only and run without interruption. The other 17 create or change something, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
The approval-gated tools are:
- Create, update, or close a ticket
- Set custom fields on a ticket
- Add an action to a ticket (a note, reply, private note, or time entry)
- Create or update a client
- Create or update a site
- Create or update a user
- Create or update an asset
- Create or update an appointment
- Create or update a knowledge base article
The extension has no delete tools. To offboard a user or retire a client, site, asset, or article, update it and mark it inactive.
Setting Ticket Custom Fields
HaloPSA identifies each custom field by a numeric id. To set custom fields on an existing ticket, the extension uses an approval-gated tool that takes the ticket id and a list of fields, each with an id and a value. Only the fields in the list change; every other field on the ticket keeps its value.
The create ticket and update ticket tools also accept an optional customFields list in the same shape, so you can set custom fields in the same step that creates or updates the ticket. A call without the list behaves exactly as it did before 1.3.1.
When an agent uses the Manage a Halo PSA Ticket skill to set custom fields, it:
- Finds the field ids from the ticket's type (which lists the fields on that type) or from the ticket itself (which shows the values already set). It never guesses an id; if a field is not on the ticket type, it stops and tells you.
- Asks for approval and sets the fields.
- Reads the ticket back and reports only the fields that now appear on it. HaloPSA shows only the custom fields of a ticket's current type, so the agent tells you which fields did not appear instead of reporting them as changed.
Values are sent as text. Enter text as is, dates in ISO 8601 format (for example 2026-11-16), and for a lookup or picklist field, the option id or value as HaloPSA shows it on the ticket. When you build a workflow that sets custom fields, put a ticket type or ticket lookup ahead of the write so the field ids come from your own HaloPSA instance rather than being hard-coded.
The Read-Only Variant
The catalog also offers Halo PSA (Read-Only). It has every read tool of the main extension, unchanged, and no write tools, so nothing it does can change your HaloPSA data. Running a saved report counts as a read and is included. It uses the same three secrets, and it ships ten read-only versions of the skills.
Choose the read-only variant for agents that only need to look things up, such as reporting or triage. Because HaloPSA has no read-only token scope, the strongest guarantee is on the HaloPSA side: give the API application read-only permissions and link it to an agent that has read-only rights. With those in place, write requests fail at HaloPSA even if they are approved.
Both extensions use the same tool names, so install one or the other. If you install both, limit each agent to one of them in its allowed extensions. See Creating custom agents and using them in workflows.
How Lists Are Paged
Most list tools, including contracts, invoices, items, quotes, orders, projects, and knowledge base articles, page through results automatically, 100 records per page, for up to 10 pages. A query that matches 1,000 records or more fails with an error rather than returning a partial list, so narrow it with a search term or another filter.
The ticket, client, site, user, and asset queries work differently. They take a count and return the total number of matching records, so an agent can count records (for example, a technician's open tickets) without reading them all.
Skills
The extension ships ten skills that guide an agent through common HaloPSA tasks:
| Skill | Use it to |
|---|---|
| Manage a Halo PSA Ticket | Find, read, create, update, reassign, or close tickets, and set ticket custom fields. Creating, updating, setting custom fields, and closing are approval-gated. |
| Add and Review Halo PSA Ticket Actions | Read a ticket's history, attachments, or to-dos, or add a note, reply, private note, or time entry. Adding an action is approval-gated. |
| Manage Halo PSA Clients, Sites, and Users | Look up, create, or update clients, sites, and end users, or read a client's CRM notes. Creates and updates are approval-gated. |
| Manage Halo PSA Assets | Look up, create, or update assets (configuration items). Creates and updates are approval-gated. |
| Resolve Halo PSA Configuration and Lookup Values | Resolve ids and configuration: statuses, priorities, ticket types and their fields, categories, teams, agents, SLAs, outcomes, templates, and canned text. Read-only. |
| Review Halo PSA Contracts and Billing | Review contracts, invoices, recurring invoices, items, quotes, sales and purchase orders, and suppliers, including reconciling recurring billing against a distributor. Read-only. |
| Review Halo PSA Projects and Opportunities | Read projects and opportunities. Read-only. |
| Manage Halo PSA Appointments and Time | Read or book appointments and review agent timesheets. Creating and updating appointments is approval-gated. |
| Manage Halo PSA Knowledge Base | Search, read, create, or update knowledge base articles. Creates and updates are approval-gated. |
| Review Halo PSA Services and Reports | Check service status or run a saved report. Read-only. |
In the read-only variant, the skills that can write are replaced by read-only versions, such as Review Halo PSA Tickets and Review Halo PSA Assets.
Tips for Working With HaloPSA Data
- Refer to clients, users, agents, and statuses by name and let the agent look up the id. It resolves names with the query and lookup tools rather than guessing.
- To create a ticket from a ticket template, ask the agent to find the template first. Ticket templates are the ones you manage under Configuration > Tickets > Templates in HaloPSA.
- When you change a ticket's agent or team, the update must force the reassignment. The ticket skill does this for you; set it yourself when you call the update tool from a workflow.
- If your HaloPSA instance requires an outcome on every action, the agent looks up the outcome id (for example, the Private Note outcome) before it adds the action
- To count a technician's open tickets, ask for the count rather than the tickets. The agent reads the total without listing every ticket.
- If every call fails at sign-in, check that
Halo-ApiUrlis your host only, with no path, and that both secrets are set with the exact names above - If an approved write fails with a permission error, check the permissions on the HaloPSA API application and on the agent linked to it
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.