logo
n8n Documentation
Initializing search
    • Using n8n
    • Integrations
    • Hosting n8n
    • API
    • Embed
    • Courses
    • Contributing
    • Using n8n
      • Try it out
        • A very quick quickstart
        • A longer introduction
      • Choose your n8n
        • Set up Cloud
        • Install Desktop
        • Faircode license
      • Understand workflows
        • Create and run
        • Components
          • Nodes
          • Connections
          • Sticky Notes
        • Executions
        • Tags
        • Export and import
        • Templates
        • Sharing
        • Settings
        • Workflow ID
      • Manage credentials
        • Create and edit
        • Credential sharing
      • Flow logic
        • Merging
        • Looping
        • Error handling
          • Error workflows
          • Memory-related errors
      • Data
        • Data structure
        • Transforming data
        • Process data using code
        • Data mapping
          • Data mapping in the UI
          • Data item linking
            • Item linking concepts
            • Item linking in the Code node
            • Item linking errors
            • Item linking for node creators
        • Data pinning
        • Data editing
      • Code in n8n
        • Built in methods and variables reference
        • Built-in methods and variables examples
          • evaluateExpression
          • execution
          • getWorkflowStaticData
          • (node-name).item
          • (node-name).all
          • runIndex
          • workflow
        • Expressions
          • Understand expressions
          • Date and time with Luxon
          • JSON with JMESPath
          • Check incoming data
          • Data transformation functions
            • Arrays
            • Dates
            • Numbers
            • Objects
            • Strings
        • JavaScript
          • Code node
          • Date and time with Luxon
          • JSON with JMESPath
          • Get number of items returned by last node
          • Split binary file data into individual items
          • Get the binary data buffer
          • Using console.log
      • User management
        • Cloud setup
        • Manage users
        • Account types
        • Skip or disable
        • Best practices
        • LDAP
      • Log streaming
      • Privacy and security
        • Privacy
        • Security
        • Incident response
        • What you can do
      • Release notes
      • Keyboard shortcuts
    • Integrations
      • Built-in nodes
        • Core nodes
          • Activation trigger
          • Code
          • Compare Datasets
          • Compression
          • Crypto
          • Date & Time
          • Edit Image
          • Email trigger (IMAP)
          • Error trigger
          • Execute Command
          • Execute Workflow
          • Execute Workflow trigger
          • FTP
          • Git
          • GraphQL
          • HTML
          • HTTP Request
          • iCalendar
          • None
          • Interval
          • Item Lists
          • Local File trigger
          • Manual trigger
          • Markdown
          • Merge
          • Move Binary Data
          • n8n
          • n8n trigger
          • No Operation, do nothing
          • Read Binary Files
          • Read PDF
          • Rename Keys
          • Respond to Webhook
          • RSS Read
          • Schedule trigger
          • Send Email
          • Set
          • Split In Batches
          • Spreadsheet File
          • SSE trigger
          • SSH
          • Start
          • Stop And Error
          • Switch
          • Wait
          • Webhook
          • Workflow trigger
          • Write Binary File
          • XML
        • App nodes
          • Action Network
          • ActiveCampaign
          • Adalo
          • Affinity
          • Agile CRM
          • Airtable
          • AMQP Sender
          • APITemplate.io
          • Asana
          • Automizy
          • Autopilot
          • AWS Certificate Manager
          • AWS Comprehend
          • AWS DynamoDB
          • AWS Elastic Load Balancing
          • AWS Lambda
          • AWS Rekognition
          • AWS S3
          • AWS SES
          • AWS SNS
          • AWS SQS
          • AWS Textract
          • AWS Transcribe
          • BambooHR
          • Bannerbear
          • Baserow
          • Beeminder
          • Bitly
          • Bitwarden
          • Box
          • Brandfetch
          • Bubble
          • Chargebee
          • CircleCI
          • Webex by Cisco
          • Citrix ADC
          • Clearbit
          • ClickUp
          • Clockify
          • Cloudflare
          • Cockpit
          • Coda
          • CoinGecko
          • Contentful
          • ConvertKit
          • Copper
          • Cortex
          • CrateDB
          • Customer.io
          • DeepL
          • Demio
          • DHL
          • Discord
          • Discourse
          • Disqus
          • Drift
          • Dropbox
          • Dropcontact
          • E-goi
          • Elasticsearch
          • Elastic Security
          • Emelia
          • ERPNext
          • Facebook Graph API
          • FileMaker
          • Flow
          • Freshdesk
          • Freshservice
          • Freshworks CRM
          • GetResponse
          • Ghost
          • GitHub
          • GitLab
          • Gmail
          • Google Ads
          • Google Analytics
          • Google BigQuery
          • Google Books
          • Google Calendar
          • Google Chat
          • Google Cloud Firestore
          • Google Cloud Natural Language
          • Google Cloud Realtime Database
          • Google Cloud Storage
          • Google Contacts
          • Google Docs
          • Google Drive
          • Google Perspective
          • Google Sheets
          • Google Slides
          • Google Tasks
          • Google Translate
          • Gotify
          • GoToWebinar
          • Grafana
          • Grist
          • G Suite Admin
          • Hacker News
          • HaloPSA
          • Harvest
          • Help Scout
          • HighLevel
          • Home Assistant
          • HubSpot
          • Humantic AI
          • Hunter
          • Intercom
          • Invoice Ninja
          • Iterable
          • Jenkins
          • Jira
          • Kafka
          • Keap
          • Kitemaker
          • KoBo Toolbox
          • Lemlist
          • Line
          • Linear
          • LingvaNex
          • LinkedIn
          • Magento 2
          • Mailcheck
          • Mailchimp
          • MailerLite
          • Mailgun
          • Mailjet
          • Mandrill
          • Marketstack
          • Matrix
          • Mattermost
          • Mautic
          • Medium
          • MessageBird
          • Metabase
          • Microsoft Dynamics CRM
          • Microsoft Excel
          • Microsoft Graph Security
          • Microsoft OneDrive
          • Microsoft Outlook
          • Microsoft SQL
          • Microsoft Teams
          • Microsoft To Do
          • Mindee
          • MISP
          • Mocean
          • monday.com
          • MongoDB
          • Monica CRM
          • MQTT
          • MSG91
          • MySQL
          • Customer Datastore (n8n Training)
          • Customer Messenger (n8n Training)
          • NASA
          • Netlify
          • Nextcloud
          • NocoDB
          • Notion
          • Odoo
          • One Simple API
          • Onfleet
          • OpenAI
          • OpenThesaurus
          • OpenWeatherMap
          • Orbit
          • Oura
          • Paddle
          • PagerDuty
          • PayPal
          • Peekalink
          • Phantombuster
          • Philips Hue
          • Pipedrive
          • Plivo
          • PostBin
          • Postgres
          • PostHog
          • ProfitWell
          • Pushbullet
          • Pushcut
          • Pushover
          • QuestDB
          • Quick Base
          • QuickBooks
          • QuickChart
          • RabbitMQ
          • Raindrop
          • Reddit
          • Redis
          • Rocket.Chat
          • Rundeck
          • S3
          • Salesforce
          • Salesmate
          • SeaTable
          • SecurityScorecard
          • Segment
          • SendGrid
          • Sendinblue
          • Sendy
          • Sentry.io
          • ServiceNow
          • Shopify
          • SIGNL4
          • Slack
          • sms77
          • Snowflake
          • Splunk
          • Spontit
          • Spotify
          • Stackby
          • Storyblok
          • Strapi
          • Strava
          • Stripe
          • Supabase
          • SyncroMSP
          • Taiga
          • Tapfiliate
          • Telegram
          • TheHive
          • TimescaleDB
          • Todoist
          • Travis CI
          • Trello
          • Twake
          • Twilio
          • Twist
          • Twitter
          • Unleashed Software
          • UpLead
          • uProc
          • UptimeRobot
          • urlscan.io
          • Venafi TLS Protect Cloud
          • Venafi TLS Protect Datacenter
          • Vero
          • Vonage
          • Webflow
          • Wekan
          • WhatsApp Business Platform
          • Wise
          • WooCommerce
          • WordPress
          • Xero
          • Yourls
          • YouTube
          • Zammad
          • Zendesk
          • Zoho CRM
          • Zoom
          • Zulip
        • Trigger nodes
          • ActiveCampaign trigger
          • Acuity Scheduling trigger
          • Affinity trigger
          • Airtable trigger
          • AMQP trigger
          • Asana trigger
          • Autopilot trigger
          • AWS SNS trigger
          • Bitbucket trigger
          • Box trigger
          • Calendly trigger
          • Cal trigger
          • Chargebee trigger
          • Webex by Cisco trigger
          • ClickUp trigger
          • Clockify trigger
          • ConvertKit trigger
          • Copper trigger
          • Customer.io trigger
          • Emelia trigger
          • Eventbrite trigger
          • Facebook trigger
          • Figma trigger (Beta) node - n8n Documentation
          • Flow trigger
          • Form.io trigger
          • Formstack trigger
          • GetResponse trigger
          • GitHub trigger
          • GitLab trigger
          • Gmail trigger
          • Google Calendar trigger
          • Google Drive trigger
          • Google Sheets trigger
          • Gumroad trigger
          • Help Scout trigger
          • HubSpot trigger
          • Invoice Ninja trigger
          • Jira trigger
          • JotForm trigger
          • Kafka trigger
          • Keap trigger
          • KoBo Toolbox trigger
          • Lemlist trigger
          • Linear trigger
          • Mailchimp trigger
          • MailerLite trigger
          • Mailjet trigger
          • Mautic trigger
          • MQTT trigger
          • Netlify trigger
          • Notion trigger
          • Onfleet trigger
          • PayPal trigger
          • Pipedrive trigger
          • Postmark trigger
          • Pushcut trigger
          • RabbitMQ trigger
          • Redis trigger
          • SeaTable trigger
          • Sendinblue trigger
          • Shopify trigger
          • Strava trigger
          • Stripe trigger
          • SurveyMonkey trigger
          • Taiga trigger
          • Telegram trigger
          • The Hive trigger
          • Toggl trigger
          • Trello trigger
          • Typeform trigger
          • Venafi TLS Protect Cloud trigger
          • Webflow trigger
          • Wise trigger
          • WooCommerce trigger
          • Workable trigger
          • Wufoo trigger
          • Zendesk trigger
        • Credentials
          • Action Network credentials
          • ActiveCampaign credentials
          • Acuity Scheduling credentials
          • Adalo credentials
          • Affinity credentials
          • Agile CRM credentials
          • Airtable credentials
          • AMQP credentials
          • APITemplate.io credentials
          • Asana credentials
          • Automizy credentials
          • Autopilot credentials
          • AWS credentials
          • BambooHR credentials
          • Bannerbear credentials
          • Baserow credentials
          • Beeminder credentials
          • Bitbucket credentials
          • Bitly credentials
          • Bitwarden credentials
          • Box credentials
          • Brandfetch credentials
          • Bubble credentials
          • Cal credentials
          • Calendly credentials
          • Chargebee credentials
          • CircleCI credentials
          • Webex by Cisco credentials
          • Citrix ADC credentials
          • Clearbit credentials
          • ClickUp credentials
          • Clockify credentials
          • Cloudflare credentials
          • Cockpit credentials
          • Coda credentials
          • Contentful credentials
          • ConvertKit credentials
          • Copper credentials
          • Cortex
          • CrateDB credentials
          • Customer.io credentials
          • DeepL credentials
          • Demio credentials
          • DHL credentials
          • Discord credentials
          • Discourse credentials
          • Disqus credentials
          • Drift credentials
          • Dropbox credentials
          • Dropcontact credentials
          • E-goi credentials
          • Elasticsearch credentials
          • Elastic Security credentials
          • Emelia credentials
          • ERPNext credentials
          • Eventbrite credentials
          • Facebook App credentials
          • Facebook Graph API credentials
          • Figma credentials
          • FileMaker credentials
          • Flow credentials
          • Form.io Trigger credentials
          • Formstack Trigger credentials
          • Freshdesk credentials
          • Freshservice credentials
          • Freshworks CRM credentials
          • FTP credentials
          • GetResponse credentials
          • Ghost credentials
          • Git credentials
          • GitHub credentials
          • GitLab credentials
          • Google
            • Google OAuth2 single service
            • Google OAuth2 generic
            • Google Service Account
          • Gotify credentials
          • GoToWebinar credentials
          • Grafana credentials
          • Grist credentials
          • Gumroad credentials
          • HaloPSA credentials
          • Harvest credentials
          • Help Scout credentials
          • HighLevel credentials
          • Home Assistant credentials
          • HTTP Request credentials
          • HubSpot credentials
          • Humantic AI credentials
          • Hunter credentials
          • IMAP credentials
          • Intercom credentials
          • Invoice Ninja credentials
          • Iterable credentials
          • Jenkins credentials
          • Jira credentials
          • JotForm credentials
          • Kafka credentials
          • Keap credentials
          • Kitemaker credentials
          • KoBo Toolbox credentials
          • Lemlist credentials
          • Line credentials
          • Linear credentials
          • LingvaNex credentials
          • LinkedIn credentials
          • Magento 2 credentials
          • Mailcheck credentials
          • Mailchimp credentials
          • MailerLite credentials
          • Mailgun credentials
          • Mailjet credentials
          • Mandrill credentials
          • Marketstack credentials
          • Matrix credentials
          • Mattermost credentials
          • Mautic credentials
          • Medium credentials
          • MessageBird credentials
          • Metabase credentials
          • Microsoft credentials
          • Microsoft SQL credentials
          • Mindee credentials
          • MISP credentials
          • Mocean credentials
          • monday.com credentials
          • MongoDB credentials
          • Monica CRM credentials
          • MQTT credentials
          • MSG91 credentials
          • MySQL credentials
          • NASA credentials
          • Netlify credentials
          • Nextcloud credentials
          • NocoDB credentials
          • Notion credentials
          • Odoo credentials credentials
          • One Simple API credentials
          • Onfleet credentials credentials
          • OpenAI credentials
          • OpenWeatherMap credentials
          • Orbit credentials
          • Oura credentials
          • Paddle credentials
          • PagerDuty credentials
          • PayPal credentials
          • Peekalink credentials
          • Phantombuster credentials
          • Philips Hue credentials
          • Pipedrive credentials
          • Plivo credentials
          • Postgres credentials
          • PostHog credentials
          • Postmark credentials
          • ProfitWell credentials
          • Pushbullet credentials
          • Pushcut credentials
          • Pushover credentials
          • QuestDB credentials
          • Quick Base credentials
          • QuickBooks credentials
          • RabbitMQ credentials
          • Raindrop credentials
          • Reddit credentials
          • Redis credentials
          • Rocket.Chat credentials
          • Rundeck credentials
          • S3 credentials
          • Salesforce credentials
          • Salesmate credentials
          • SeaTable credentials
          • SecurityScorecard credentials
          • Segment credentials
          • Send Email credentials
          • SendGrid credentials
          • Sendinblue credentials
          • Sendy credentials
          • Sentry.io credentials
          • ServiceNow credentials
          • Shopify credentials
          • SIGNL4 credentials
          • Slack credentials
          • sms77 credentials
          • Snowflake credentials
          • Splunk credentials
          • Spontit credentials
          • Spotify credentials
          • SSH credentials
          • Stackby credentials
          • Storyblok credentials
          • Strapi credentials
          • Strava credentials
          • Stripe credentials
          • Supabase credentials
          • SurveyMonkey credentials
          • SyncroMSP credentials
          • Taiga credentials
          • Tapfiliate credentials
          • Telegram credentials
          • TheHive credentials
          • TimescaleDB credentials
          • Todoist credentials
          • Toggl credentials
          • Travis CI credentials
          • Trello credentials
          • Twake credentials
          • Twilio credentials
          • Twist credentials
          • Twitter credentials
          • Typeform credentials
          • Unleashed Software credentials
          • UpLead credentials
          • uProc credentials
          • UptimeRobot credentials
          • urlscan.io credentials
          • Venafi TLS Protect Cloud credentials
          • Venafi TLS Protect Datacenter credentials
          • Vero credentials
          • Vonage credentials
          • Webflow credentials
          • Wekan credentials
          • WhatsApp Business credentials
          • Wise credentials
          • WooCommerce credentials
          • WordPress credentials
          • Workable credentials
          • Wufoo credentials
          • Xero credentials
          • Yourls credentials
          • Zammad credentials
          • Zendesk credentials
          • Zoho credentials
          • Zoom credentials
          • Zulip credentials
      • Custom API actions for existing nodes
      • Community nodes
        • Installation and management
        • Risks
        • Blocklist
        • Using community nodes
        • Troubleshooting
        • Building community nodes
      • Creating nodes
        • Plan your node
          • Choose a node building style
          • Node UI design
          • Choose node file structure
        • Build your node
          • Set up your development environment
          • Tutorial: Build a declarative-style node
          • Tutorial: Build a programmatic-style node
          • Reference
            • Node UI elements
            • Code standards
            • Versioning
            • File structure
            • Base files
            • Codex files
            • Credentials files
            • HTTP request helpers
            • Item linking
        • Test your node
          • Run your node locally
          • Node linter
          • Troubleshooting
        • Deploy your node
          • Submit community nodes
          • Install private nodes
    • Hosting n8n
      • Installation
        • npm
        • Docker
        • Server setups
          • Digital Ocean
          • Heroku
          • Hetzner
          • Amazon Web Services
          • Azure
          • Google Cloud
          • Docker Compose
      • Environment variables
        • Configuration methods
        • Environment variables reference
        • Configuration examples
          • Isolating n8n
      • Supported databases and settings
      • Authentication
        • User management
        • Basic auth
        • JWT
      • Security audit
      • Logging
      • Scaling
        • Performance and benchmarking
        • Execution data
        • Execution modes and processes
        • Configuring queue mode
        • Binary data filesystem mode
      • Architecture
        • Database structure
      • CLI commands
    • API
      • Authentication
      • Pagination
      • Using the API playground
      • API reference
    • Embed
      • Prerequisites
      • Deployment
      • Configuration
      • Workflow management
      • Workflows templates
      • White labelling
    • Courses
      • Level one
        • Navigating the editor UI
        • Building a mini-workflow
        • Automating a (real-world) use case
        • Designing 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
        • Understanding the data structure
        • Processing different data types
        • Merging and splitting data
        • Dealing with errors in workflows
          • Use case
          • Workflow 1
          • Workflow 2
          • Workflow 3
        • Test your knowledge
    • Contributing

    Change cookie settings
    Made with Material for MkDocs Insiders

    Cookie consent

    We use cookies and other tracking technologies to improve your browsing experience, to analyze our website traffic, assist our marketing efforts and to understand where our visitors are coming from.
    Privacy policy