Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Email Rule → List Of Email Rule

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Email Rule resource and the List Of Email Rule operation, it retrieves a list of email rules from the Halo PSA system. This can be useful in scenarios where you want to automate workflows based on email filtering or routing rules defined in Halo PSA.

For example, you might use this node to:

  • Fetch all email rules that apply to certain sender addresses.
  • Filter email rules by type to process or audit them automatically.
  • Integrate email rule data into other systems or dashboards.

Properties

Name Meaning
Fromaddress Filters the list of email rules by the sender's email address (fromaddress query param).
Type Filters the list of email rules by their type (type query param).

Both properties are optional filters sent as query parameters to the API when listing email rules.

Output

The node outputs an array of JSON objects representing the email rules retrieved from the Halo PSA API. Each item corresponds to one email rule and contains all fields returned by the API for that rule.

The output structure is:

[
  {
    "id": "...",
    "name": "...",
    "fromaddress": "...",
    "type": "...",
    ...
  },
  ...
]

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate API requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n core modules.

Troubleshooting

  • No credentials returned!: Ensure that the required API authentication credentials are properly configured in n8n before running the node.
  • Resource or Operation not found: Verify that the selected resource is "Email Rule" and the operation is "List Of Email Rule".
  • API request errors: Network issues, invalid credentials, or incorrect filter values may cause API errors. Check the error message returned in the node output for details.
  • If continueOnFail is enabled, errors will be included in the output JSON under an error field instead of stopping execution.

Links and References

Discussion