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
      • Understand workflows
        • Workflows
        • Connections
        • Nodes
        • Items
        • Sticky Notes
        • Executions
      • Manage credentials
        • Create and edit
        • Credential sharing
      • Flow logic
        • Merging
        • Looping
        • Error handling
      • 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
      • Expressions and JavaScript
        • Built in methods and variables reference
        • Built-in methods and variables examples
          • evaluateExpression
          • execution
          • getWorkflowStaticData
          • (node-name).item
          • (node-name).all
          • runIndex
          • workflow
        • Expressions examples
          • Date and time with Luxon
          • JSON with JMESPath
        • JavaScript examples
          • 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
        • Using console.log
      • Reference
        • Release notes
        • CLI commands
        • Keyboard shortcuts
        • Glossary
        • License
        • Data collection
    • 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 Extract
          • HTTP Request
          • iCalendar
          • IF
          • Interval
          • Item Lists
          • Local File Trigger
          • Manual 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
          • 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 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
          • 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
          • OpenThesaurus
          • OpenWeatherMap
          • Orbit
          • Oura
          • Paddle
          • PagerDuty
          • PayPal
          • Peekalink
          • Phantombuster
          • Philips Hue
          • Pipedrive
          • Plivo
          • Postbin
          • Postgres
          • PostHog
          • 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
          • 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)
          • 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
          • Venafi TLS Protect Cloud Trigger
          • Webflow Trigger
          • Wise Trigger
          • WooCommerce Trigger
          • Workable Trigger
          • Wufoo Trigger
          • Zendesk Trigger
        • Credentials
          • 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
          • Citrix ADC
          • Clearbit
          • ClickUp
          • Clockify
          • Cloudflare
          • Cockpit
          • Coda
          • Contentful
          • ConvertKit
          • Copper
          • Cortex
          • CrateDB
          • Customer.io
          • DeepL
          • Demio
          • DHL
          • Discord
          • Discourse
          • Disqus
          • Drift
          • Dropbox
          • Dropcontact
          • E-goi
          • Elasticsearch
          • Elastic Security
          • 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
          • Google
            • Google: OAuth2 single service
            • Google: OAuth2 generic
            • Google: Service Account
          • Gotify
          • GoToWebinar
          • 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
          • Postgres
          • PostHog
          • 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
          • Sendinblue
          • 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
          • Unleashed Software
          • UpLead
          • uProc
          • UptimeRobot
          • urlscan.io
          • Venafi TLS Protect Cloud
          • Venafi TLS Protect Datacenter
          • Vero
          • Vonage
          • Webflow
          • Wekan
          • WhatsApp Business
          • Wise
          • WooCommerce
          • WordPress
          • Workable
          • Wufoo
          • Xero
          • Yourls
          • Zammad
          • Zendesk
          • Zoho
          • Zoom
          • Zulip
      • 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
      • Configuration
      • Environment variables
      • User management
      • Security
      • Logging
      • Server setups
        • Digital Ocean
        • Heroku
        • Hetzner
        • Amazon Web Services
        • Azure
        • Google Cloud
        • Docker Compose
        • Caddy
      • Databases
        • Supported databases and settings
        • Database structure
      • Updating
        • npm
        • Docker
        • Desktop app
        • Cloud
      • Scaling
        • Execution data
        • Execution modes and processes
        • Configuring queue mode
    • 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

    Previous Using the API playground
    Next Introduction
    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