Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Canned Text → Delete Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Canned Text resource with the Delete Undefined operation, it deletes a canned text entry identified by its ID.

Common scenarios where this node is useful include automating the management of canned text snippets in a service desk or IT support environment, such as removing outdated or unused canned responses programmatically.

Practical example: Automatically deleting a specific canned text snippet by its ID when it is no longer relevant, as part of a cleanup workflow.

Properties

Name Meaning
Id The numeric identifier of the canned text entry to delete. This property is required.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains the response from the Halo PSA API after attempting the deletion. The structure typically includes confirmation of deletion or error details if the operation failed.

If an error occurs and "Continue On Fail" is enabled, the output JSON will contain an error field with the error message.

No binary data output is produced by 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 REST API.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause the node to throw an error "No credentials returned!".
    • Providing an invalid or non-existent canned text ID may result in an API error indicating the resource was not found.
    • Network connectivity issues can cause request failures.

  • Error messages:

    • "No credentials returned!": Ensure that the API credentials are correctly set up in n8n.
    • "Resource Canned Text not found" or "Operation Delete Undefined not found for resource Canned Text": Indicates misconfiguration of resource or operation parameters.
    • API errors returned from Halo PSA will appear in the output JSON under the error key if "Continue On Fail" is enabled.

  • Resolution tips:

    • Verify all input parameters, especially the Id.
    • Confirm that the API credentials have sufficient permissions to delete canned texts.
    • Check network access to the Halo PSA API endpoint.

Links and References

  • Halo PSA API Documentation (general reference for API endpoints)
  • n8n documentation on HTTP Request Node for understanding underlying request mechanics
  • n8n community forums for troubleshooting custom node integrations

Discussion