Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Online Status → Get Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve online status information about technical agents or users. It allows querying various parameters related to an agent's online presence, such as whether they are currently online, their last active time, and status overrides.

Common scenarios for this node include monitoring agent availability in a service desk environment, tracking user activity for reporting, or integrating real-time status data into workflows that depend on agent presence.

For example, you could use this node to:

  • Fetch all agents currently online.
  • Check if a specific technician (by Tech ID) is logged out or idle.
  • Retrieve the last online date/time of agents for audit purposes.

Properties

Name Meaning
Tech ID Numeric identifier of the technician to query.
Last Online Date Date string representing the last date the agent was online.
Is Online Boolean flag indicating if the agent is currently online (true or false).
Last Online Timestamp string of the last time the agent was online.
Agent Status Numeric code representing the current status of the agent.
Status Overridden Boolean indicating if the agent's status has been manually overridden.
Fetch All Boolean flag to fetch all records regardless of filters (true or false).
Is Logout Boolean indicating if the agent is currently logged out.
Command String command parameter for additional filtering or control (usage depends on API).
Last Active Timestamp string representing the last active time of the agent.
Is Idle Boolean indicating if the agent is currently idle.

Output

The node outputs JSON objects containing the response from the Halo PSA API corresponding to the online status query. Each output item corresponds to one input item processed.

The JSON structure typically includes fields reflecting the queried properties such as agent identifiers, online/offline status, timestamps, and status flags.

No binary data output is produced by this node.

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 for the Halo PSA service.
  • Network connectivity to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API authentication credentials. Ensure the required API key credential is properly set up in n8n.

  • Resource or Operation not found
    If the specified resource ("Online Status") or operation ("Get Undefined") is not recognized, verify that the node parameters are correctly selected and match the available options.

  • API request errors
    Errors during the HTTP request to the Halo PSA API may occur due to network issues, invalid parameters, or permission problems. Review the error message returned and check API access rights and parameter correctness.

  • JSON parsing errors
    If using JSON parameters, ensure that any JSON strings provided are valid and correctly formatted.

Links and References

Discussion