FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions45

Overview

The "Trigger Rule" operation in the Rules & Groups API resource allows users to manually trigger a specific rule within FireFly III based on given parameters such as date ranges and account filters. This operation is useful for testing or applying rules retroactively to transactions that match certain criteria.

Common scenarios include:

  • Reapplying a rule to past transactions within a specified date range.
  • Triggering automated categorization or tagging rules on selected accounts.
  • Debugging or verifying rule behavior by forcing execution outside of normal triggers.

For example, a user might want to trigger a rule that categorizes all transactions from the last month for specific accounts to ensure their budgeting reports are up to date.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing (e.g., 123e4567-e89b-12d3-a456-426614174000).
Rule/Group ID The ID of the rule or group to operate on. This identifies which rule will be triggered.
Date Range Filters Filters specifying the start and end dates (YYYY-MM-DD) for transactions to consider when triggering the rule. Both start and end dates can be set; start defaults to 30 days ago if not provided.
Account IDs Comma-separated list of account IDs to limit the scope of the rule trigger to specific accounts.

Output

The node outputs a JSON object representing the response from the FireFly III API after triggering the rule. This typically includes details about the triggered rule execution, such as how many transactions were affected or any messages returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the FireFly III API with appropriate authentication credentials (such as an OAuth2 token).
  • The node expects the FireFly III instance URL and credentials to be configured in n8n.
  • The user must have permission to trigger rules via the FireFly III API.

Troubleshooting

  • Missing or invalid Rule/Group ID: The operation requires a valid rule or group ID. Ensure the ID is correct and exists in your FireFly III instance.
  • Date format errors: Dates must be in YYYY-MM-DD format. Invalid formats may cause API errors.
  • Account IDs filtering issues: If account IDs are provided, they must be valid and accessible by the authenticated user.
  • API authentication failures: Verify that the API credentials are correctly configured and have sufficient permissions.
  • Empty or unexpected API responses: Check the FireFly III server logs or enable debug logging using the X-Trace-ID to trace requests.

Links and References

Discussion