Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Schedule Plan → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to create or post a "Contract Schedule Plan" resource. It allows users to send complex JSON data representing contract schedules, events, agents, roles, and related nested entities to the Halo PSA system via an HTTP POST request.

Typical use cases include automating contract schedule creation or updates in Halo PSA from external systems or workflows, such as syncing contract plans from CRM or ERP systems, or programmatically managing service contracts and their schedules.

For example, a user might configure this node to post a detailed contract schedule plan including event definitions, agent assignments, roles, notifications, and custom fields, enabling automated contract lifecycle management within Halo PSA.

Properties

Name Meaning
Body The full JSON payload representing the contract schedule plan to be posted. This includes nested objects for events, agents, roles, notifications, custom fields, outcomes, schedules, and many other related entities. The property expects a JSON object structured according to the Halo PSA API schema for contract schedule plans.

The "Body" property is a JSON type input where users provide the entire contract schedule plan data structure. It supports deeply nested arrays and objects to represent all aspects of the contract schedule.

Output

  • The node outputs the JSON response returned by the Halo PSA API after posting the contract schedule plan.
  • The output JSON contains the created or updated contract schedule plan details as returned by the API.
  • If the operation fails and "Continue On Fail" is enabled, the output will contain an error message describing the failure.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses credentials that must include base URL, tenant identifier, client ID, and client secret for the Halo PSA API.
  • Network connectivity to the Halo PSA API endpoint is required.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot retrieve the necessary API authentication credentials. Ensure that valid credentials are configured in n8n before running the node.
  • Resource or Operation not found: If the specified resource or operation does not exist in the node configuration, verify that "Contract Schedule Plan" and the correct operation ("Post Undefined") are selected.
  • Invalid JSON in Body: Since the body is parsed from a JSON string, malformed JSON will cause parsing errors. Validate the JSON syntax before execution.
  • API request failures: Errors from the Halo PSA API (e.g., authentication errors, validation errors) will be returned in the node output. Check the error messages for details and ensure the request body conforms to the API schema.
  • Enable "Continue On Fail" to allow workflow continuation despite individual item errors and to capture error details in output.

Links and References

This summary is based on static analysis of the provided source code and property definitions without runtime execution.

Discussion