FireFly III icon

FireFly III

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

Actions45

Overview

This node integrates with the FireFly III API, specifically focusing on the "About API" resource's "Cron Jobs Endpoint" operation. It allows users to trigger FireFly III's internal cron jobs programmatically via the API. This is useful for automating maintenance tasks or scheduled operations within FireFly III without manual intervention.

Typical use cases include:

  • Running scheduled background jobs remotely.
  • Forcing a cron job to run on demand, e.g., for testing or immediate processing.
  • Simulating cron job execution as if it were running on a different date, useful for backdated processing or debugging.

Example: A user can configure this node to run FireFly III's cron jobs daily at a specific time through an automation workflow, ensuring that all periodic tasks are executed timely.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing. Example format: 123e4567-e89b-12d3-a456-426614174000
CLI Token The CLI token of any user in FireFly III, required to authenticate and run the cron job. This is a sensitive password-type field.
Additional Options Collection of optional parameters:
• Date: A string formatted as YYYY-MM-DD to make the cron job pretend it's running on another day.
• Force: Boolean flag to force the cron job to fire regardless of previous runs. Use with caution as it may cause duplicate transactions or inconsistent budgets.

Output

The node outputs a JSON object containing the response from the FireFly III API after triggering the cron job. The exact structure depends on the API's response but generally includes status information about the cron job execution.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a FireFly III instance with API access.
  • Needs a valid CLI token credential from a FireFly III user to authorize the cron job execution.
  • The node uses HTTP GET requests to the /cron/{cliToken} endpoint with optional query parameters.
  • No additional environment variables or external services are required beyond the FireFly III API and authentication token.

Troubleshooting

  • Invalid or missing CLI Token: The node requires a valid CLI token. If omitted or incorrect, the API will reject the request. Ensure the token is correct and has sufficient permissions.
  • Incorrect Date Format: The optional "Date" parameter must be in YYYY-MM-DD format. Providing an invalid date format may cause the API to return an error.
  • Force Flag Side Effects: Using the "Force" option can cause duplicate transactions or inconsistent budget states. Use only when you understand the implications.
  • Network or API Errors: Standard HTTP errors (e.g., 401 Unauthorized, 404 Not Found) may occur if the FireFly III instance is unreachable or the endpoint is incorrect.
  • X-Trace-ID Usage: While optional, providing a unique X-Trace-ID helps trace and debug requests in FireFly III logs.

Links and References

Discussion