Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Canned Text → List Of Canned Text

AI-generated

Overview

This node integrates with the Halo PSA API to list canned text entries. It allows users to retrieve predefined text snippets (canned texts) that can be used for quick responses or standardized communication within a service desk or support environment.

Common scenarios include:

  • Fetching canned responses filtered by access control level, agent, department, group, team, or ticket association.
  • Automating retrieval of relevant canned texts to insert into tickets or communications.
  • Managing and displaying lists of canned texts based on organizational roles or teams.

For example, a support automation workflow could use this node to fetch all canned texts available to a specific department or agent before sending a response to a customer.

Properties

Name Meaning
Access Control Level Filter canned texts by their access control level.
Agent Id Filter canned texts associated with a specific agent ID.
Department Id Filter canned texts linked to a particular department ID.
Group Id Filter canned texts belonging to a certain group ID.
Showall Option to show all canned texts regardless of other filters.
Team Id Filter canned texts related to a specific team ID.
Ticketonly Filter to include only canned texts that are ticket-related.

All these properties are optional query parameters sent to the API to refine the list of canned texts returned.

Output

The node outputs an array of JSON objects representing the canned texts retrieved from the Halo PSA API. Each item in the output corresponds to one canned text entry with its associated data fields as provided by the API.

No binary data is output by this operation.

Example output structure (simplified):

[
  {
    "id": "string",
    "title": "string",
    "content": "string",
    "accessControlLevel": "string",
    "agentId": "string",
    "departmentId": "string",
    "groupId": "string",
    "teamId": "string",
    "ticketOnly": true
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant identifier, client ID, and client secret from the credentials to authorize requests.
  • No additional external dependencies beyond the configured Halo PSA API credentials.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API authentication credentials. Ensure that valid credentials are configured in n8n before running the node.

  • Resource or Operation not found
    If the specified resource ("Canned Text") or operation ("List Of Canned Text") is missing or misspelled, the node will throw an error. Verify the resource and operation names.

  • API request failures
    Network issues, invalid query parameters, or insufficient permissions may cause API errors. Check the error message returned in the output JSON under the error field when "Continue On Fail" is enabled.

  • Invalid JSON in parameters
    If using JSON input fields for additional parameters, ensure the JSON syntax is correct to avoid parsing errors.

Links and References

Discussion