Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Email Rule → Get One Email Rule

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a specific email rule. The "Get One Email Rule" operation fetches data for a single email rule identified by its unique ID. This is useful in scenarios where you need to inspect or process the configuration of an individual email rule within your Halo PSA system, such as automating workflows based on email filtering criteria or auditing email handling rules.

Practical examples include:

  • Automatically retrieving and logging details of a particular email rule before applying changes.
  • Using the email rule's properties to conditionally route emails or trigger other automation steps.
  • Integrating Halo PSA email rules into broader IT service management workflows.

Properties

Name Meaning
Id The unique identifier (number) of the email rule to retrieve.
Includedetails Optional flag/query parameter to specify whether to include detailed information in the response.

Output

The node outputs a JSON object representing the retrieved email rule. This includes all standard fields returned by the Halo PSA API for that email rule, potentially including metadata, conditions, actions, and other configuration details depending on the Includedetails parameter.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "Example Email Rule",
  "conditions": [...],
  "actions": [...],
  "enabled": true,
  ...
}

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 HTTP headers.
  • No additional external dependencies beyond the Halo PSA API and n8n core functionality.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent email rule ID will result in an error from the API.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "No credentials returned!": Indicates that the required API credentials were not provided or could not be loaded. Ensure credentials are configured correctly in n8n.
    • "Resource Email Rule not found" or "Operation Get One Email Rule not found for resource Email Rule": Internal validation errors indicating misconfiguration; verify that the resource and operation names are correct.
    • API error responses will be passed through; check the message for details such as "Not Found" or "Unauthorized".

  • Resolution tips:

    • Double-check the email rule ID exists in your Halo PSA instance.
    • Verify API credentials and permissions.
    • Enable "Continue On Fail" if you want the workflow to proceed despite individual request errors.

Links and References

Discussion