Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Xtype → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the resource Xtype and the operation Post Undefined, it sends a POST request with a complex JSON body to create or update an "xtype" entity in the Halo PSA system.

Typical use cases include automating the creation or modification of custom types or configurations within Halo PSA, such as defining fields, booking types, timeslots, access controls, and other related settings programmatically. This is useful for users who want to manage their PSA configurations dynamically from workflows without manual intervention.

For example, you might use this node to:

  • Create a new xtype configuration with detailed nested properties.
  • Update existing xtype definitions by sending the full JSON structure.
  • Automate environment setup or migration tasks involving xtype data.

Properties

Name Meaning
Body A JSON object representing the full xtype configuration to be sent in the POST request. It includes nested arrays and objects such as fields, field_list, bookingtypes, timeslots, xtype_roles, tab_config, allowed_status, booking_sites, access_control, services, and field_restrictions. Each of these contains further nested structures to define visibility conditions, rates, access control rules, translations, custom slots, resources, validation data, and more.

The property expects a JSON input that fully describes the xtype entity's structure according to Halo PSA's API schema.

Output

The node outputs the JSON response returned by the Halo PSA API after performing the POST request. The output is structured as:

{
  "json": { ... }
}

Where the json field contains the API response, which typically includes confirmation of the created or updated xtype, any generated IDs, status messages, or error details if the request failed.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests with appropriate headers to communicate with the API.
  • No additional external services are required beyond the Halo PSA API.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error stating "No credentials returned!" Ensure that valid API authentication details are configured.
  • Resource or Operation Not Found: Errors like Resource Xtype not found or Operation Post Undefined not found for resource Xtype indicate misconfiguration of the resource or operation parameters.
  • Invalid JSON Body: Since the body must be valid JSON, malformed input will cause parsing errors. Validate JSON syntax before running the node.
  • API Request Failures: Network issues, incorrect endpoint URLs, or insufficient permissions can cause request failures. Check API connectivity and credential scopes.
  • Continue On Fail: If enabled, the node will return error messages in the output JSON instead of stopping execution, allowing workflows to handle errors gracefully.

Links and References

Discussion