Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Canned Text → Get One Canned Text

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a single canned text entry by its identifier. It is useful in scenarios where you want to fetch predefined text snippets (canned texts) stored in Halo PSA for use in automated workflows, such as inserting standard responses into tickets or emails.

For example, you might use this node to:

  • Retrieve a specific canned text to include in a customer support reply.
  • Fetch a template message before sending it through another system.
  • Automate documentation or reporting by pulling standardized text blocks.

Properties

Name Meaning
Id The unique numeric identifier of the canned text to retrieve.
Includedetails Optional query parameter to specify whether to include additional details in the output.

Output

The node outputs a JSON object representing the requested canned text resource as returned by the Halo PSA API. This typically includes fields such as the canned text content, its ID, and possibly metadata depending on the Includedetails parameter.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "title": "Sample Canned Text",
  "content": "This is the canned response text.",
  "details": { /* optional additional details if requested */ }
}

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret configured in n8n.
  • The node uses HTTP requests with appropriate headers for authentication.

Troubleshooting

  • No credentials returned!
    Ensure that the API credentials are properly set up and connected in n8n before running the node.

  • Resource or Operation not found errors
    Verify that the selected resource is "Canned Text" and the operation is "Get One Canned Text". These must match exactly.

  • HTTP request failures
    Check network connectivity and API endpoint availability. Also confirm that the provided Id exists in the Halo PSA system.

  • JSON parsing errors
    If using advanced parameters (not typical for this operation), ensure any JSON input is correctly formatted.

Links and References

Discussion