logo
n8n Documentation
Initializing search
    • Using n8n
    • Integrations
    • Courses
    • Hosting n8n
    • API
    • Embed
    • Contributing
      • Welcome
        • Overview
        • A very quick quickstart
        • A longer introduction
      • Editor UI
        • Overview
        • Workflows
        • Connections
        • Nodes
        • Items
        • Sticky Notes
        • Overview
        • Merging
        • Looping
        • Error handling
        • Overview
        • Data structure
        • Transforming data
        • Using code
        • Overview
          • Overview
          • Methods
          • Variables
          • Data and time with Luxon
          • JSON with JMESPath
          • Overview
          • Methods
          • Variables
          • Data 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
          • Check incoming data
        • Overview
        • Release notes
        • CLI commands
        • Keyboard shortcuts
        • Glossary
        • License
        • Data collection
      • Overview
        • Overview
        • Activation Trigger
        • Compression
        • Cron
        • Crypto
        • Date & Time
        • Edit Image
        • Error Trigger
        • Execute Command
        • Execute Workflow
        • FTP
        • Function
        • Function Item
        • Git
        • GraphQL
        • HTML Extract
        • HTTP Request
        • iCalendar
        • IF
        • IMAP Email
        • Interval
        • Item Lists
        • Local File Trigger
        • Markdown
        • Merge
        • Move Binary Data
        • n8n Trigger
        • No Operation, do nothing
        • Read Binary File
        • Read Binary Files
        • Read PDF
        • Rename Keys
        • Respond to Webhook
        • RSS Read
        • Send Email
        • Set
        • Split In Batches
        • Spreadsheet File
        • SSE Trigger
        • SSH
        • Start
        • Stop And Error
        • Switch
        • Wait
        • Webhook
        • Workflow Trigger
        • Write Binary File
        • XML
        • Overview
        • Brandfetch
        • Action Network
        • ActiveCampaign
        • Affinity
        • Agile CRM
        • Airtable
        • AMQP Sender
        • APITemplate.io
        • Asana
        • Automizy
        • Autopilot
        • AWS Comprehend
        • AWS DynamoDB
        • AWS Lambda
        • AWS Rekognition
        • AWS S3
        • AWS SES
        • AWS SNS
        • AWS SQS
        • AWS Textract
        • AWS Transcribe
        • BambooHR
        • Bannerbear
        • Baserow
        • Beeminder
        • Bitly
        • Bitwarden
        • Box
        • Bubble
        • Chargebee
        • CircleCI
        • Webex by Cisco
        • Clearbit
        • ClickUp
        • Clockify
        • Cockpit
        • Coda
        • CoinGecko
        • Contentful
        • ConvertKit
        • Copper
        • Cortex
        • CrateDB
        • Customer.io
        • DeepL
        • Demio
        • DHL
        • Discord
        • Discourse
        • Disqus
        • Drift
        • Dropbox
        • Dropcontact
        • E-goi
        • Elastic Security
        • Elasticsearch
        • Emelia
        • ERPNext
        • Facebook Graph API
        • FileMaker
        • Flow
        • Freshdesk
        • Freshservice
        • Freshworks CRM
        • G Suite Admin
        • GetResponse
        • Ghost
        • GitHub
        • GitLab
        • Gmail
        • GoToWebinar
        • Google Analytics
        • Google BigQuery
        • Google Books
        • Google Calendar
        • Google Chat
        • Google Cloud Firestore
        • Google Cloud Natural Language
        • Google Cloud Realtime Database
        • Google Contacts
        • Google Docs
        • Google Drive
        • Google Perspective
        • Google Sheets
        • Google Slides
        • Google Tasks
        • Google Translate
        • Gotify
        • Grafana
        • Grist
        • Hacker News
        • HaloPSA
        • Harvest
        • Help Scout
        • 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
        • 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
        • OpenThesaurus
        • OpenWeatherMap
        • Orbit
        • Oura
        • Paddle
        • PagerDuty
        • PayPal
        • Peekalink
        • Phantombuster
        • Philips Hue
        • Pipedrive
        • Plivo
        • PostHog
        • Postbin
        • Postgres
        • ProfitWell
        • Pushbullet
        • Pushcut
        • Pushover
        • QuestDB
        • Quick Base
        • QuickBooks
        • RabbitMQ
        • Raindrop
        • Reddit
        • Redis
        • Rocket.Chat
        • Rundeck
        • S3
        • Salesforce
        • Salesmate
        • SeaTable
        • SecurityScorecard
        • Segment
        • SendGrid
        • 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
        • Vero
        • Vonage
        • Webflow
        • Wekan
        • Wise
        • WooCommerce
        • WordPress
        • Xero
        • YouTube
        • Yourls
        • Zammad
        • Zendesk
        • Zoho CRM
        • Zoom
        • Zulip
        • Overview
        • ActiveCampaign Trigger
        • Acuity Scheduling Trigger
        • Affinity Trigger
        • Airtable Trigger
        • AMQP Trigger
        • Asana Trigger
        • Autopilot Trigger
        • AWS SNS Trigger
        • Bitbucket Trigger
        • Box Trigger
        • Cal Trigger
        • Calendly 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)
        • Flow Trigger
        • Form.io Trigger
        • Formstack Trigger
        • GetResponse Trigger
        • GitHub Trigger
        • GitLab Trigger
        • Google Calendar Trigger
        • Google Drive 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
        • Shopify Trigger
        • Strava Trigger
        • Stripe Trigger
        • SurveyMonkey Trigger
        • Taiga Trigger
        • Telegram Trigger
        • The Hive trigger
        • Toggl Trigger
        • Trello Trigger
        • Typeform Trigger
        • Webflow Trigger
        • Wise Trigger
        • WooCommerce Trigger
        • Workable Trigger
        • Wufoo Trigger
        • Zendesk Trigger
        • Overview
        • Action Network
        • ActiveCampaign
        • Acuity Scheduling
        • Affinity
        • Agile CRM
        • Airtable
        • AMQP
        • APITemplate.io
        • Asana
        • Automizy
        • Autopilot
        • AWS
        • BambooHR
        • Bannerbear
        • Baserow
        • Beeminder
        • Bitbucket
        • Bitly
        • Bitwarden
        • Box
        • Brandfetch
        • Bubble
        • Cal
        • Calendly
        • Chargebee
        • CircleCI
        • Webex by Cisco
        • Clearbit
        • ClickUp
        • Clockify
        • Cockpit
        • Coda
        • Contentful
        • ConvertKit
        • Copper
        • Cortex
        • CrateDB
        • Customer.io
        • DeepL
        • Demio
        • DHL
        • Discord
        • Discourse
        • Disqus
        • Drift
        • Dropbox
        • Dropcontact
        • E-goi
        • Elastic Security
        • Elasticsearch
        • Emelia
        • ERPNext
        • Eventbrite
        • Facebook App
        • Facebook Graph API
        • Figma
        • FileMaker
        • Flow
        • Form.io Trigger
        • Formstack Trigger
        • Freshdesk
        • Freshservice
        • Freshworks CRM
        • FTP
        • GetResponse
        • Ghost
        • Git
        • GitHub
        • GitLab
        • GoToWebinar
        • Google
        • Gotify
        • Grafana
        • Grist
        • Gumroad
        • HaloPSA
        • Harvest
        • Help Scout
        • Home Assistant
        • HTTP Request
        • HubSpot
        • Humantic AI
        • Hunter
        • IMAP
        • Intercom
        • Invoice Ninja
        • Iterable
        • Jenkins
        • Jira
        • JotForm
        • Kafka
        • Keap
        • Kitemaker
        • KoBo Toolbox
        • Lemlist
        • Line
        • Linear
        • LingvaNex
        • LinkedIn
        • Magento 2
        • Mailcheck
        • Mailchimp
        • MailerLite
        • Mailgun
        • Mailjet
        • Mandrill
        • Marketstack
        • Matrix
        • Mattermost
        • Mautic
        • Medium
        • MessageBird
        • Microsoft
        • Microsoft SQL
        • Mindee
        • MISP
        • Mocean
        • monday.com
        • MongoDB
        • Monica CRM
        • MQTT
        • MSG91
        • MySQL
        • NASA
        • Netlify
        • Nextcloud
        • NocoDB
        • Notion
        • Odoo credentials
        • One Simple API
        • Onfleet credentials
        • OpenWeatherMap
        • Orbit
        • Oura
        • Paddle
        • PagerDuty
        • PayPal
        • Peekalink
        • Phantombuster
        • Philips Hue
        • Pipedrive
        • Plivo
        • PostHog
        • Postgres
        • Postmark
        • ProfitWell
        • Pushbullet
        • Pushcut
        • Pushover
        • QuestDB
        • Quick Base
        • QuickBooks
        • RabbitMQ
        • Raindrop
        • Reddit
        • Redis
        • Rocket.Chat
        • Rundeck
        • S3
        • Salesforce
        • Salesmate
        • SeaTable
        • SecurityScorecard
        • Segment
        • Send Email
        • SendGrid
        • Sendy
        • Sentry.io
        • ServiceNow
        • Shopify
        • SIGNL4
        • Slack
        • sms77
        • Snowflake
        • Splunk
        • Spontit
        • Spotify
        • SSH
        • Stackby
        • Storyblok
        • Strapi
        • Strava
        • Stripe
        • Supabase
        • SurveyMonkey
        • SyncroMSP
        • Taiga
        • Tapfiliate
        • Telegram
        • TheHive
        • TimescaleDB
        • Todoist
        • Toggl
        • Travis CI
        • Trello
        • Twake
        • Twilio
        • Twist
        • Twitter
        • Typeform
        • uProc
        • Unleashed Software
        • UpLead
        • UptimeRobot
        • urlscan.io
        • Vero
        • Vonage
        • Webflow
        • Wekan
        • Wise
        • WooCommerce
        • WordPress
        • Workable
        • Wufoo
        • Xero
        • Yourls
        • Zammad
        • Zendesk
        • Zoho
        • Zoom
        • Zulip
      • Custom API actions for existing nodes
        • Overview
          • Overview
          • Standards
          • Create your first node
          • Create an n8n-nodes-module
          • Create a trigger node
          • Use the node developer CLI
          • Node UI elements
          • HTTP request helpers
          • Node linter
          • Node review checklist
          • Troubleshooting
      • Overview
        • Overview
        • 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, importing, and sharing workflows
        • Test your knowledge
        • Overview
        • 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
      • Overview
      • Installation and hosting options
        • Overview
        • Desktop app
        • npm
        • Docker
        • Cloud
      • Configuration
      • Environment variables
      • User management
      • Security
      • Logging
        • Overview
        • Docker Compose
        • Caddy
        • Overview
        • Supported databases and settings
        • Database structure
        • Overview
        • npm
        • Docker
        • Desktop app
        • Cloud
        • Overview
        • Execution data
        • Execution modes and processes
        • Configuring queue mode
      • The n8n public API
      • Authentication
      • Pagination
      • Using the API playground
      • API reference
      • n8n Embed
      • Prerequisites
      • Deployment
      • Configuration
      • Workflow management
      • Workflows templates
    • Contributing

    Previous Using the API playground
    Next n8n Embed
    Made with Material for MkDocs Insiders

    Cookie and analytics consent

    We use cookies (and other similar technologies) to collect data in order to improve our site. You have the option to opt-in or opt-out of certain cookie tracking technologies. For more information on privacy and data management at n8n, refer to our privacy policy.