Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

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 "Screen Layout" resource and the "Post Undefined" operation, it sends a POST request with a JSON body to configure or update screen layouts.

Common scenarios where this node is beneficial include automating the customization of user interface layouts in Halo PSA, such as setting tab configurations programmatically. For example, a user might automate the deployment of standardized screen layouts across multiple environments or tenants by defining the layout structure in JSON and posting it via this node.

Properties

Name Meaning
Body A JSON object representing the payload sent in the POST request. It typically includes configuration details such as tab_config, which defines the tabs and their settings for the screen layout. The property expects a valid JSON structure.

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 performing the POST request. This usually includes confirmation of the updated screen layout or details about the created configuration.
  • 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 response.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs proper configuration of the base URL, tenant identifier, client ID, and client secret for the Halo PSA environment.
  • Relies on network connectivity to the Halo PSA service endpoint.

Troubleshooting

  • No credentials returned!
    This error indicates that the required API authentication credentials are missing or not configured correctly in n8n. Ensure that the API key credential is set up and linked to the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the resource name is exactly "Screen Layout" and the operation is correctly set to "Post Undefined". Typos or unsupported operations will cause this error.

  • Invalid JSON in Body property
    Since the Body property expects valid JSON, malformed JSON will cause parsing errors. Use the built-in JSON editor or validate your JSON before running the node.

  • API request failures
    Network issues, incorrect credentials, or insufficient permissions can cause the API request to fail. Check the error messages returned in the output and verify your API access rights and network connectivity.

Links and References

Discussion