Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Webhook Event → List Of Webhook Event

AI-generated

Overview

This node integrates with the Halo PSA API to list webhook events. It allows users to retrieve a collection of webhook event records filtered and sorted by various parameters. This is useful for automating workflows that depend on monitoring or processing webhook events generated within the Halo PSA system.

Common scenarios include:

  • Fetching recent webhook events for auditing or logging.
  • Filtering webhook events by automation or integration method IDs.
  • Paginating through large sets of webhook events.
  • Sorting webhook events by multiple criteria.

Practical example: A user wants to automatically fetch the latest 50 webhook events related to a specific automation ID, ordered by date descending, to trigger further processing in their workflow.

Properties

Name Meaning
Automation Id Filter webhook events by a specific automation identifier.
Count Limit the number of webhook events returned.
Idonly Return only the IDs of the webhook events (likely a boolean or flag).
Integrationmethod Id Filter webhook events by a specific integration method identifier.
Order Primary sorting field for the results (string).
Order 2 Secondary sorting field for the results (string).
Order 3 Tertiary sorting field for the results (string).
Order 4 Fourth-level sorting field for the results (string).
Order 5 Fifth-level sorting field for the results (string).
Orderdesc Whether to sort descending on the primary order field (likely boolean or flag).
Orderdesc 2 Whether to sort descending on the secondary order field.
Orderdesc 3 Whether to sort descending on the tertiary order field.
Orderdesc 4 Whether to sort descending on the fourth-level order field.
Orderdesc 5 Whether to sort descending on the fifth-level order field.
Page No The page number to retrieve (for pagination).
Page Size Number of items per page (for pagination).
Pageinate Likely a flag to enable or disable pagination.
Webhook Id Filter webhook events by a specific webhook identifier.

Output

The node outputs an array of JSON objects representing webhook events retrieved from the Halo PSA API. Each item corresponds to one webhook event record as returned by the API.

The exact structure of each webhook event object depends on the API response but typically includes fields such as event ID, timestamp, associated automation or webhook IDs, and other metadata.

No binary data output is indicated for this operation.

Dependencies

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

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 or operation does not exist, verify that the correct resource ("Webhook Event") and operation ("List Of Webhook Event") are selected.

  • API request errors
    Errors from the API (e.g., invalid parameters, authentication failure) will be returned in the node output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check the error message for details and verify parameter values and credentials.

  • Pagination issues
    Incorrect page number or size may result in empty or incomplete results. Adjust these parameters accordingly.

Links and References

If you need more detailed information about the webhook event fields or examples of API responses, please refer to the official Halo PSA API documentation.

Discussion