Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Esc Msg → List Of Esc Msg

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of "Esc Msg" (likely "Escalation Messages" or similar) records. It is designed to fetch and filter messages based on various query parameters, supporting pagination and filtering by IDs or timestamps.

Common scenarios where this node is beneficial include:

  • Monitoring escalation messages in a service desk or support environment.
  • Automating reporting or alerting workflows based on new or updated escalation messages.
  • Integrating escalation message data into other systems for analysis or processing.

For example, you could use this node to:

  • Retrieve all escalation messages newer than a specific ID to process only recent updates.
  • Paginate through large sets of messages using page number and size parameters.
  • Filter messages by client version or server checks to target specific environments.

Properties

Name Meaning
Checkhalointegrator Query parameter to filter messages related to the Halo integrator (exact meaning depends on API).
Checknhserver Query parameter to filter messages related to NH server status or checks.
Clientversion String to specify the client version for filtering messages.
Count Query parameter likely used to limit the number of returned messages.
Newer Than Id Filter to return messages with IDs newer than this value.
Older Than Id Filter to return messages with IDs older than this value.
Page No Page number for paginated results.
Page Size Number of items per page in paginated results.
Pageinate Possibly a boolean or flag to enable/disable pagination (exact meaning depends on API).
Update Shown Query parameter possibly indicating whether to update the "shown" status of messages.
Utc Offset Timezone offset to adjust date/time fields in the response.

All these properties are sent as query parameters in the API request when performing the "List Of Esc Msg" operation.

Output

The node outputs JSON data representing the list of escalation messages retrieved from the Halo PSA API. Each item in the output corresponds to one message record, including all fields returned by the API.

The exact structure of each message depends on the API response but typically includes identifiers, timestamps, message content, and status flags.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant identifier, client ID, and client secret via credentials.
  • Uses HTTP requests to communicate with the Halo PSA REST API endpoints.

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 ("Esc Msg") or operation ("List Of Esc Msg") is not recognized, verify that the node parameters are correctly set and match the supported values.

  • API request errors
    Network issues, invalid query parameters, or authentication failures may cause errors during the API call. Review the error message returned and check API credentials, endpoint URLs, and parameter correctness.

  • JSON parsing errors
    If custom JSON parameters are provided (not typical for this operation), ensure they are valid JSON strings.

Links and References

Note: The above summary is based solely on static code analysis and provided property definitions without runtime execution.

Discussion