Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Custom Button → List Of Custom Button

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of custom buttons configured in the system. It is useful for scenarios where users want to programmatically access and manage UI customization elements such as buttons that trigger specific actions or workflows within Halo PSA.

Typical use cases include:

  • Fetching all custom buttons to display or audit their configurations.
  • Filtering buttons based on setup status or permissions.
  • Integrating button data into other automation workflows or dashboards.

For example, a user might want to list only those buttons that are fully set up and have permissions assigned, to ensure they are ready for deployment.

Properties

Name Meaning
Isbuttonsetup Filter to specify whether to include only buttons that are set up (true or false).
Ispermissionsetup Filter to specify whether to include only buttons with permissions set up (true/false).
Msid Filter by MSID (likely an identifier related to the button or its context).
Typeid Filter by Type ID (likely categorizing the button type).

These properties are sent as query parameters to the API request to filter the list of custom buttons returned.

Output

The node outputs an array of JSON objects, each representing a custom button retrieved from the Halo PSA API. The structure of each object corresponds directly to the API response for custom buttons, typically including details such as button identifiers, labels, setup status, permission settings, and other metadata.

No binary data output is involved in this operation.

Example output snippet (simplified):

[
  {
    "id": "123",
    "label": "Approve Request",
    "isButtonSetup": true,
    "isPermissionSetup": true,
    "msid": "456",
    "typeId": "789"
  },
  ...
]

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate API requests.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the API key credential is properly configured in n8n and linked to the node.

  • Resource or Operation not found
    Indicates a misconfiguration in the resource or operation selection. Verify that "Custom Button" is selected as the resource and "List Of Custom Button" as the operation.

  • API request errors
    If the API returns errors (e.g., authentication failure, invalid query parameters), the node will throw exceptions unless "Continue On Fail" is enabled. Check the credentials and input property values for correctness.

  • Invalid query parameter values
    Since the filters are passed as query parameters, ensure boolean-like fields (Isbuttonsetup, Ispermissionsetup) are correctly set to true or false strings or appropriate values expected by the API.

Links and References

Discussion