Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Incoming Email → List Of Incoming Email

AI-generated

Overview

This node integrates with the Halo PSA API to list incoming emails. It allows users to retrieve a paginated and optionally ordered list of incoming email records from their Halo PSA system. This is useful for automating workflows that involve monitoring, processing, or analyzing incoming email communications within an IT service management or customer support context.

Practical examples include:

  • Automatically fetching new incoming emails to create tickets or trigger follow-up actions.
  • Generating reports on recent email activity.
  • Filtering and sorting incoming emails based on various criteria for further processing.

Properties

Name Meaning
Order A string parameter to specify the first ordering criterion for the list of emails.
Order 2 A string parameter to specify the second ordering criterion.
Order 3 A string parameter to specify the third ordering criterion.
Order 4 A string parameter to specify the fourth ordering criterion.
Order 5 A string parameter to specify the fifth ordering criterion.
Orderdesc A parameter to specify if the first order should be descending (true/false).
Orderdesc 2 A parameter to specify if the second order should be descending.
Orderdesc 3 A parameter to specify if the third order should be descending.
Orderdesc 4 A parameter to specify if the fourth order should be descending.
Orderdesc 5 A parameter to specify if the fifth order should be descending.
Page No The page number of results to retrieve (for pagination).
Page Size The number of items per page to retrieve.
Pageinate Likely a flag or parameter related to pagination control (exact meaning depends on API).
Showcurrentagentonly A filter to show only emails assigned to the current agent/user.

All these properties are sent as query parameters in the API request to customize the listing of incoming emails.

Output

The node outputs an array of JSON objects representing incoming emails retrieved from the Halo PSA API. Each item corresponds to one incoming email record with all its associated data fields as returned by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests with appropriate headers to communicate with the Halo PSA API.
  • Configuration of these credentials must be done in n8n prior to using the node.

Troubleshooting

  • No credentials returned!: This error occurs if the node cannot find or access the required API credentials. Ensure that the API key credential is properly configured in n8n.
  • Resource or Operation not found: If the specified resource or operation does not exist, verify that the correct resource ("Incoming Email") and operation ("List Of Incoming Email") are selected.
  • API request failures: Network issues, incorrect credentials, or invalid query parameters can cause request errors. Check the API endpoint URL, credentials, and parameter values.
  • Pagination issues: If no results or incomplete results are returned, verify the Page No and Page Size parameters to ensure proper pagination.
  • Malformed query parameters: Since many parameters are optional and free-form strings, ensure they conform to expected API formats.

Links and References

If you need more detailed information about specific parameters or example payloads, please refer to the official Halo PSA API documentation or provide additional source code details.

Discussion