Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Request Type → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API, allowing users to perform various operations on different resources within the Halo PSA system. Specifically, for the "Request Type" resource and the "Post Undefined" operation, it sends a POST request with a complex JSON body to create or update request type data in Halo PSA.

Common scenarios where this node is beneficial include automating the creation or modification of request types in a service management context, such as setting up new ticket categories, defining allowed teams, actions, statuses, and configuring detailed field information programmatically.

Practical example: A user wants to automate the setup of new request types with specific access controls, allowed clients, and custom fields without manually configuring them in the Halo PSA interface. This node can send the structured JSON payload representing all these configurations directly to the Halo PSA API.

Properties

Name Meaning
Body A JSON object representing the full configuration of the request type. It includes arrays and objects for fields like fieldidlist, allowed_teams, allowed_actions, allowed_status, multiple category levels (allowed_category1 to allowed_category4), detailed fields definitions (including nested custom fields, validation data, access control, visibility conditions, translations, etc.), allowed_clients, default services, access control settings, allowed appointment types, iframe custom tabs, translations, CORS whitelist, tab configuration, suggestion FAQ lists, load balance schedule, allowed child ticket types, and kanban status choices. Essentially, this property holds the entire structure needed to define or update a request type in Halo PSA via the API.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains:

  • json: The response from the Halo PSA API after sending the POST request. This typically includes confirmation of the created or updated request type or error details if the request failed.
  • pairedItem: Metadata linking the output to the original input item index.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including:

    • Base URL of the Halo PSA instance
    • Tenant identifier
    • Client ID
    • Client Secret

  • The node uses these credentials to authenticate API requests via HTTP headers.

  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Malformed JSON in the "Body" property can lead to request errors.
    • Incorrect or incomplete field definitions may cause the API to reject the request.
    • Network connectivity problems to the Halo PSA API endpoint.

  • Error messages:

    • "No credentials returned!": Indicates that the node could not retrieve the required API credentials. Ensure credentials are properly configured in n8n.
    • API error responses included in the output JSON under error key when continueOnFail is enabled. These should be inspected for details such as validation errors or permission issues.

  • Resolution tips:

    • Validate the JSON structure before running the node.
    • Confirm that all required fields and nested objects conform to the Halo PSA API schema.
    • Check network access and API endpoint availability.
    • Verify that the API credentials have sufficient permissions for creating or updating request types.

Links and References

Note: The provided JSON example in the "Body" property is highly nested and complex, reflecting the detailed configuration options available for request types in Halo PSA. Users should refer to the official Halo PSA API documentation for exact schema requirements.

Discussion