Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Rule → 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 "Contract Rule" resource and the "Post Undefined" operation, it sends a POST request with a JSON body to create or update contract rules based on provided criteria.

Common scenarios where this node is beneficial include automating contract management workflows, such as creating new contract rules dynamically from other systems or updating existing rules programmatically. For example, a user might use this node to automatically add contract rule criteria when a new client signs up or when certain conditions in a project are met.

Properties

Name Meaning
Body A JSON object representing the contract rule data to be sent in the request body. It typically includes a rule_criteria array defining the specific criteria for the contract rule. The default value is an object with an empty criteria array: { "rule_criteria": [ {} ] }.

Output

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

  • json: The parsed JSON response returned by the Halo PSA API after performing the requested operation on the Contract Rule resource.
  • If the operation fails and "Continue On Fail" is enabled, the output will contain an error message under json.error.

No binary data output is produced by this node for 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.

  • These credentials must be configured in n8n prior to using the node.

  • The node uses HTTP requests to communicate with the Halo PSA API endpoints.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot retrieve the required API credentials. Ensure that the API key credential is properly set up and selected in the node configuration.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Contract Rule") and operation ("Post Undefined") names are used.

  • JSON parsing errors
    Since the "Body" property expects a JSON string, invalid JSON syntax will cause errors. Make sure the JSON is well-formed.

  • API request failures
    Network issues, incorrect credentials, or invalid request bodies can cause the API call to fail. Check the error messages returned in the output and verify connectivity and permissions.

  • Continue On Fail behavior
    If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion