Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Integration Request → List Of Integration Request

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Integration Request resource and the List Of Integration Request operation, it retrieves a list of integration requests from the Halo PSA system based on specified query parameters.

Typical use cases include:

  • Fetching integration request data for reporting or monitoring.
  • Automating workflows that depend on integration request statuses or details.
  • Filtering integration requests by criteria such as module ID, detail ID, direction (inbound/outbound), pagination, and ordering.

For example, you might use this node to retrieve all inbound integration requests related to a specific module, ordered by date, and process them further in your workflow.

Properties

Name Meaning
Count Limits the number of integration requests returned.
Detail Id Filters integration requests by a specific detail identifier.
Inbound Only If set, returns only inbound integration requests.
Module Id Filters integration requests by a specific module identifier.
Order Primary ordering field for sorting results.
Order 2 Secondary ordering field for sorting results.
Order 3 Tertiary ordering field for sorting results.
Order 4 Fourth-level ordering field for sorting results.
Order 5 Fifth-level ordering field for sorting results.
Orderdesc Indicates descending order for the primary ordering field.
Orderdesc 2 Indicates descending order for the secondary ordering field.
Orderdesc 3 Indicates descending order for the tertiary ordering field.
Orderdesc 4 Indicates descending order for the fourth-level ordering field.
Orderdesc 5 Indicates descending order for the fifth-level ordering field.
Outbound Only If set, returns only outbound integration requests.
Page No Specifies the page number for paginated results.
Page Size Specifies the number of items per page in paginated results.
Pageinate Enables or disables pagination (likely a boolean or flag).

Output

The node outputs an array of JSON objects representing integration requests retrieved from the Halo PSA API. Each item corresponds to one integration request record with its associated fields as returned by the API.

If the node is configured to handle binary data (not applicable for this operation), it would output binary data accordingly, but for this operation, the output is purely JSON.

Example output structure (simplified):

[
  {
    "json": {
      "id": "123",
      "module_id": "456",
      "detail_id": "789",
      "direction": "inbound",
      "status": "completed",
      "created_at": "2024-01-01T12:00:00Z",
      ...
    },
    "pairedItem": {
      "item": 0
    }
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant ID, client ID, and client secret via credentials.
  • Uses HTTP requests to communicate with the Halo PSA REST API.
  • Depends on n8n's built-in HTTP request helper methods.

Troubleshooting

  • No credentials returned!
    This error occurs if the required API authentication credentials are not provided or invalid. Ensure that the API key credential is correctly configured in n8n.

  • Resource or Operation not found
    Happens if the selected resource or operation does not exist or is misspelled. Verify that "Integration Request" and "List Of Integration Request" are correctly selected.

  • API request errors
    Network issues, incorrect query parameters, or API limits may cause errors. Check the error message returned in the output JSON under error for details.

  • JSON parsing errors
    If using JSON parameters or request bodies, ensure they are valid JSON strings.

  • Pagination issues
    Incorrect page numbers or sizes may result in empty responses. Adjust Page No and Page Size accordingly.

Links and References

This summary is based on static analysis of the node's source code and provided property definitions. It assumes standard behavior of the Halo PSA API and n8n platform conventions.

Discussion