HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Overview

This node integrates with the HaloPSA API to create new support tickets. It is designed for IT service management or customer support workflows where users need to log issues, requests, or incidents into the HaloPSA system automatically. Typical use cases include:

  • Automatically creating a ticket when an error alert is triggered in monitoring software.
  • Logging customer requests received via email or chat into the ticketing system.
  • Creating tickets from form submissions on a website.

By automating ticket creation, organizations can ensure consistent tracking and faster response times.

Properties

Name Meaning
Summary The ticket summary or subject; a brief description of the issue (required).
Details Detailed description or notes about the ticket.
Client ID Numeric identifier of the client related to the ticket.
Site ID Numeric identifier of the site associated with the ticket.
User ID Numeric identifier of the user who created or owns the ticket.
Additional Fields A collection of optional fields to provide more context or metadata about the ticket:
- Address Line 1 First line of the address related to the ticket.
- Address Line 2 Second line of the address.
- Agent ID Numeric ID of the agent assigned to the ticket.
- Billable Boolean indicating if the ticket is billable.
- Category 1..4 Up to four category labels for classification.
- City City name related to the ticket location.
- Company Name Name of the company involved.
- Contact Name Name of the contact person.
- Cost Numeric cost amount associated with the ticket.
- Custom Field 1..5 Five customizable string fields for additional data.
- Date Occurred Date/time when the issue occurred.
- Deadline Date Deadline date/time for resolving the ticket.
- Email Address Email address related to the ticket.
- Email CC List Comma-separated list of emails to CC on notifications.
- Email To List Comma-separated list of emails to notify.
- Estimate (Hours) Estimated time to resolve the ticket in hours.
- Exclude From SLA Boolean to exclude this ticket from SLA calculations.
- Flagged Boolean indicating if the ticket is flagged for attention.
- Impact Impact level with options: None, Low, Medium, High.
- Important Contact Boolean indicating if the ticket is from an important contact.
- Is VIP Boolean indicating if the ticket is marked as VIP.
- On Hold Boolean indicating if the ticket is currently on hold.
- Phone Number Contact phone number.
- Postal Code Postal code related to the ticket location.
- Priority ID Numeric priority level identifier.
- Quantity Numeric quantity related to the ticket (context dependent).
- Reported By Name or identifier of the person who reported the issue.
- Show for Users Boolean indicating if users can see this ticket.
- SLA ID Numeric identifier for the SLA applied to the ticket.
- Source Numeric source identifier of the ticket origin.
- State/Region State or region related to the ticket location.
- Status ID Numeric status identifier of the ticket.
- Target Date Target completion date/time for the ticket.
- Team ID Numeric identifier of the team assigned to the ticket.
- Telephone Telephone number related to the ticket.
- Ticket Tags Comma-separated tags for categorizing the ticket.
- Ticket Type ID Numeric identifier for the type of ticket.
- Urgency Urgency level with options: None, Low, Medium, High.
- User Email Email address of the user related to the ticket.

Output

The node outputs JSON data representing the newly created ticket as returned by the HaloPSA API. This typically includes the ticket's unique identifier, status, timestamps, and all submitted fields. The output allows subsequent workflow steps to reference or manipulate the created ticket.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the HaloPSA API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The node uses internal helper modules to route actions and perform API requests.

Troubleshooting

  • Authentication errors: Ensure the API key or token credential is correctly set up and has sufficient permissions to create tickets.
  • Validation errors: Missing required fields like "Summary" will cause the API to reject the request. Make sure mandatory properties are provided.
  • API connectivity issues: Network problems or incorrect API endpoint configuration can prevent ticket creation.
  • Invalid field values: Providing invalid IDs (e.g., non-existent Client ID or Status ID) may result in errors. Verify that referenced entities exist in HaloPSA.
  • Rate limiting: Excessive requests might be throttled by the API; implement retry logic or reduce request frequency.

Links and References

Discussion