logo
n8n Documentation
Initializing search
    • Using n8n
    • Integrations
    • Hosting n8n
    • API
    • Embed
    • Courses
    • Contributing
      • Welcome
        • Overview
        • A very quick quickstart
        • A longer introduction
        • Overview
        • Workflows
        • Connections
        • Nodes
        • Items
        • Sticky Notes
        • Executions
        • Overview
        • Create and edit
        • Credential sharing
        • Overview
        • Merging
        • Looping
        • Error handling
        • Overview
        • Data structure
        • Transforming data
        • Process data using code
          • Overview
          • Data mapping in the UI
            • Overview
            • Item linking concepts
            • Item linking in the Function node
            • Item linking errors
            • Item linking for node creators
        • Data pinning
        • Data editing
        • Overview
        • Built in methods and variables reference
          • Overview
          • evaluateExpression
          • execution
          • getWorkflowStaticData
          • (node-name).item
          • (node-name).all
          • runIndex
          • workflow
          • Overview
          • Date and time with Luxon
          • JSON with JMESPath
          • Overview
          • 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
          • Check incoming data
        • Overview
        • Release notes
        • CLI commands
        • Keyboard shortcuts
        • Glossary
        • License
        • Data collection
      • Overview
        • 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
          • 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
          • Action Network
          • ActiveCampaign
          • Adalo
          • 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
          • Brandfetch
          • 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 Ads node
          • 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
          • Grafana
          • Grist
          • 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
          • 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
          • 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
          • Vero
          • Vonage
          • Webflow
          • Wekan
          • WhatsApp Business Platform
          • 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
          • Gmail 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
          • Sendinblue 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
          • Adalo
          • 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
          • HighLevel
          • 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
          • Metabase
          • 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
          • Sendinblue
          • 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
          • WhatsApp Business
          • Wise
          • WooCommerce
          • WordPress
          • Workable
          • Wufoo
          • Xero
          • Yourls
          • Zammad
          • Zendesk
          • Zoho
          • Zoom
          • Zulip
      • Custom API actions for existing nodes
        • Overview
        • Installation and management
        • Risks
        • Blocklist
        • Using community nodes
        • Troubleshooting
        • Building community nodes
        • Overview
          • Overview
          • Choose a node building style
          • Node UI design
          • Choose node file structure
          • Overview
          • Set up your development environment
          • Tutorial: Build a declarative-style node
          • Tutorial: Build a programmatic-style node
            • Overview
            • Node UI elements
            • Code standards
            • Versioning
            • File structure
            • Base files
            • Codex files
            • Credentials files
            • HTTP request helpers
            • Item linking
          • Overview
          • Run your node locally
          • Node linter
          • Troubleshooting
          • Overview
          • Submit community nodes
          • Install private nodes
      • Overview
      • Installation and hosting options
        • Overview
        • Desktop app
        • npm
        • Docker
        • Cloud
      • Configuration
      • Environment variables
      • User management
      • Security
      • Logging
        • Overview
        • Docker Compose
        • Caddy
        • Digital Ocean
        • Google Cloud
        • 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
      • 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 and importing 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
    • Contributing

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

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
    Privacy policy