Use Docker to install, update, and run n8n quickly. Adjust volumes, environment variables, and ports as needed.

A selection of default shortcuts you can use while editing workflows in n8n:

**Expressions** let you dynamically set or transform values within n8n. Some sample expressions:

Common nodes that ship with n8n:

The AI Agent node (or custom node) integrates Large Language Models or other AI services into your workflow. Possible uses:

• LLM prompt or chat interactions
• Context memory stored in external DB or memory node
• Search results or knowledge base used as context for the AI

Flow example: Webhook → AI Agent → Memory Node → Output

OpenAI, Cohere, or custom endpoints are feasible.

HTTP Request Node: Used to call external REST APIs. You can also import a cURL command to auto‐populate the fields.

After pasting the cURL, click “Parse to HTTP Request” in n8n to automatically fill in method, URL, headers, and body.

Common settings and error handling options in many nodes:

n8n has a built‐in credentials manager that lets you securely store and re‐use your authentication details. Supported credential types include:

• API Key (e.g. Bearer token, Query param)
• OAuth2, including refresh tokens
• Basic Auth / Username & Password

Once configured, you can select these credentials in your nodes. Example:

For more details, see n8n Docs: Credentials.

For complex workflows, n8n provides robust debugging features:

• Error Trigger Node: Automatically catches unhandled errors across workflows
• Execution Logs: Track each run (success or error), see full input/output data
• Pinned Data: Temporarily store data at a node for repeated local testing
• Retry Logic: Built into some nodes or can be orchestrated with loops

Example debugging flow might send error details to Slack or email you logs. Combine this with the “Stop on Error” or “Continue on Error” settings, depending on your needs.

The Execute Workflow node can call another workflow (a “sub‐workflow”) for reusability and modular design.

• Extract common tasks (e.g. CSV to JSON conversion) into a dedicated workflow
• Reference that “utility” workflow from many other main workflows
• Pass data in/out seamlessly between calling workflow and sub‐workflow

Tip: Keep your sub‐workflows small and dedicated to one function, so they’re easy to maintain.

When self‐hosting, ensure your instance is secure:

• HTTPS: Use reverse proxies (e.g. Nginx, Caddy) or direct SSL for all traffic
• Basic Auth: Enable N8N_BASIC_AUTH_ACTIVE=true plus username/password variables
• Encryption Key: Always set N8N_ENCRYPTION_KEY for your environment
• Restrict IP ranges or firewall inbound traffic for Webhook endpoints
• Avoid exposing your n8n container directly to the internet without a proxy

The n8n community is active and growing. Check out:

• Official Docs: docs.n8n.io
• Community Forum: community.n8n.io
• Discord Chat: discord.gg/n8n
• GitHub (Issues, PRs, source code): n8n-io/n8n

Community contributed nodes and examples can often be found on GitHub or in the forum. Keep an eye on the n8n blog for release notes and new features.

Here are three example workflows using key n8n core nodes. These diagrams are generated via Mermaid.js. Make sure to avoid HTML tags in your labels to prevent syntax errors.

1) Schedule → Function → HTTP Request

Runs on a time‐based trigger, modifies data in a Function node, and sends it via HTTP Request.

2) Webhook → Filter → Merge → Send Email

A webhook receives incoming data, then a Filter node checks conditions. If it passes, data merges and eventually is sent via Email.

3) Multiple Branches & Merge

Splits data into batches, processes each with different HTTP calls, merges them, and applies a Function node for final transformation.

Below are some useful hints and tips to help you master n8n:

• Use Expression Mode
  • Activate by clicking the "=" icon in node parameters.
  • Leverage built-in variables like $json, $node, $env, and others.
• Modular Workflows
  • Break complex workflows into reusable sub-workflows using the Execute Workflow node.
  • This makes maintenance and scaling easier.
• Debugging Techniques
  • Review the execution logs to identify and correct errors.
  • Pin node data to capture transient issues for troubleshooting.
  • Enable detailed logging by configuring your environment variables.
• Credential Management
  • Store API keys, OAuth2 tokens, and other secrets in the n8n credentials manager.
  • Use environment variables to secure sensitive information.
• Performance Optimization
  • Use the SplitInBatches node for processing large data sets.
  • Implement error handling and retries to prevent workflow disruptions.
• Community Resources
  • Join the n8n Community Forum and Discord for troubleshooting and best practices.
  • Check out the official n8n documentation for regular updates.

This section explains how data is transformed within an n8n workflow using core nodes. In many workflows, raw data is received from an external source, transformed, filtered, and merged before being delivered to the final destination.

• Function Node: Execute custom JavaScript code to manipulate data.
• Set Node: Define or modify data fields directly.
• Filter Node: Check conditions and only allow data that meets the criteria.
• Merge Node: Combine data from different sources or branches.

The following Mermaid diagram illustrates a workflow that demonstrates a data transformation process:

In this workflow:
A receives the data. B preps the data structure. C applies custom transformations; for example, converting date formats or computing new fields. D then filters the data based on your conditions. If the data passes, it is merged and sent to F; otherwise, the flow is stopped at G.

This workflow demonstrates a common pattern in n8n where data is first retrieved from a database, then processed with a replace function, and finally looped for further processing.

• Database Lookup: Uses a database node (e.g. MySQL, PostgreSQL) to fetch related data.
• Replace Function: A Function node is used to search through the data and replace parts of it—for instance, replacing tokenized strings with real values.
• Looping: The SplitInBatches node is applied to process multiple records iteratively.

The following Mermaid diagram illustrates this workflow:

Workflow Explanation:
A initiates the workflow (e.g., via a webhook or schedule). Then, B performs a lookup in your database for related data. The retrieved data is passed to a Function Node (C) where a replace operation occurs (e.g., using regular expressions or simple string replacements). The result is split into individual records by the SplitInBatches Node (D), allowing you to process each record in a loop. Finally, each record is further transformed or enriched at E, and the output is sent to the final destination at F.

This section explains how n8n triggers work and how workflows respond to HTTP requests using webhooks. n8n supports several trigger types including manual, scheduled, and webhook triggers.

• Webhook Trigger: Initiates a workflow when an HTTP request is received. It can handle various HTTP methods such as GET, POST, etc.
• Response Handling: Once the workflow processes the request, you can send back a custom HTTP response (e.g., 200 OK, 400 Bad Request) with custom headers and a message.
• Authentication & Security: Webhook triggers can be secured using secret tokens, IP whitelisting, or Basic Auth to ensure that only authorized requests trigger the workflow.
• Debugging Tip: Use the Execution Logs and Pin Node Data to troubleshoot webhook responses and data processing.

The following Mermaid diagram illustrates a typical webhook workflow where a webhook triggers the workflow, a Function node validates the incoming payload, and an HTTP Response is returned based on the validation result.

In this example, when the Webhook Trigger receives data, the Function Node checks the payload. Depending on whether the data is valid or not, the workflow returns a 200 OK or 400 Bad Request response.

The following software components can help build a robust environment around n8n. They manage server processes, provide reverse proxy services, secure connections, and enhance development, multimedia, and security capabilities.

Use this guide to plan and gauge your deployment environments. The table below outlines recommended server specifications for different stages: Prototype, Test, and Production.