HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to retrieve multiple webhook event records. It is designed to fetch a list of webhook events, optionally filtered and ordered according to user-defined criteria. This functionality is useful for scenarios where you need to monitor or analyze webhook activity within HaloPSA, such as auditing webhook calls, debugging integrations, or synchronizing webhook data with other systems.

Practical examples include:

  • Retrieving all webhook events related to a specific automation or integration method.
  • Fetching a limited number of recent webhook events for display in a dashboard.
  • Applying filters and sorting to organize webhook event data before processing.

Properties

Name Meaning
Return All Whether to return all webhook event results or only up to a specified limit.
Limit The maximum number of webhook event results to return when not returning all. Minimum value is 1.
Filters A collection of optional filters and options to refine the query:
- Automation ID Filter webhook events by a specific automation ID (number).
- ID Only If true, return only the IDs of the webhook events instead of full details.
- Integration Method ID Filter webhook events by a specific integration method ID (number).
- Order The name of the first field to order the results by (string).
- Order 2 The name of the second field to order the results by (string).
- Order 3 The name of the third field to order the results by (string).
- Order 4 The name of the fourth field to order the results by (string).
- Order 5 The name of the fifth field to order the results by (string).
- Order Descending Whether to sort descending (true) or ascending (false) on the first order field.
- Order Descending 2 Whether to sort descending (true) or ascending (false) on the second order field.
- Order Descending 3 Whether to sort descending (true) or ascending (false) on the third order field.
- Order Descending 4 Whether to sort descending (true) or ascending (false) on the fourth order field.
- Order Descending 5 Whether to sort descending (true) or ascending (false) on the fifth order field.
- Page Number When using pagination, the page number to return (default 1).
- Page Size When using pagination, the size of each page (default 50).
- Paginate Whether to use pagination in the response (boolean).
- Webhook ID Filter webhook events by a specific webhook ID (UUID string).

Output

The node outputs JSON data representing the retrieved webhook events. Each item in the output corresponds to a webhook event record, containing fields as returned by the HaloPSA API. If the "ID Only" filter is enabled, the output will contain only the IDs of the webhook events.

If binary data were involved (not indicated here), it would typically represent attachments or payloads associated with webhook events, but this node focuses on JSON data.

Dependencies

  • Requires an active connection to the HaloPSA API via an API key credential configured in n8n.
  • The node uses the HaloPSA API endpoints related to webhook events.
  • Proper network access and permissions to call the HaloPSA API are necessary.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems preventing access to the HaloPSA API.
    • Incorrect filter values causing empty results or errors.
    • Pagination parameters misconfigured leading to unexpected result counts.

  • Error messages:

    • Authentication errors usually indicate invalid API keys; verify and update credentials.
    • API rate limits may cause temporary failures; consider adding delays or reducing request frequency.
    • Invalid filter or ordering fields may cause API errors; ensure field names match those supported by HaloPSA.

Links and References

Discussion