Log inStart free trial

Halo Support API: Watch Clients, Create a Client

PSA and service desk for MSPs to manage tickets, clients, projects, quotes, and assets. 7 triggers, 15 searches, and 18 actions including Watch Clients.

About this integration

PSA and service desk for MSPs to manage tickets, clients, projects, quotes, and assets. Use it from the workflow canvas with no custom glue script required.

This integration exposes 7 triggers, 15 search modules and 18 actions as workflow nodes. Authentication uses oauth or oauth or oauth or oauth or oauth authentication.

How to connect

The credential form asks for Client ID, Client Secret, Environment, and Client ID.

Prefer the interactive builder form? Open it on the app page.

Sign in and approve access — your password is never shared with WEXTL®, and you can revoke access from the provider at any time.

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

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

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

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

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

Connecting Halo to WEXTL®

Connecting Halo to WEXTL®

Field	Type	Help
Client IDRequired	password	Follow the instruction to obtain your credentials. Make sure you generate `Client ID and Secret (Services)` credentials type.
Client SecretRequired	password	—
EnvironmentRequired	select	—

Field	Type	Help
Client IDRequired	password	Follow the instruction to obtain your credentials. Make sure you generate `Client ID and Secret (Services)` credentials type.
Client SecretRequired	password	—
EnvironmentRequired	select	—

Field	Type	Help
Client IDRequired	password	Follow the instruction to obtain your credentials. Make sure you generate `Client ID and Secret (Services)` credentials type.
Client SecretRequired	password	—
EnvironmentRequired	select	—

Field	Type	Help
Client IDRequired	password	Follow the instruction to obtain your credentials. Make sure you generate `Client ID and Secret (Services)` credentials type.
Client SecretRequired	password	—
EnvironmentRequired	select	—

Field	Type	Help
Client IDRequired	text	—
Client SecretRequired	password	—
EnvironmentRequired	select	—

Use it in workflow automation

Start with Watch Clients, then add Create a Client.

The canvas below runs Watch Clients into Create a Client — watch the video, then drop a node onto the canvas.

Select the Watch Clients trigger and the workflow fires automatically when the event occurs — no polling required.

Then add Delete a Client as the next node. Branch, filter, or hand off to other integrations from there.

The integration includes 25 ready-made modules for support work — each run logs its inputs and outputs for debugging.

Halo workflow on the canvas: Watch Clients then Delete a Client

Halo workflow on the canvas: Watch Clients then Delete a Client

Triggers, searches and actions

Use the tables below to inspect Halo's 7 triggers, 15 search modules, and 18 actions.

Triggers

7 triggers fire automatically when specified events occur — no polling or cron job needed.

Watch Clients
Watch Items
Watch Opportunities
Watch Projects
Watch Quotes

2more triggers

Searches

Fetch data on demand using 15 search modules that query the app during a run.

Get a Client
Get an Item
Get an Opportunity
Get a Project
Get a Quote

10more searches

Actions

18 action modules cover the full range of create, update, and delete operations.

Create a Client
Create a Site
Create a Ticket
Create a User
Create / Update an Item

13more actions

Explore the fields available for each Halo trigger, search, and action.

Triggers

Output fields

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

Output fields

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

Output fields

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

Output fields

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

Output fields

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

Output fields

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

Output fields

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

Searches

Input fields

Field	Type
Client IDRequired	number

Output fields

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

Input fields

Field	Type
Item IDRequired	choice
Include Details	boolean

Output fields

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

Input fields

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

Output fields

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

Input fields

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

Output fields

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

Input fields

Field	Type
Quote IDRequired	choice

Output fields

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

Input fields

Field	Type
Sales Order IDRequired	choice
Include Details	boolean

Output fields

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

Input fields

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

Output fields

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

Input fields

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

Output fields

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

Input fields

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

Output fields

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

Input fields

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

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

Input fields

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

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

Input fields

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

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

Input fields

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

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

Input fields

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

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

Input fields

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

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

Actions

Input fields

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

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

Input fields

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

Field	Type
Site ID	number

Input fields

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

Field	Type
Ticket ID	number

Input fields

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

Field	Type
User ID	number

Input fields

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

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

Input fields

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

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

Input fields

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

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

Input fields

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

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

Input fields

Field	Type
Client IDRequired	number

Input fields

Field	Type
Item IDRequired	choice

Input fields

Field	Type
Opportunity IDRequired	choice

Output fields

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

Input fields

Field	Type
Project IDRequired	choice

Input fields

Field	Type
Quote IDRequired	choice

Input fields

Field	Type
Sales Order IDRequired	choice

Input fields

Field	Type
Ticket IDRequired	choice

Input fields

Field	Type
User IDRequired	choice

Input fields

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

Output fields

Field	Type
Body	text
Headers	object
Status code	number

Input fields

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

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