Skip to content

n8n Docs

Initializing search

Using n8n
Integrations
Hosting n8n
Code in n8n
Advanced AI
API

n8n home ↗
Forum ↗
Tutorials (blog) ↗

n8n Docs

Using n8n
Using n8n
- Getting started
  Getting started
  - Learning path
  - Choose your n8n
  - Quickstarts
    
    Quickstarts
    
    A very quick quickstart
    
    A longer introduction
- Using the app
  Using the app
  - Understand workflows
    
    Understand workflows
    
    Create and run
    
    Save and publish
    
    Components
    
    Components
    
    Nodes
    
    Connections
    
    Sticky Notes
    
    Executions
    
    Executions
    
    Manual, partial, and production executions
    
    Dirty nodes
    
    Workflow-level executions
    
    All executions
    
    Custom executions data
    
    Debug executions
    
    Redact execution data
    
    Tags
    
    Export and import
    
    Templates
    
    Sharing
    
    Settings
    
    Streaming responses
    
    Workflow history
    
    Workflow ID
    
    Sub-workflow conversion
  - Manage credentials
    
    Manage credentials
    
    Create and edit
    
    Credential sharing
  - Manage users and access
    
    Manage users and access
    
    Cloud setup
    
    Manage users
    
    Account types
    
    Role-based access control
    
    Role-based access control
    
    Role types
    
    Projects
    
    Custom roles
    
    Best practices
    
    2FA
    
    LDAP
    
    OIDC
    
    OIDC
    
    Set up OIDC
    
    Troubleshooting
    
    SAML
    
    SAML
    
    Set up SAML
    
    Okta Workforce Identity SAML setup
    
    Azure AD SAML setup
    
    Manage users with SAML
    
    Troubleshooting
  - Keyboard shortcuts
- Key concepts
  Key concepts
  - Flow logic
    
    Flow logic
    
    Splitting with conditionals
    
    Merging data
    
    Looping
    
    Waiting
    
    Sub-workflows
    
    Error handling
    
    Execution order in multi-branch workflows
  - Working with data
    
    Working with data
    
    How n8n structures data
    
    Expressions versus data nodes
    
    Referencing data
    
    Referencing data
    
    Referencing data in the UI
    
    Referencing previous nodes
    
    Linking data items
    
    Linking data items
    
    How items link through workflows
    
    Accessing linked items in the Code node
    
    Preserving linking in the Code node
    
    Item linking errors
    
    Item linking for node creators
    
    Transforming data
    Transforming data
    
    Approaches for transforming data
    
    Expressions for data transformation
    
    Expression reference
    
    Expression reference
    
    Array
    
    BinaryFile
    
    Boolean
    
    CustomData
    
    Date
    
    DateTime
    
    ExecData
    
    HTTPResponse
    
    Item
    
    NodeInputData
    
    NodeOutputData
    
    Number
    
    Object
    
    PrevNodeData
    
    Root
    
    String
    
    WorkflowData
    
    Filtering data
    
    Pinning and mocking data
    
    Specific data types
    Specific data types
    
    Binary data
    
    Date and time with Luxon
    
    Query JSON with JMESPath
    
    Data tables
  - Glossary
- n8n Cloud
  n8n Cloud
- Enterprise features
  Enterprise features
  - Source control and environments
    
    Source control and environments
    
    Understand
    
    Understand
    
    Environments
    
    Git in n8n
    
    Branch patterns
    
    Set up
    
    Using
    
    Using
    
    Push and pull
    
    Compare workflow changes
    
    Copy work between environments
    
    Tutorial: Create environments with source control
  - External secrets
  - Log streaming
  - Security settings
  - Insights
  - License key
- Releases
  Releases
  - Release notes
    Release notes
    
    2.x
    
    1.x
    
    0.x
  - v2.0 breaking changes
  - v2.0 Migration tool
  - v1.0 migration guide
- Help and community
  Help and community
  - Where to get help
  - Contributing
- Licenses and privacy
  Licenses and privacy
  - Privacy and security
    
    Privacy and security
    
    Privacy
    
    Security
    
    Incident response
    
    What you can do
  - Sustainable use license
Integrations
Integrations
- Built-in nodes
  Built-in nodes
- Community nodes
  Community nodes
  - Installation and management
    
    Installation and management
    
    Install verified community nodes
    
    GUI installation
    
    Manual installation
    
    Environment variable installation
  - Risks
  - Blocklist
  - Using community nodes
  - Troubleshooting
  - Building community nodes
- Creating nodes
  Creating nodes
  - Overview
  - Plan your node
    
    Plan your node
    
    Choose a node type
    
    Choose a node building style
    
    Node UI design
    
    Choose node file structure
  - Build your node
    
    Build your node
    
    Set up your development environment
    
    Using the n8n-node tool
    
    Tutorial: Build a declarative-style node
    
    Tutorial: Build a programmatic-style node
    
    Reference
    
    Reference
    
    Node UI elements
    
    Code standards
    
    Error handling
    
    Versioning
    
    Choose node file structure
    
    Base files
    
    Base files
    
    Structure
    
    Standard parameters
    
    Declarative-style parameters
    
    Programmatic-style parameters
    
    Programmatic-style execute method
    
    Codex files
    
    Credentials files
    
    HTTP request helpers
    
    Item linking
    
    UX guidelines
    
    Verification guidelines
  - Test your node
    
    Test your node
    
    Run your node locally
    
    Node linter
    
    Troubleshooting
  - Deploy your node
    
    Deploy your node
    
    Submit community nodes
    
    Install private nodes
Hosting n8n
Hosting n8n
- Community vs Enterprise
- Installation
  Installation
  - npm
  - Docker
  - Server setups
    
    Server setups
    
    Digital Ocean
    
    Heroku
    
    Hetzner
    
    Amazon Web Services
    
    Azure
    
    Google Cloud Run
    
    Google Kubernetes Engine
    
    OpenShift CRC
    
    Docker Compose
  - Updating
- Configuration
  Configuration
- Logging and monitoring
  Logging and monitoring
- Scaling and performance
  Scaling and performance
- Securing n8n
  Securing n8n
- Starter Kits
  Starter Kits
  - AI Starter Kit
- OEM deployment
  OEM deployment
- Architecture
  Architecture
  - Overview
  - Database structure
- Using the CLI
  Using the CLI
  - CLI commands
Code in n8n
Code in n8n
- Using the Code node
- AI coding
- Built in methods and variables
  Built in methods and variables
- Custom variables
  Custom variables
  - Create custom variables
- Cookbook
  Cookbook
  - Built-in methods and variables examples
    
    Built-in methods and variables examples
    
    execution
    
    getWorkflowStaticData
    
    (node-name).all
    
    vars
  - Code node
    
    Code node
    
    Get number of items returned by last node
    
    Get the binary data buffer
    
    Output to the browser console
  - HTTP Request node
    
    HTTP Request node
    
    Pagination
Advanced AI
Advanced AI
- AI Workflow Builder
- Chat Hub
- Instance-level MCP server
  Instance-level MCP server
  - Set up and use n8n MCP server
  - MCP server tools reference
- Tutorial: Build an AI workflow in n8n
- RAG in n8n
- LangChain in n8n
  LangChain in n8n
- Evaluations
  Evaluations
- Examples and concepts
  Examples and concepts
API
API

Hosting n8n
Configuration
Configuration examples

Configuration examples#

This section contains examples for how to configure n8n to solve particular use cases.

This page was

Thanks for your feedback!

Configuration methods

Made with Material for MkDocs