Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Custom Query → 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 "Custom Query" resource and the "Post Undefined" operation, it sends a POST request with a JSON body to execute a custom query or action defined by the user.

Typical use cases include:

  • Running custom queries against the Halo PSA backend that are not covered by standard operations.
  • Sending complex JSON payloads to trigger specific workflows or retrieve data in a customized format.
  • Integrating Halo PSA data with other systems by leveraging custom API endpoints.

For example, a user might send a JSON body containing lookup values and run results to fetch tailored reports or update multiple records in one request.

Properties

Name Meaning
Body A JSON object representing the request payload sent to the custom query endpoint. It typically includes fields like run_result (an object) and lookup_values (an array of objects). Users can define this JSON to match the expected input of their custom query.

Output

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

  • json: The parsed JSON response from the Halo PSA API after executing the custom query.
  • If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message instead of the expected data.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests via HTTP headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing Credentials: The node throws an error if no credentials are provided. Ensure that the API key credential is configured correctly in n8n.
  • Invalid Resource or Operation: Errors occur if the specified resource or operation does not exist. Verify that "Custom Query" and "Post Undefined" are selected properly.
  • Malformed JSON Body: Since the body is parsed as JSON, invalid JSON syntax will cause errors. Use proper JSON formatting in the "Body" property.
  • API Errors: If the Halo PSA API returns an error (e.g., authentication failure, bad request), the node will throw unless "Continue On Fail" is enabled, in which case the error message is included in the output.
  • Dynamic Endpoint Parameters: The code supports replacing path parameters in the endpoint URL; ensure any required parameters are provided.

Links and References

Discussion