Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Custom Button → Get One Custom Button

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data about custom buttons configured in the system. Specifically, the "Get One Custom Button" operation fetches detailed information about a single custom button by its unique identifier.

Use cases include:

  • Automating workflows that need to display or process metadata about specific custom buttons.
  • Synchronizing custom button configurations between Halo PSA and other systems.
  • Triggering actions based on properties of a particular custom button.

For example, you might use this node to get details of a custom button when a ticket is updated, then decide whether to trigger additional automation depending on the button's configuration.

Properties

Name Meaning
Id The unique numeric identifier of the custom button to retrieve.
Includedetails Optional flag (query parameter) to specify whether to include detailed information.

Output

The node outputs JSON data representing the retrieved custom button object from the Halo PSA API. This includes all standard fields describing the custom button, such as its ID, name, configuration, and optionally detailed metadata if requested.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "Example Button",
  "description": "A custom button for special action",
  "details": { /* present if includedetails=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 environment variables are needed beyond the configured credentials.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating missing credentials. Ensure the API key and related authentication details are correctly set up.
  • Resource or Operation Not Found: Errors occur if the specified resource or operation does not exist. Verify that "Custom Button" and "Get One Custom Button" are correctly selected.
  • Invalid Id Parameter: Providing an invalid or non-existent custom button ID will result in an API error. Confirm the ID corresponds to an existing custom button.
  • API Request Failures: Network issues or incorrect tenant/client credentials can cause request failures. Check connectivity and credential correctness.
  • JSON Parsing Issues: If additional query parameters or request bodies are malformed JSON, parsing errors may occur. Validate JSON inputs carefully.

Using the node’s "Continue On Fail" option can help handle errors gracefully within workflows.

Links and References

Discussion