HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Overview

This node integrates with the HaloPSA API to create a new Ticket Status. Ticket statuses are used in ticketing systems to represent the current state of a support or service ticket, such as "Open," "In Progress," or "Closed." Creating custom ticket statuses allows organizations to tailor their workflow and reporting to better fit their operational needs.

Common scenarios where this node is beneficial include:

  • Automating the setup of new ticket workflows by programmatically adding statuses.
  • Synchronizing ticket status configurations across multiple environments.
  • Extending the default set of statuses with custom ones that reflect specific business processes.

For example, a user might create a "Waiting on Customer" status with a specific color and sequence order to visually distinguish tickets that require customer input.

Properties

Name Meaning
Name The name of the ticket status to be created (e.g., "Open", "Pending").
Additional Fields A collection of optional fields to further define the ticket status:
- Colour Hex color code representing the status color (e.g., "#FF0000" for red).
- Include in Load Balance Boolean indicating if tickets with this status should be included in load balancing.
- Sequence Numeric value defining the order or priority of the status in lists or workflows.
- Short Name A short label for the status, useful for compact displays.
- Show on Quick Change Boolean indicating whether this status appears in quick change dropdowns or menus.
- SLA Action Defines the SLA action associated with this status; options are: "None", "Hold", "Remove Hold".
- Type Numeric type identifier for the status (usage depends on system configuration).

Output

The node outputs JSON data representing the newly created ticket status object as returned by the HaloPSA API. This typically includes all properties of the ticket status such as its ID, name, color, sequence, and other metadata.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the HaloPSA API using a valid API authentication token configured in n8n credentials.
  • The node relies on the HaloPSA API endpoint /Status to create ticket statuses.
  • Proper permissions on the API key are necessary to perform create operations on ticket statuses.

Troubleshooting

  • API Authentication Errors: If the node fails due to authentication issues, verify that the API key credential is correctly configured and has sufficient permissions.
  • Validation Errors: Missing required fields like "Name" will cause errors. Ensure all mandatory properties are provided.
  • Invalid Color Codes: Providing an invalid hex color code may result in API rejection. Use standard hex format (e.g., #RRGGBB).
  • Network Issues: Connectivity problems with the HaloPSA API can cause timeouts or failures. Check network access and API availability.
  • Unexpected API Responses: If the API changes or returns unexpected data, the node may fail. Review API documentation and update the node accordingly.

Links and References

Discussion