Halo

PSA and service desk for MSPs to manage tickets, clients, projects, quotes, and assets.

7 triggers15 searches18 actionsPollingAuth: OAuth

AI-assisted documentation24 min read

This documentation is compiled from our integration source code, internal specs for Halo, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Halo on WEXTL →

Requirements

To use Halo on WEXTL you need an active account and OAuth client credentials, granted by signing in with your account.[3]

Get your Halo credentials

Credential type option 1

_Halo

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

Client IDpasswordRequired
Follow the instruction to obtain your credentials. Make sure you generate Client ID and Secret (Services) credentials type.
[1]
Client SecretpasswordRequired
EnvironmentselectRequired

Credential type option 2

_Halo v2

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

Client IDpasswordRequired
Follow the instruction to obtain your credentials. Make sure you generate Client ID and Secret (Services) credentials type.
[1]
Client SecretpasswordRequired
EnvironmentselectRequired

Credential type option 3

_Halo v3

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

Client IDpasswordRequired
Follow the instruction to obtain your credentials. Make sure you generate Client ID and Secret (Services) credentials type.
[1]
Client SecretpasswordRequired
EnvironmentselectRequired

Credential type option 4

_Halo v4

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

Client IDpasswordRequired
Follow the instruction to obtain your credentials. Make sure you generate Client ID and Secret (Services) credentials type.
[1]
Client SecretpasswordRequired
EnvironmentselectRequired

Credential type option 5

Halo v5

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

Client IDtextRequired
Client SecretpasswordRequired
EnvironmentselectRequired

Connect Halo in WEXTL

Log in to your WEXTL account, add the Halo node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Halo account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting Halo to WEXTL® — Video slide demonstrates how to integrate Halo in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Halo in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Halo node modules

The list below is a reference of every Halo node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any Halo node module below to inspect its input parameters, outputs, and connection requirements.

Watch ClientsTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Top Level ID	number
Top Level Name	text
Inactive	boolean
Colour	text
Confirmation Email Enabled	number
Action Email Enabled	number
Clear Email Enabled	number
Message Group ID	number
Mailbox Override	number
Default Mailbox ID	number
Item Tax Code	number
Service Tax Code	number
Prepay Tax Code	number
Contract Tax Code	number
Primary Technician	number
Secondary Technician	number
Account Manager	number
Xero ID	text

28other output fields

Watch ItemsTrigger

Output fields[3]

Field	Type
ID	number
Usage	text
Item Name	text
Status	number
Asset Group ID	number
Asset Group Name	text
Auto Group New Quote Lines	number
Supplier Part Code	text
Description	text
Base Price	number
Created By User ID	number
Supplier ID	number
Supplier Name	text
Manufacturer ID	number
Manufacturer Name	text
Asset Type ID	number
Asset Type Name	text
Minimum Purchase Quantity	number
Prompt for Price	boolean
Tax Code	number

61other output fields

Watch OpportunitiesTrigger

Output fields[3]

Field	Type
ID	number
Date Occurred	text
Summary	text
Details	text
Status	number
Ticket Type	number
SLA	number
Priority	number
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User ID	number
User Name	text
Team ID	number
Team	text
Agent ID	number
Category Level 1	text
Category Level 2	text
Category Level 3	text

89other output fields

Watch ProjectsTrigger

Output fields[3]

Field	Type
ID	number
Date Occurred	text
Summary	text
Details	text
Status	number
Ticket Type	number
SLA	number
Priority	number
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User ID	number
User Name	text
Team ID	number
Team	text
Agent ID	number
Category Level 1	text
Category Level 2	text
Category Level 3	text

87other output fields

Watch QuotesTrigger

Output fields[3]

Field	Type
ID	number
Dateoccurred	date
Summary	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User name	text
Team	text
Agent ID	number
Agent name	text
Category 1	text
Category 2	text
Category 3	text
Category 4	text
Estimate	number

17other output fields

Watch Sales OrdersTrigger

Output fields[3]

Field	Type
ID	number
Use	text
Title	text
Ticket ID	number
User ID	number
User name	text
Site ID	number
Site name	text
Client ID	number
Client name	text
Client to invoice to ID	number
Assigned agent	number
Open status	number
Date	date
Ship date	date
Cost	number
Profit	number
Note	text
Po number	text
Createdby agent ID	number

41other output fields

Watch TicketsTrigger

Output fields[3]

Field	Type
ID	number
Date Occurred	date
Summary	text
Status ID	number
Ticket Type ID	number
SLA ID	number
Priority ID	number
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User Name	text
Team	text
Agent ID	number
Agent Name	text
Category 1	text
Category 2	text
Category 3	text
Category 4	text
Estimate	number

17other output fields

Get a ClientAction

Input fields[3]

Field	Type
Client IDRequired	number

Output fields[3]

Field	Type
ID	number
Name	text
Toplevel ID	number
Toplevel Name	text
Inactive	boolean
Colour	text
Confirmemail	number
Actionemail	number
Clearemail	number
Messagegroup ID	number
Mailbox Override	number
Default Mailbox ID	number
Item Tax Code	number
Service Tax Code	number
Prepay Tax Code	number
Contract Tax Code	number
Pritech	number
Sectech	number
Accountmanagertech	number
Xeroid	text

29other output fields

Get a ProjectAction

Input fields[3]

Field	Type
Project IDRequired	choice
Ticket ID Only	boolean
Include Details	boolean
Include Last Action	boolean

Output fields[3]

Field	Type
ID	number
Dateoccurred	date
Summary	text
Details	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User ID	number
User name	text
Team	text
Agent ID	number
Category 1	text
Category 2	text
Category 3	text
Category 4	text

110other output fields

Get a QuoteAction

Input fields[3]

Field	Type
Quote IDRequired	choice

Output fields[3]

Field	Type
ID	number
Title	text
Ticket ID	number
Status	number
Po ref	text
Date	date
Expiry date	date
Revenue	number
Tax total	number
Total	number
Cost	number
Profit	number
Carriage desc	text
Carriage price	number
Auth by	text
Note	text
User	object
ID	number
Name	text
Site ID	number
Site name	text
Client name	text
Firstname	text
Surname	text
Initials	text
Title	text
Emailaddress	text
User ID	number
User name	text
Site ID	number

23other output fields

Get a Sales OrderAction

Input fields[3]

Field	Type
Sales Order IDRequired	choice
Include Details	boolean

Output fields[3]

Field	Type
Customfields	array
ID	number
Use	text
Title	text
Ticket ID	number
User	object
Is comms user	boolean
Ischangeapprover 2	boolean
ID	number
Name	text
Site ID	number
Site ID int	number
Site name	text
Client name	text
Firstname	text
Surname	text
User ID	number
User name	text
Site ID	number
Site name	text
Client ID	number
Client name	text
Client to invoice to ID	number
Assigned agent	number
Assigned agent name	text
Open status	number
Date	text
Ship date	text
Total	number
Cost	number

49other output fields

Get a TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice
Ticket ID Only	boolean
Include Details	boolean
Include Last Action	boolean

Output fields[3]

Field	Type
ID	number
Date Occurred	date
Summary	text
Details	text
Status ID	number
Ticket Type ID	number
SLA ID	number
Priority ID	number
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User ID	number
User Name	text
Team ID	number
Team Name	text
Agent ID	number
Category Level 1	text
Category Level 2	text
Category Level 3	text

75other output fields

Get a UserAction

Input fields[3]

Field	Type
User IDRequired	choice
Include Details	boolean
Include Activity	boolean
Include Popups	boolean

Output fields[3]

Field	Type
ID	number
Name	text
Site ID	number
Site name	text
Client name	text
Firstname	text
Surname	text
Initials	text
Title	text
Emailaddress	text
Phonenumber preferred	text
Sitephonenumber	text
Phonenumber	text
Homenumber	text
Mobilenumber	text
Mobilenumber 2	text
Fax	text
Telpref	number
Activedirectory dn	text
Container dn	text

132other output fields

Get an ItemAction

Input fields[3]

Field	Type
Item IDRequired	choice
Include Details	boolean

Output fields[3]

Field	Type
ID	number
Usage	text
Item Name	text
Status	number
Asset Group ID	number
Asset Group Name	text
Auto Group New Quote Lines	number
Supplier Part Code	text
Description	text
Base Price	number
Created By User ID	number
Supplier ID	number
Supplier Name	text
Manufacturer ID	number
Manufacturer Name	text
Asset Type ID	number
Asset Type Name	text
Minimum Purchase Quantity	number
Prompt for Price	boolean
Tax Code	number

63other output fields

Get an OpportunityAction

Input fields[3]

Field	Type
Opportunity IDRequired	choice
Include Details	boolean
Include Last Action	boolean
Ticket ID Only	boolean

Output fields[3]

Field	Type
ID	number
Dateoccurred	date
Summary	text
Details	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User ID	number
User name	text
Team	text
Agent ID	number
Category 1	text
Category 2	text
Category 3	text
Category 4	text

295other output fields

Search ClientsSearch

Input fields[3]

Field	Type
Order By	choice
Order Descending	boolean
Search	text
Top Level ID	number
Include Inactive	boolean
Include Active	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Colour	text
Inactive	boolean
Toplevel ID	number
Toplevel Name	text
Custom Fields	array

Search ItemsSearch

Input fields[3]

Field	Type
Search	text
Order By	text
Order By Descending	boolean
Order By Second Field	text
Order By Second Field Descending	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Usage	text
Item Name	text
Status	number
Asset Group ID	number
Asset Group Name	text
Auto Group New Quote Lines	number
Supplier Part Code	text
Description	text
Base Price	number
Created By User ID	number
Supplier ID	number
Supplier Name	text
Manufacturer ID	number
Manufacturer Name	text
Asset Type ID	number
Asset Type Name	text
Minimum Purchase Quantity	number
Prompt for Price	boolean
Tax Code	number

61other output fields

Search OpportunitiesSearch

Input fields[3]

Field	Type
List ID	number
Agent ID	number
Status ID	choice
Request Type ID	number
Supplier ID	number
Client ID	choice
Site	choice
User Name	text
User ID	choice
Release ID	number
Asset ID	choice
ITIL Request Type ID	number
Open Only	boolean
Closed Only	boolean
Unlinked Only	boolean
Contract ID	number
Team IDs	array
Team ID	choice
Agent IDs	array
Agent ID	choice
Status IDs	array
Status ID	choice
Search String	text

15other input fields

Output fields[3]

Field	Type
ID	number
Dateoccurred	text
Summary	text
Details	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User ID	number
User name	text
Team	text
Agent ID	number
Category 1	text
Category 2	text
Category 3	text
Category 4	text

45other output fields

Search ProjectsSearch

Input fields[3]

Field	Type
Order By	text
Order Descending	boolean
Ticket ID Only	boolean
View ID	number
Columns ID	number
Include Columns	boolean
Include SLA Action Date	boolean
Include SLA Timer	boolean
Include Time Taken	boolean
Include Supplier	boolean
Include Release 1	boolean
Include Release 2	boolean
Include Release 3	boolean
Include Child Ticket IDs	boolean
Include Next Activity Date	boolean
List ID	number
Agent ID	choice
Status ID	choice
Request Type ID	number
Supplier ID	choice

44other input fields

Output fields[3]

Field	Type
ID	number
Date Occurred	date
Summary	text
Details	text
Status ID	number
Ticket Type ID	number
SLA ID	number
Priority ID	number
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User ID	number
User Name	text
Team ID	number
Team Name	text
Agent ID	number
Category 1	text
Category 2	text
Category 3	text

80other output fields

Search QuotesSearch

Input fields[3]

Field	Type
Search	text
Ticket ID	choice
Client ID	number
Site ID	number
User ID	choice
Order By	text
Order By Descending	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Dateoccurred	date
Summary	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User name	text
Team	text
Agent ID	number
Agent name	text
Category 1	text
Category 2	text
Category 3	text
Category 4	text
Estimate	number

17other output fields

Search TicketsSearch

Input fields[3]

Field	Type
Order By	text
Order Descending	boolean
Ticket ID Only	boolean
View ID	number
Columns ID	number
Include Columns	boolean
Include SLA Action Date	boolean
Include SLA Timer	boolean
Include Time Taken	boolean
Include Supplier	boolean
Include Release 1	boolean
Include Release 2	boolean
Include Release 3	boolean
Include Child Ticket IDs	boolean
Include Next Activity Date	boolean
List ID	number
Agent ID	choice
Status ID	choice
Request Type ID	number
Supplier ID	choice

44other input fields

Output fields[3]

Field	Type
ID	number
Date Occurred	date
Summary	text
Details	text
Status ID	number
Ticket Type ID	number
SLA ID	number
Priority ID	number
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User ID	number
User Name	text
Team ID	number
Team Name	text
Agent ID	number
Category Level 1	text
Category Level 2	text
Category Level 3	text

75other output fields

Search UsersSearch

Input fields[3]

Field	Type
Order By	text
Order Descending	boolean
Search	text
Search Phone Numbers	boolean
Top Level ID	number
Client ID	choice
Site ID	choice
Organisation ID	number
Department ID	number
Asset ID	choice
Include Active	boolean
Include Inactive	boolean
Approvers Only	boolean
Exclude Agents	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Site ID	number
Site ID int	number
Site name	text
Client name	text
Firstname	text
Surname	text
Initials	text
Emailaddress	text
Phonenumber preferred	text
Sitephonenumber	text
Phonenumber	text
Telpref	number
Activedirectory dn	text
Login	text
Inactive	boolean
Colour	text
Isimportantcontact	boolean
Other 1	text

20other output fields

Create / Update a QuoteAction

Input fields[3]

Field	Type
QuotesRequired	array
Quote ID	number
Title	text
Ticket ID	choice
Status	choice
PO Reference	text
Date	date
Expiry Date	date
Revenue	number
Tax Total	number
Total	number

Output fields[3]

Field	Type
ID	number
Title	text
Ticket ID	number
Status	number
Po ref	text
Date	date
Expiry date	date
Revenue	number
Tax total	number
Total	number
Cost	number
Profit	number
Carriage desc	text
Carriage price	number
Auth by	text
Note	text
User	object
ID	number
Name	text
Site ID	number
Site name	text
Client name	text
Firstname	text
Surname	text
Initials	text
Title	text
Emailaddress	text
User ID	number
User name	text
Site ID	number

23other output fields

Create / Update a Sales OrderAction

Input fields[3]

Field	Type
ItemsRequired	array
Item ID	number
Name	text
Item Default Billing Period	number
Autorenew Quote Line Default	boolean
Income Account Name	text
Expense Account Name	text
Asset Account Name	text
Manufacturer Name	text
Asset Account Code	text
Xero Tenant Name	text

Output fields[3]

Field	Type
Customfields	array
ID	number
Use	text
Title	text
Ticket ID	number
User	object
Is comms user	boolean
Ischangeapprover 2	boolean
ID	number
Name	text
Site ID	number
Site ID int	number
Site name	text
Client name	text
Firstname	text
Surname	text
User ID	number
User name	text
Site ID	number
Site name	text
Client ID	number
Client name	text
Client to invoice to ID	number
Assigned agent	number
Assigned agent name	text
Open status	number
Date	text
Ship date	text
Total	number
Cost	number

49other output fields

Create / Update an ItemAction

Input fields[3]

Field	Type
ItemsRequired	array
Item ID	number
Name	text
Item Default Billing Period	number
Autorenew Quote Line Default	boolean
Income Account Name	text
Expense Account Name	text
Asset Account Name	text
Manufacturer Name	text
Asset Account Code	text
Xero Tenant Name	text

Output fields[3]

Field	Type
ID	number
Usage	text
Item Name	text
Status	number
Asset Group ID	number
Asset Group Name	text
Auto Group New Quote Lines	number
Supplier Part Code	text
Description	text
Base Price	number
Created By User ID	number
Supplier ID	number
Supplier Name	text
Manufacturer ID	number
Manufacturer Name	text
Asset Type ID	number
Asset Type Name	text
Minimum Purchase Quantity	number
Prompt for Price	boolean
Tax Code	number

61other output fields

Create / Update an OpportunityAction

Input fields[3]

Field	Type
OpportunitiesRequired	array
Opportunity ID	number
Title	text
Ticket ID	choice
Status	choice
PO Reference	text
Date	date
Expiry Date	date
Revenue	number
Tax Total	number
Total	number

Output fields[3]

Field	Type
ID	number
Dateoccurred	text
Summary	text
Details	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User ID	number
User name	text
Team	text
Agent ID	number
Category 1	text
Category 2	text
Category 3	text
Category 4	text

45other output fields

Create a ClientAction

Input fields[3]

Field	Type
ClientsRequired	array
NameRequired	text
Contact Email Address	email
Contact Name	text
Top Level ID	number
Top Level Name	text
Important Customer	boolean
Site Name	text
Phone Number	text
Override Org Address	object

Output fields[3]

Field	Type
ID	number
Name	text
Toplevel ID	number
Toplevel Name	text
Inactive	boolean
Colour	text
Confirmemail	number
Actionemail	number
Clearemail	number
Messagegroup ID	number
Mailbox Override	number
Default Mailbox ID	number
Item Tax Code	number
Service Tax Code	number
Prepay Tax Code	number
Contract Tax Code	number
Pritech	number
Sectech	number
Accountmanagertech	number
Xeroid	text

29other output fields

Create a SiteAction

Input fields[3]

Field	Type
NameRequired	text
Customer NameRequired	text
Main SiteRequired	text
Phone Number	text
Address	object
Address Line 1	text
Address Line 2	text
Address Line 3	text
Address Line 4	text
Postcode	text
Contact Name	text
Contact Email Address	email

Output fields[3]

Field	Type
Site ID	number

Create a TicketAction

Input fields[3]

Field	Type
Email Address	email
Ticket Type	choice
Ticket ID	choice
Status ID	choice
Summary	text
Message Sent	text
Details	text
Details HTML	text
Priority	choice
Client ID	number
Client Name	text
Site ID	number
Site Name	text
User ID	choice
User Name	text
Team	text
Category 1	text
Category 2	text
Category 3	text
Category 4	text

6other input fields

Output fields[3]

Field	Type
Ticket ID	number

Create a UserAction

Input fields[3]

Field	Type
UsersRequired	array
NameRequired	text
Customer NameRequired	text
Site NameRequired	text
Email Address	email
Network Login	text
Work Phone Number	text
Mobile Phone Number	text

Output fields[3]

Field	Type
User ID	number

Delete a ClientAction

Input fields[3]

Field	Type
Client IDRequired	number

Delete a ProjectAction

Input fields[3]

Field	Type
Project IDRequired	choice

Delete a QuoteAction

Input fields[3]

Field	Type
Quote IDRequired	choice

Delete a Sales OrderAction

Input fields[3]

Field	Type
Sales Order IDRequired	choice

Delete a TicketAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Delete a UserAction

Input fields[3]

Field	Type
User IDRequired	choice

Delete an ItemAction

Input fields[3]

Field	Type
Item IDRequired	choice

Delete an OpportunityAction

Input fields[3]

Field	Type
Opportunity IDRequired	choice

Output fields[3]

Field	Type
ID	number
Dateoccurred	date
Summary	text
Details	text
Status ID	number
Tickettype ID	number
Sla ID	number
Priority ID	number
Client ID	number
Client name	text
Site ID	number
Site name	text
User ID	number
User name	text
Team	text
Agent ID	number
Category 1	text
Category 2	text
Category 3	text
Category 4	text

295other output fields

Make an API Calluniversal

Input fields[3]

Field	Type
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Update a ClientAction

Input fields[3]

Field	Type
ClientsRequired	array
Client IDRequired	number
Name	text
Contact Email Address	email
Contact Name	text
Top Level ID	number
Top Level Name	text
Important Customer	boolean
Site Name	text
Phone Number	text
Override Org Address	object

Output fields[3]

Field	Type
ID	number
Name	text
Toplevel ID	number
Toplevel Name	text
Inactive	boolean
Colour	text
Confirmemail	number
Actionemail	number
Clearemail	number
Messagegroup ID	number
Mailbox Override	number
Default Mailbox ID	number
Item Tax Code	number
Service Tax Code	number
Prepay Tax Code	number
Contract Tax Code	number
Pritech	number
Sectech	number
Accountmanagertech	number
Xeroid	text

29other output fields

Templates

Look for Halo templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Support category →

References

WEXTL® Halo Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Halo.
WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:11

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.