Documentation to assist with the setup and configuration of the HaloPSA platform
Set up as follows;
Payload URL – this is the url where our api will send the message to
Content type – can only be application/json. All our payloads are in JSON format. The receiving service must accept a JSON payload
Authentication – No Authentication if none required on the receiving service. Basic Authentication allows input of username and password if the receiving service requires Basic Authentication.
Events – This is a list of events that trigger the webhook to be sent. These are basically the same as Halo Notification profiles and work the same way – ie “New Ticket Logged”, “Ticket Reassigned” etc. Like notifications you can put conditions on these. You need at least one event per Webhook profile.
Once the conditions of an event are met, our API will then queue a HTTP Post to the Payload URL containing the ticket and action objects where applicable. The response from the receiving api will then be recorded and will be viewable from the Deliveries tab of the webhook. Examples of this are in the below screenshots.
If when an event happens, a record appears in the deliveries tab, our applications work is done. It’s then in the hands of the customer to implement something to accept the payload and do what they want to do with the payload at the destination.
- Asset Import - CSV/XLS/Spreadsheet Method
- Call Management in Halo
- Creating a New Application for API Connections
- Creating Agents and Editing Agent Details
- Departments, Teams and Roles
- Halo Integrator
- Importing Data
- Multiple New Portals with different branding for one customer [Hosted]
- Organisation Basics
- Organising Teams of Agents
- Step-by-Step Configuration Walk Through