Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Live Chat Header → List Of Live Chat Header

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of live chat headers. It is designed to fetch metadata or summary information about live chat sessions, which can be useful for monitoring, reporting, or further processing in workflows that involve customer support or real-time communication management.

Common scenarios include:

  • Listing recent or active live chat sessions for analysis.
  • Filtering chats by profile, ticket, or conversation identifiers.
  • Paginating and ordering chat headers to manage large datasets efficiently.

Practical example:

  • A support team wants to automatically pull the latest 20 live chat headers sorted by creation date to display in a dashboard or trigger follow-up actions.

Properties

Name Meaning
After Cursor or token to fetch results after a specific point (pagination).
Chatprofile Id Filter live chat headers by a specific chat profile identifier.
Checkavailable Filter based on availability status (exact meaning depends on API).
Count Number of records to return (limit).
Ignore All Closed Option to exclude all closed chat headers from the results.
Order Primary field to order the results by (e.g., date, name).
Order 2 Secondary ordering field.
Order 3 Tertiary ordering field.
Order 4 Fourth-level ordering field.
Order 5 Fifth-level ordering field.
Orderdesc Boolean or flag indicating descending order for primary order field.
Orderdesc 2 Descending order flag for secondary order field.
Orderdesc 3 Descending order flag for tertiary order field.
Orderdesc 4 Descending order flag for fourth-level order field.
Orderdesc 5 Descending order flag for fifth-level order field.
Page No Page number for paginated results.
Page Size Number of items per page.
Pageinate Flag or parameter related to pagination behavior (specific meaning depends on API).
Teams Conversation Id Filter by Microsoft Teams conversation identifier.
Ticket Id Filter live chat headers associated with a specific ticket ID.

Output

The node outputs an array of JSON objects, each representing a live chat header as returned by the Halo PSA API. The structure of each object corresponds directly to the API response for live chat headers, typically including metadata such as chat IDs, timestamps, status, participants, and related ticket or conversation references.

If binary data were involved, it would be summarized here, but this operation deals only with JSON data.

Dependencies

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

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credentials are properly configured in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Live Chat Header" and the operation is "List Of Live Chat Header".
  • Invalid query parameters: Double-check the input properties for correct types and valid values, especially pagination and ordering fields.
  • API request failures: Network issues, incorrect credentials, or API limits may cause errors. Review error messages and confirm API access.
  • If continueOnFail is enabled, errors will be returned in the output JSON under an error property instead of stopping execution.

Links and References

Discussion