Description
Overview
This workflow provides a reliable automation workflow for daily backup of n8n workflows to a GitHub repository. It is designed for system administrators and DevOps engineers who need an orchestration pipeline to securely synchronize local n8n workflow configurations with version-controlled JSON files in GitHub. The process is triggered by a scheduled cron event at 23:59 daily, ensuring consistent and up-to-date backups.
Key Benefits
- Automates daily backup of all n8n workflows to GitHub repository with no manual intervention.
- Performs differential checks using merge operations to detect new or updated workflows only.
- Ensures backup files are named dynamically based on workflow names for clear identification.
- Uses authenticated API requests to securely retrieve workflow data and GitHub file contents.
- Employs commit messages with timestamps for traceability in the orchestration pipeline.
Product Overview
This automation workflow is triggered by a cron node set to execute daily at 23:59. Upon activation, it sends a basic-authenticated HTTP GET request to the local n8n instance API endpoint to retrieve a list of all configured workflows. Each workflow’s metadata is split into individual items using a function node for granular processing. Detailed workflow JSON data is then fetched for each item through authenticated HTTP requests.
The workflow concurrently retrieves existing backup files from the configured GitHub repository via authenticated GitHub API nodes. The retrieved GitHub files are transformed into individual items and their raw JSON contents downloaded for comparison. Two merge nodes operate in “removeKeyMatches” mode: one to isolate workflows absent in GitHub (for creation), the other to detect workflows with updated data (for editing).
New workflows are backed up by creating JSON files named after the workflow, while updated workflows trigger file edits. Both operations commit changes with descriptive messages including workflow names and current dates. Error handling relies on n8n platform defaults, with no explicit retry or backoff configured. The workflow uses OAuth and header-based authentication credentials to secure API interactions, processing data transiently without persistent storage outside GitHub.
Features and Outcomes
Core Automation
This automation workflow ingests the complete list of n8n workflows as JSON objects, applying deterministic comparison logic via merge nodes to identify new or changed workflows within the orchestration pipeline. It selectively branches to create or update corresponding backup files in GitHub.
- Single-pass evaluation of workflow metadata for efficient differential detection.
- Deterministic branching to separate creation and update workflows based on data differences.
- Execution synchronized with daily scheduled triggers for consistent backup intervals.
Integrations and Intake
The workflow integrates with the local n8n REST API using basic authentication for workflow retrieval and with the GitHub API using OAuth and header authentication methods. It expects JSON-formatted workflow definitions and GitHub file metadata as input payloads within the no-code integration environment.
- n8n REST API for obtaining workflow lists and detailed JSON definitions.
- GitHub API for retrieving repository file lists and raw JSON content.
- Authentication handled via configured credentials for secure API access.
Outputs and Consumption
Outputs consist of JSON files created or updated in the GitHub repository, each named after the respective workflow. The workflow operates asynchronously, committing changes to GitHub with descriptive messages. The backup files contain full workflow JSON definitions, facilitating deterministic restoration or version tracking.
- GitHub repository JSON files representing individual n8n workflows.
- Commit messages include workflow names and current dates for traceability.
- Output files structured as stringified JSON matching original workflow data.
Workflow — End-to-End Execution
Step 1: Trigger
The workflow initiates automatically every day at 23:59 via a cron node, ensuring scheduled and consistent execution without manual intervention.
Step 2: Processing
After trigger activation, an HTTP Request node retrieves all workflows from the local n8n instance using basic authentication. A function node then splits the resulting array into individual workflow items for detailed processing. Basic presence checks ensure the workflow data is available for subsequent steps.
Step 3: Analysis
For each workflow, a detailed JSON definition is fetched via authenticated HTTP requests. The workflow data is then compared with existing GitHub backup files using merge nodes operating in “removeKeyMatches” mode. One merge node identifies workflows absent in GitHub (for creation), while another detects workflows with updated timestamps (for editing), ensuring only necessary changes are propagated.
Step 4: Delivery
The workflow commits new or updated JSON backup files to the GitHub repository using authenticated GitHub nodes. File creation or editing includes commit messages specifying the workflow name and current date. The delivery is asynchronous, with no immediate synchronous response expected beyond successful commit confirmation.
Use Cases
Scenario 1
An administrator needs to ensure daily backups of all n8n workflows to prevent data loss. This automation workflow retrieves all workflows, compares them with existing GitHub backups, and updates or creates JSON files accordingly, delivering a deterministic backup cycle without manual oversight.
Scenario 2
A DevOps team requires version-controlled access to n8n workflow changes. The workflow’s GitHub integration creates timestamped commits of workflow JSON files, enabling historical tracking and rollback capabilities through the repository’s native version control system.
Scenario 3
Operations engineers want to verify daily synchronization between local workflows and remote backups. The merge nodes detect discrepancies based on workflow names and update timestamps, ensuring only changed workflows trigger repository updates and reducing redundant data transfers.
How to use
Import the workflow into your n8n environment and configure required credentials: basic authentication for the local n8n REST API and OAuth or header authentication for GitHub API access. Set your GitHub repository and owner parameters accordingly. Once activated, the workflow will run daily at 23:59, automatically backing up all workflows as JSON files in your specified GitHub repository. Monitor execution logs in n8n for operational status and confirm commits within GitHub for validation.
Comparison — Manual Process vs. Automation Workflow
| Attribute | Manual/Alternative | This Workflow |
|---|---|---|
| Steps required | Multiple manual exports, file naming, and commit operations | Single scheduled automation with conditional create/edit logic |
| Consistency | Subject to human error and inconsistent execution times | Deterministic daily execution with automatic differential detection |
| Scalability | Limited by manual effort and error-prone with increasing workflows | Scales automatically with the number of workflows without extra effort |
| Maintenance | High maintenance burden for scheduling and version control | Low maintenance via credential updates and occasional workflow tuning |
Technical Specifications
| Environment | n8n automation platform with access to local REST API and GitHub |
|---|---|
| Tools / APIs | n8n REST API, GitHub API |
| Execution Model | Scheduled asynchronous workflow triggered by cron |
| Input Formats | JSON-formatted workflow metadata and definitions |
| Output Formats | JSON backup files committed to GitHub repository |
| Data Handling | Transient processing without persistence outside GitHub |
| Known Constraints | Relies on availability of local n8n API and GitHub service |
| Credentials | Basic Auth for n8n API; OAuth and header auth for GitHub API |
Implementation Requirements
- Configured basic authentication credentials for local n8n REST API access
- Valid OAuth or header authentication credentials for GitHub API operations
- Network access allowing n8n instance to communicate with GitHub and local API endpoints
Configuration & Validation
- Verify that basic authentication credentials allow successful retrieval of workflows from the local n8n instance.
- Validate GitHub API credentials by fetching repository file lists and committing test files if necessary.
- Confirm that the cron trigger executes at 23:59 and that workflows are properly created or updated in the GitHub repository.
Data Provenance
- Triggered by “Daily at 23:59” cron node initiating the backup cycle.
- Uses “Get workflows” and “Get workflow data” HTTP Request nodes with basic authentication for data intake.
- Employs “Get Files”, “Create file”, and “GitHub Edit” GitHub nodes with OAuth credentials for output delivery.
FAQ
How is the daily backup automation workflow triggered?
The workflow is triggered automatically every day at 23:59 by a cron node, ensuring scheduled and consistent execution.
Which tools or models does the orchestration pipeline use?
The pipeline uses authenticated HTTP requests to the n8n REST API and GitHub API, combined with merge nodes for differential comparison of workflow data.
What does the response look like for client consumption?
The outputs are JSON files stored in a GitHub repository, each file containing the full workflow JSON definition named after the workflow.
Is any data persisted by the workflow?
The workflow processes data transiently within n8n and persists backups only as JSON files committed to the configured GitHub repository.
How are errors handled in this integration flow?
Error handling relies on default n8n platform behavior; no explicit retry or backoff logic is configured within the workflow.
Conclusion
This automation workflow provides a dependable method for daily synchronization of local n8n workflows with a GitHub repository by creating and updating JSON backup files. It delivers deterministic outcomes based on workflow name and update timestamp comparisons, ensuring only necessary changes propagate. The workflow relies on continuous availability of the local n8n REST API and GitHub services, which is a key operational constraint. Its design supports secure, scheduled, and transparent backup management without manual intervention, facilitating version control and disaster recovery preparedness.
Reviews
There are no reviews yet.