HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Overview

This node interacts with the HaloPSA API to retrieve webhook data. Specifically, the "Get Many" operation under the "Webhook" resource fetches multiple webhook records from the system. This is useful for scenarios where you want to list or process all webhooks configured in HaloPSA, such as auditing webhook configurations, monitoring integrations, or syncing webhook data with other systems.

Practical examples include:

  • Retrieving all webhooks to display them in a dashboard.
  • Filtering webhooks by type (e.g., outbound or runbook) to manage specific integration points.
  • Exporting webhook configurations for backup or migration purposes.

Properties

Name Meaning
Return All Whether to return all webhook results or limit the number of returned items.
Limit Maximum number of webhook results to return when "Return All" is false.
Filters Collection of filters to narrow down the webhook results:
  Is Azure Automation Filter to include only Azure Automation webhooks if set to true.
  Type Filter webhooks by type: 0 for Outbound, 1 for Runbook.

Output

The node outputs an array of webhook objects in the json field of each item. Each object represents a webhook retrieved from HaloPSA and includes its properties as provided by the API. The exact structure depends on the API response but typically contains identifiers, webhook URLs, types, and related metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the HaloPSA API using an API key or token credential configured in n8n.
  • The node relies on the HaloPSA API endpoints to fetch webhook data.
  • Proper network access and permissions to query webhook information in the HaloPSA instance are necessary.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems preventing access to the HaloPSA API.
    • API rate limits or permission restrictions causing incomplete or failed responses.
  • Error messages:

    • Authorization errors: Verify that the API key/token is valid and has sufficient permissions.
    • Timeout or connection errors: Check network settings and HaloPSA service availability.
    • Invalid filter values: Ensure that filter parameters like "Type" use correct numeric values (0 or 1).

Links and References

Discussion