HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to update a specific ticket status. It allows users to modify various attributes of an existing ticket status, such as its name, color, sequence order, and SLA-related actions. This is useful in scenarios where ticket workflows or categorizations need to be adjusted dynamically, for example:

  • Changing the color coding of statuses to improve visual management.
  • Updating the sequence to reorder how statuses appear in lists.
  • Modifying SLA actions to reflect new business rules.
  • Enabling or disabling quick change visibility for certain statuses.

Practical example: A support team wants to add a new "On Hold" status with a specific color and ensure it triggers an SLA hold action. Using this node, they can update the existing status or create a new one with these properties programmatically.

Properties

Name Meaning
Ticket Status ID The unique identifier of the ticket status to update.
Update Fields Collection of fields to update on the ticket status:
- Colour Hex color code representing the status color (e.g., #FF0000).
- Include in Load Balance Boolean indicating if this status should be included in load balancing operations.
- Name The full name of the ticket status.
- Sequence Numeric value defining the order/sequence of the status.
- Short Name A short or abbreviated name for the status.
- Show on Quick Change Boolean indicating whether this status appears in quick change options.
- SLA Action SLA action associated with this status; options are: None, Hold, Remove Hold.
- Type Numeric type classification of the status (meaning depends on external context).

Output

The node outputs JSON data representing the updated ticket status object as returned by the HaloPSA API. This typically includes all the updated fields along with metadata such as the status ID. The output does not include binary data.

Example structure of the output JSON might include:

{
  "id": "123",
  "name": "In Progress",
  "shortname": "Prog",
  "colour": "#00FF00",
  "includeinloadbalance": true,
  "sequence": 2,
  "showonquickchange": true,
  "slaaction": "none",
  "type": 1
}

Dependencies

  • Requires an active connection to the HaloPSA API via an API key credential configured in n8n.
  • The node uses the HaloPSA REST API endpoints related to ticket statuses.
  • Proper permissions on the API key to update ticket statuses are necessary.
  • No additional external libraries beyond those bundled with the node.

Troubleshooting

  • Common Issues:

    • Invalid or missing Ticket Status ID will cause the update to fail.
    • Providing invalid values for fields (e.g., incorrect hex color format) may result in API errors.
    • Insufficient API permissions can lead to authorization errors.
    • Network connectivity issues can prevent communication with the HaloPSA API.

  • Error Messages:

    • "Ticket Status ID is required" — Ensure the ID field is filled.
    • "Unauthorized" or "Forbidden" — Check API credentials and permissions.
    • "Invalid input" — Verify that all fields conform to expected formats and types.
    • "Not Found" — The specified ticket status ID does not exist.

  • Resolution Tips:

    • Double-check the Ticket Status ID against your HaloPSA instance.
    • Validate all input fields before running the node.
    • Confirm API credentials have update rights.
    • Test API connectivity separately if network issues are suspected.

Links and References

Discussion