Skip to content

n8n Docs

Using n8n
Integrations
Hosting n8n
Code in n8n
Advanced AI
API
Embed

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
  - Video courses
  - Text courses
    
    Text courses
    
    Level one
    
    Level one
    
    Navigating the editor UI
    
    Building a mini-workflow
    
    Automating a (real-world) use case
    
    Designing the workflow
    
    Building the workflow
    Building the workflow
    
    Getting data from the data warehouse
    
    Inserting data into airtable
    
    Filtering orders
    
    Setting values for processing orders
    
    Calculating booked orders
    
    Notifying the team
    
    Scheduling the workflow
    
    Activating and examining the workflow
    
    Exporting and importing workflows
    
    Test your knowledge
    
    Level two
    
    Level two
    
    Understanding the data structure
    
    Processing different data types
    
    Merging and splitting data
    
    Dealing with errors in workflows
    
    Automating a business workflow
    Automating a business workflow
    
    Use case
    
    Workflow 1
    
    Workflow 2
    
    Workflow 3
    
    Test your knowledge
- Using the app
  Using the app
  - Understand workflows
    
    Understand workflows
    
    Create and run
    
    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
    
    Tags
    
    Export and import
    
    Templates
    
    Sharing
    
    Settings
    
    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
    
    Best practices
    
    2FA
    
    LDAP
    
    SAML
    
    SAML
    
    Set up SAML
    
    Okta Workforce Identity SAML setup
    
    Troubleshooting
    
    Manage users with SAML
  - 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
  - Data
    
    Data
    
    Data structure
    
    Data flow within nodes
    
    Transforming data
    
    Process data using code
    
    Data mapping
    
    Data mapping
    
    Data mapping in the UI
    
    Data mapping in the expressions editor
    
    Data item linking
    
    Data item linking
    
    Item linking concepts
    
    Item linking in the Code node
    
    Item linking errors
    
    Item linking for node creators
    
    Data pinning
    
    Data editing
    
    Data filtering
    
    Data mocking
    
    Binary data
    
    Schema preview
  - 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
    
    Copy work between environments
    
    Tutorial: Create environments with source control
  - External secrets
  - Log streaming
  - Insights
  - License key
- Releases
  Releases
  - Release notes
    Release notes
    
    1.x
    
    0.x
  - 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
  - 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
    
    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
    
    Docker Compose
  - Updating
- Configuration
  Configuration
  - Environment variables
    
    Environment variables
    
    Binary data
    
    Credentials
    
    Database
    
    Deployment
    
    Endpoints
    
    Executions
    
    External data storage
    
    External hooks
    
    External secrets
    
    Insights
    
    Logs
    
    License
    
    Nodes
    
    Queue mode
    
    Security
    
    Source control
    
    Task runners
    
    Timezone and localization
    
    User management and 2FA
    
    Workflows
  - Configuration methods
  - Configuration examples
    
    Configuration examples
    
    Isolate n8n
    
    Configure the Base URL
    
    Configure custom SSL certificate authorities
    
    Set a custom encryption key
    
    Configure workflow timeouts
    
    Specify custom nodes location
    
    Enable modules in Code node
    
    Set the timezone
    
    Specify user folder path
    
    Configure webhook URLs with reverse proxy
    
    Enable Prometheus metrics
  - Supported databases and settings
  - Task runners
  - User management
- Logging and monitoring
  Logging and monitoring
- Scaling and performance
  Scaling and performance
- Securing n8n
  Securing n8n
- Starter Kits
  Starter Kits
  - AI Starter Kit
- Architecture
  Architecture
  - Overview
  - Database structure
- Using the CLI
  Using the CLI
  - CLI commands
Code in n8n
Code in n8n
- Expressions
- Using the Code node
- AI coding
- Built in methods and variables
  Built in methods and variables
  - Overview
  - Current node input
  - Output of other nodes
  - Date and time
  - JMESPath
  - HTTP node
  - LangChain Code node
  - n8n metadata
  - Convenience methods
  - Data transformation functions
    
    Data transformation functions
    
    Arrays
    
    Booleans
    
    Dates
    
    Numbers
    
    Objects
    
    Strings
- Custom variables
  Custom variables
  - Create custom variables
- Cookbook
  Cookbook
  - Handling dates
  - Query JSON with JMESPath
  - Built-in methods and variables examples
    
    Built-in methods and variables examples
    
    execution
    
    getWorkflowStaticData
    
    Retrieve linked items from earlier in the workflow
    
    (node-name).all
    
    vars
  - Expressions
    
    Expressions
    
    Check incoming data
    
    Common issues
  - 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
- 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
Embed
Embed

Integrations
Built-in nodes
Actions

Actions library#

This section provides information about n8n's Actions.

This page was

Thanks for your feedback!

We read all feedback personally

Made with Material for MkDocs Insiders