Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Lookup → 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 Lookup resource and the Post Undefined operation, it sends a JSON body payload to the corresponding API endpoint using an HTTP POST request.

Typical use cases include submitting complex nested lookup data structures to Halo PSA, such as rates, access control settings, sub-lookups, and translations. This can be useful for synchronizing or updating configuration data in Halo PSA programmatically.

For example, a user might send a structured JSON object defining multiple rate entries and access controls to update lookup tables or reference data used by Halo PSA workflows.

Properties

Name Meaning
Body A JSON object representing the payload to send in the POST request. It supports nested arrays and objects including rates, access_control, sub_lookup (which itself can contain nested rates, access_control, sub_lookup, and translations), and translations. The property expects a valid JSON structure describing the lookup data to post.

The default value is a template JSON illustrating the expected structure:

{
  "rates": [{}],
  "access_control": [{}],
  "sub_lookup": [
    {
      "rates": [{}],
      "access_control": [{}],
      "sub_lookup": [{}],
      "translations": [{}]
    }
  ],
  "translations": [{}]
}

Output

  • The node outputs the JSON response returned by the Halo PSA API after posting the lookup data.
  • The output is structured as an array of items, each containing a json field with the API response.
  • If the API call fails and the node is configured to continue on failure, the output will contain an error message inside the json field.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses credentials that provide:
    • Base URL of the Halo PSA instance
    • Tenant identifier
    • Client ID
    • Client Secret
  • These credentials must be configured in n8n before using the node.
  • The node depends on network connectivity to the Halo PSA API endpoint.

Troubleshooting

  • No credentials returned!
    This error occurs if the required API authentication credentials are not set or invalid. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist in the node's configuration, verify that you have selected the correct resource ("Lookup") and operation ("Post Undefined").

  • Invalid JSON in Body property
    Since the Body property expects a JSON string parsed into an object, malformed JSON will cause errors. Use proper JSON formatting and validate your input.

  • API request failures
    Network issues, incorrect credentials, or invalid payloads may cause the API request to fail. Check the error messages returned in the output and verify your API access and request data.

  • Continue on Fail behavior
    If enabled, the node will output error messages instead of stopping execution on failure, which can help in debugging batch executions.

Links and References

Discussion