Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Actions → List Of Actions

AI-generated

Overview

This node integrates with the Halo PSA API to list actions based on various filtering criteria. It is designed to retrieve detailed information about actions performed within the Halo PSA system, such as ticket updates, agent activities, billing-related actions, and more.

Common scenarios where this node is beneficial include:

  • Monitoring recent or specific types of actions taken on tickets.
  • Extracting agent activity logs for reporting or auditing.
  • Filtering actions by date ranges, importance, or visibility.
  • Including additional details like attachments, HTML content, or social media fields in the response.

For example, a user might use this node to fetch all important public actions related to a specific ticket that occurred within a certain date range, including any attachments and agent details.

Properties

Name Meaning
Actoutcome Filter on the name of the action (string).
Actoutcomenum Filter on the system field ID (integer).
Agentonly Only get actions done by Agents (boolean).
Conversationonly Only get actions relating to the Agent to End User conversation (boolean).
Count Number of actions to return in the response (integer).
Datesearch Search parameter related to dates (string).
Enddate Actions that occurred before this date (string).
Excludebilling Excludes any actions associated with billing (e.g., Send Invoice by Email) (boolean).
Excludehiddenfrominternalit Excludes actions marked to be hidden from Agents with Client Group set (boolean).
Excludeprivate Only get public actions (boolean).
Excludesys Exclude system actions (boolean).
Importantonly Only get important actions (boolean).
Importanttop Orders the response by important actions first (boolean).
Includeagentdetails Include agent details in the response (boolean).
Includeattachments Include attachment details in the response (boolean).
Includefacebookfields Include Facebook fields in the response (boolean).
Includehtmlemail Include the action email HTML as part of the response (boolean).
Includehtmlnote Include the action note HTML as part of the response (boolean).
Includenonactionattachments Include non-action attachments in the response (boolean).
Includetranslations Includes the translation count in the response (boolean).
Includetwitterfields Include Twitter fields in the response (boolean).
Intraticketonly Get actions that are part of the ticket only (boolean).
Ischildnotes Only get actions from child tickets (boolean).
Isrelatednotes Only get actions from related tickets (boolean).
Slaonly Only get SLA hold and release actions (boolean).
Startdate Actions that occurred after this date (string).
Supplieronly Only get actions relating to Suppliers (boolean).
Ticket Id The ID of the Ticket to get actions for (integer).
Timeentriesonly Filter related to time entries (boolean).

Output

The node outputs an array of JSON objects representing the actions retrieved from the Halo PSA API. Each object contains detailed information about an action, which may include:

  • Action metadata such as IDs, timestamps, and types.
  • Agent details if requested.
  • Attachments and non-action attachments if included.
  • HTML content for emails and notes if requested.
  • Social media fields like Facebook and Twitter if included.
  • Translation counts if requested.

If binary data is involved (not typical for this operation), it would represent file attachments related to actions.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs proper 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 correctly configured and available in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Actions" and the operation is "List Of Actions".
  • Invalid parameter values: Check that date strings are properly formatted and integer fields receive valid numbers.
  • API request failures: Network issues or incorrect API credentials can cause errors; verify connectivity and credentials.
  • If continueOnFail is enabled, errors will be returned in the output JSON under an error property instead of stopping execution.

Links and References

Discussion