[{
"url": "https://docs.n8n.io/",
"markdown": "# Explore n8n Docs: Your Resource for Workflow Automation and Integrations\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/index.md \"Edit this page\")\n\n## Welcome to n8n Docs[#](#welcome-to-n8n-docs \"Permanent link\")\n\nThis is the documentation for [n8n](https://n8n.io/), a [fair-code](https://faircode.io/) licensed workflow automation tool that combines AI capabilities with business process automation.\n\nIt covers everything from setup to usage and development. It's a work in progress and all [contributions](https://docs.n8n.io/help-community/contributing/) are welcome.\n\n## Where to start[#](#where-to-start \"Permanent link\")\n\n* **Quickstarts**\n \n Jump in with n8n's quickstart guides.\n \n [Try it out](https://docs.n8n.io/try-it-out/)\n \n* **Choose the right n8n for you**\n \n Cloud, npm, self-host . . .\n \n [Options](https://docs.n8n.io/choose-n8n/)\n \n* **Explore integrations**\n \n Browse n8n's integrations library.\n \n [Find your apps](https://docs.n8n.io/integrations/)\n \n* **Build AI functionality**\n \n n8n supports building AI functionality and tools.\n \n [Advanced AI](https://docs.n8n.io/advanced-ai/)\n \n\n## About n8n[#](#about-n8n \"Permanent link\")\n\nn8n (pronounced n-eight-n) helps you to connect any app with an API with any other, and manipulate its data with little or no code.\n\n* Customizable: highly flexible workflows and the option to build custom nodes.\n* Convenient: use the npm or Docker to try out n8n, or the Cloud hosting option if you want us to handle the infrastructure.\n* Privacy-focused: self-host n8n for privacy and security."
},
{
"url": "https://docs.n8n.io/workflows/executions/debug/",
"markdown": "# Debug and re-run past executions\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/debug.md \"Edit this page\")\n\nFeature availability\n\nAvailable on n8n Cloud and registered Community plans.\n\nYou can load data from a previous execution into your current workflow. This is useful for debugging data from failed production executions: you can see a failed execution, make changes to your workflow to fix it, then re-run it with the previous execution data.\n\n## Load data[#](#load-data \"Permanent link\")\n\nTo load data from a previous execution:\n\n1. In your workflow, select the **Executions** tab to view the **Executions** list.\n2. Select the execution you want to debug. n8n displays options depending on whether the workflow was successful or failed:\n * For failed executions: select **Debug in editor**.\n * For successful executions: select **Copy to editor**.\n3. n8n copies the execution data into your current workflow, and [pins the data](https://docs.n8n.io/data/data-pinning/) in the first node in the workflow.\n\nCheck which executions you save\n\nThe executions available on the **Executions** list depends on your [Workflow settings](https://docs.n8n.io/workflows/settings/)."
},
{
"url": "https://docs.n8n.io/workflows/tags/",
"markdown": "# Workflow tags | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/tags.md \"Edit this page\")\n\nWorkflow tags allow you to label your workflows. You can then filter workflows by tag.\n\nTags are global. This means when you create a tag, it's available to all users on your n8n instance.\n\n## Add a tag to a workflow[#](#add-a-tag-to-a-workflow \"Permanent link\")\n\nTo add a tag to your workflow:\n\n1. In your workflow, select **\\+ Add tag**.\n2. Select an existing tag, or enter a new tag name.\n3. Once you select a tag and click away from the tag modal, n8n displays the tag next to the workflow name.\n\nYou can add more than one tag.\n\n## Filter by tag[#](#filter-by-tag \"Permanent link\")\n\nWhen browsing the workflows on your instance, you can filter by tag.\n\n1. On the **Workflows** page, select **Filters**.\n2. Select **Tags**.\n3. Select the tag or tags you want to filter by. n8n lists the workflows with that tag.\n\nYou can edit existing tags. Instance owners can delete tags.\n\n1. Select **Manage tags**. This is available from **Filters** > **Tags** on the **Workflows** page, or in the **\\+ Add tag** modal in your workflow.\n2. Hover over the tag you want to change.\n3. Select **Edit**  to rename it, or **Delete**  to delete it.\n\nGlobal tags\n\nTags are global. If you edit or delete a tag, this affects all users of your n8n instance."
},
{
"url": "https://docs.n8n.io/workflows/export-import/",
"markdown": "# Export and import workflows | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/export-import.md \"Edit this page\")\n\nn8n saves workflows in JSON format. You can export your workflows as JSON files or import JSON files into your n8n library. You can export and import workflows in several ways.\n\nSharing credentials\n\nExported workflow JSON files include [credential](https://docs.n8n.io/glossary/#credential-n8n) names and IDs. While IDs aren't sensitive, the names could be, depending on how you name your credentials. HTTP Request nodes may contain authentication headers when imported from cURL. Remove or anonymize this information from the JSON file before sharing to protect your credentials.\n\n## Copy-Paste[#](#copy-paste \"Permanent link\")\n\nYou can copy and paste a workflow or parts of it by selecting the nodes you want to copy to the clipboard (`Ctrl + c` or `cmd +c`) and pasting it (`Ctrl + v` or `cmd + v`) into the Editor UI.\n\nTo select all nodes or a group of nodes, click and drag: [](https://docs.n8n.io/_images/workflows/export-import/selectingnodes.gif)\n\nFrom the top navigation bar, select the three dots in the upper right  to see the following options:\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-six/l1-c6-import-export-menu.png)\n\n_Import & Export workflows menu_\n\n* **Download**: Downloads your current workflow as a JSON file to your computer.\n* **Import from URL**: Imports workflow JSON from a URL, for example, [this workflow JSON file on GitHub](https://raw.githubusercontent.com/n8n-io/self-hosted-ai-starter-kit/refs/heads/main/n8n/demo-data/workflows/srOnR8PAY3u4RSwb.json).\n* **Import from File**: Imports a workflow as a JSON file from your computer.\n\n## From the command line[#](#from-the-command-line \"Permanent link\")\n\n* Export: See the [full list of commands](https://docs.n8n.io/hosting/cli-commands/#export-workflows-and-credentials) for exporting workflows or credentials.\n* Import: See the [full list of commands](https://docs.n8n.io/hosting/cli-commands/#import-workflows-and-credentials) for importing workflows or credentials."
},
{
"url": "https://docs.n8n.io/workflows/templates/",
"markdown": "# Templates | n8n Docs\n\n 1\n 2\n 3\n 4\n 5\n 6\n 7\n 8\n 9\n 10\n 11\n 12\n 13\n 14\n 15\n 16\n 17\n 18\n 19\n 20\n 21\n 22\n 23\n 24\n 25\n 26\n 27\n 28\n 29\n 30\n 31\n 32\n 33\n 34\n 35\n 36\n 37\n 38\n 39\n 40\n 41\n 42\n 43\n 44\n 45\n 46\n 47\n 48\n 49\n 50\n 51\n 52\n 53\n 54\n 55\n 56\n 57\n 58\n 59\n 60\n 61\n 62\n 63\n 64\n 65\n 66\n 67\n 68\n 69\n 70\n 71\n 72\n 73\n 74\n 75\n 76\n 77\n 78\n 79\n 80\n 81\n 82\n 83\n 84\n 85\n 86\n 87\n 88\n 89\n 90\n 91\n 92\n 93\n 94\n 95\n 96\n 97\n 98\n 99\n100\n101\n102\n103\n104\n105\n106\n107\n108\n109\n110\n111\n112\n113\n114\n115\n116\n117\n118\n119\n120\n121\n122\n123\n124\n125\n126\n127\n128\n129\n130\n131\n132\n133\n134\n135\n136\n137\n138\n139\n140\n141\n142\n143\n144\n145\n146\n147\n148\n149\n150\n151\n152\n153\n154\n155\n156\n157\n158\n159\n160\n161\n162\n163\n164\n165\n166\n167\n168\n169\n170\n171\n172\n173\n174\n175\n176\n177\n178\n179\n180\n181\n182\n183\n184\n185\n186\n187\n188\n189\n190\n191\n192\n193\n194\n195\n196\n197\n198\n199\n200\n201\n202\n203\n204\n205\n206\n207\n\n`{ \"$schema\": \"http://json-schema.org/draft-07/schema#\", \"title\": \"Generated schema for Root\", \"type\": \"object\", \"properties\": { \"id\": { \"type\": \"number\" }, \"name\": { \"type\": \"string\" }, \"totalViews\": { \"type\": \"number\" }, \"price\": {}, \"purchaseUrl\": {}, \"recentViews\": { \"type\": \"number\" }, \"createdAt\": { \"type\": \"string\" }, \"user\": { \"type\": \"object\", \"properties\": { \"username\": { \"type\": \"string\" }, \"verified\": { \"type\": \"boolean\" } }, \"required\": [ \"username\", \"verified\" ] }, \"nodes\": { \"type\": \"array\", \"items\": { \"type\": \"object\", \"properties\": { \"id\": { \"type\": \"number\" }, \"icon\": { \"type\": \"string\" }, \"name\": { \"type\": \"string\" }, \"codex\": { \"type\": \"object\", \"properties\": { \"data\": { \"type\": \"object\", \"properties\": { \"details\": { \"type\": \"string\" }, \"resources\": { \"type\": \"object\", \"properties\": { \"generic\": { \"type\": \"array\", \"items\": { \"type\": \"object\", \"properties\": { \"url\": { \"type\": \"string\" }, \"icon\": { \"type\": \"string\" }, \"label\": { \"type\": \"string\" } }, \"required\": [ \"url\", \"label\" ] } }, \"primaryDocumentation\": { \"type\": \"array\", \"items\": { \"type\": \"object\", \"properties\": { \"url\": { \"type\": \"string\" } }, \"required\": [ \"url\" ] } } }, \"required\": [ \"primaryDocumentation\" ] }, \"categories\": { \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"nodeVersion\": { \"type\": \"string\" }, \"codexVersion\": { \"type\": \"string\" } }, \"required\": [ \"categories\" ] } } }, \"group\": { \"type\": \"string\" }, \"defaults\": { \"type\": \"object\", \"properties\": { \"name\": { \"type\": \"string\" }, \"color\": { \"type\": \"string\" } }, \"required\": [ \"name\" ] }, \"iconData\": { \"type\": \"object\", \"properties\": { \"icon\": { \"type\": \"string\" }, \"type\": { \"type\": \"string\" }, \"fileBuffer\": { \"type\": \"string\" } }, \"required\": [ \"type\" ] }, \"displayName\": { \"type\": \"string\" }, \"typeVersion\": { \"type\": \"number\" }, \"nodeCategories\": { \"type\": \"array\", \"items\": { \"type\": \"object\", \"properties\": { \"id\": { \"type\": \"number\" }, \"name\": { \"type\": \"string\" } }, \"required\": [ \"id\", \"name\" ] } } }, \"required\": [ \"id\", \"icon\", \"name\", \"codex\", \"group\", \"defaults\", \"iconData\", \"displayName\", \"typeVersion\" ] } } }, \"required\": [ \"id\", \"name\", \"totalViews\", \"price\", \"purchaseUrl\", \"recentViews\", \"createdAt\", \"user\", \"nodes\" ] }`"
},
{
"url": "https://docs.n8n.io/workflows/sharing/",
"markdown": "# Sharing | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/sharing.md \"Edit this page\")\n\n## Workflow sharing[#](#workflow-sharing \"Permanent link\")\n\nFeature availability\n\nAvailable on Pro and Enterprise Cloud plans, and Enterprise self-hosted plans.\n\nWorkflow sharing allows you to share workflows between users of the same n8n instance.\n\nUsers can share workflows they created. Instance owners, and users with the admin role, can view and share all workflows in the instance. Refer to [Account types](https://docs.n8n.io/user-management/account-types/) for more information about owners and admins.\n\n1. Open the workflow you want to share.\n2. Select **Share**.\n3. In **Add users**, find and select the users you want to share with.\n4. Select **Save**.\n\nYou can browse and search workflows on the **Workflows** list. The workflows in the list depend on the project:\n\n* **Overview** lists all workflows you can access. This includes:\n * Your own workflows.\n * Workflows shared with you.\n * Workflows in projects you're a member of.\n * If you log in as the instance owner or admin: all workflows in the instance.\n* Other projects: all workflows in the project.\n\n## Workflow roles and permissions[#](#workflow-roles-and-permissions \"Permanent link\")\n\nThere are two workflow roles: creator and editor. The creator is the user who created the workflow. Editors are other users with access to the workflow.\n\nYou can't change the workflow owner, except when deleting the user.\n\nCredentials\n\nWorkflow sharing allows editors to use all [credentials](https://docs.n8n.io/glossary/#credential-n8n) used in the workflow. This includes credentials that aren't explicitly shared with them using [credential sharing](https://docs.n8n.io/credentials/credential-sharing/).\n\n### Permissions[#](#permissions \"Permanent link\")\n\nSharing in n8n works on the principle of least privilege. This means that if a user shares a workflow with you, but they don't share their credentials, you can't edit the nodes within the workflow that use those credentials. You can view and run the workflow, and edit nodes that don't use unshared credentials.\n\nRefer to [Credential sharing](https://docs.n8n.io/credentials/credential-sharing/) for guidance on sharing credentials."
},
{
"url": "https://docs.n8n.io/workflows/settings/",
"markdown": "# Settings | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/settings.md \"Edit this page\")\n\n## Workflow settings[#](#workflow-settings \"Permanent link\")\n\nYou can customize workflow behavior for individual workflows using workflow settings.\n\nTo open the settings:\n\n1. Open your workflow.\n2. Select the **Options**  menu.\n3. Select **Settings**. n8n opens the **Workflow settings** modal.\n\nThe following settings are available:\n\n* **Execution order**: choose the execution order for multi-branch workflows. **v0 (legacy)** executes the first node of each branch, then the second node of each branch, and so on. **v1 (recommended)** executes each branch in turn, completing one branch before starting another. n8n orders the branches based on their position on the [canvas](https://docs.n8n.io/glossary/#canvas-n8n), from topmost to bottommost. If two branches are at the same height, the leftmost branch executes first.\n* **Error Workflow**: select a workflow to trigger if the current workflow fails. See [Error workflows](https://docs.n8n.io/flow-logic/error-handling/) for more details.\n* **This workflow can be called by**: choose whether other workflow can call this workflow.\n* **Timezone**: sets the timezone for the workflow to use. The default timezone is EDT (New York). The timezone setting is important for the Schedule Trigger node.\n* **Save failed production executions**: whether n8n should save failed executions for active workflows.\n* **Save successful production executions**: whether n8n should save successful executions for active workflows.\n* **Save manual executions**: whether n8n should save executions for workflows started by the user in the editor.\n* **Save execution progress**: whether n8n should save execution data for each node. If set to **Save**, the workflow resumes from where it stopped in case of an error. This might increase latency.\n* **Timeout Workflow**: toggle to enable setting a duration after which n8n should cancel the current workflow execution.\n * **Timeout After**: Set the time in hours, minutes, and seconds after which the workflow should timeout. For n8n Cloud users n8n enforces a maximum available timeout for each plan."
},
{
"url": "https://docs.n8n.io/workflows/history/",
"markdown": "# Workflow history | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/history.md \"Edit this page\")\n\nFeature availability\n\n* Full workflow history is available on Enterprise Cloud and Enterprise Self-hosted.\n* Versions from the last five days are available for Cloud Pro users.\n* Versions from the last 24 hours are available for registered Community users.\n\nUse workflow history to view and restore previous versions of your workflows.\n\n## Understand workflow history[#](#understand-workflow-history \"Permanent link\")\n\nn8n creates a new version when you:\n\n* Save your workflow.\n* Restore an old version. n8n saves the latest version before restoring.\n* Pull from a Git repository using [Source control](https://docs.n8n.io/source-control-environments/). Note that n8n saves versions to the instance database, not to Git.\n\nWorkflow history and execution history\n\nDon't confuse workflow history with the [Workflow-level executions list](https://docs.n8n.io/workflows/executions/single-workflow-executions/).\n\nExecutions are workflow runs. With the executions list, you can see previous runs of the current version of the workflow. You can copy previous executions into the editor to [Debug and re-run past executions](https://docs.n8n.io/workflows/executions/debug/) in your current workflow.\n\nWorkflow history is previous versions of the workflow: for example, a version with a different node, or different parameters set.\n\n## View workflow history[#](#view-workflow-history \"Permanent link\")\n\nTo view a workflow's history:\n\n1. Open the workflow.\n2. Select **Workflow history** . n8n opens a menu showing the saved workflow versions, and a canvas with a preview of the selected version.\n\n## Restore or copy previous versions[#](#restore-or-copy-previous-versions \"Permanent link\")\n\nYou can restore a previous workflow version, or make a copy of it:\n\n1. On the version you want to restore or copy, select **Options** .\n2. Choose what you want to do:\n * **Restore this version**: replace your current workflow with the selected version.\n * **Clone to new workflow**: create a new workflow based on the selected version.\n * **Open version in new tab**: open a second tab displaying the selected version. Use this to compare versions.\n * **Download**: download the version as JSON."
},
{
"url": "https://docs.n8n.io/workflows/workflow-id/",
"markdown": "# Workflow ID | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/workflow-id.md \"Edit this page\")\n\n## Find your workflow ID[#](#find-your-workflow-id \"Permanent link\")\n\nYour workflow ID is available in:\n\n* The URL of the open workflow.\n* The workflow settings title."
},
{
"url": "https://docs.n8n.io/workflows/subworkflow-conversion/",
"markdown": "# Sub-workflow conversion | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/subworkflow-conversion.md \"Edit this page\")\n\nFeature availability\n\nAvailable on all plans from n8n version 1.97.0.\n\nUse sub-workflow conversion to refactor your workflows into reusable parts. Expressions referencing other nodes are automatically updated and added as parameters in the [Execute Workflow Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger/) node.\n\nSee [sub-workflows](https://docs.n8n.io/flow-logic/subworkflows/) for a general introduction to the concept.\n\n## Selecting nodes for a sub-workflow[#](#selecting-nodes-for-a-sub-workflow \"Permanent link\")\n\nTo convert part of a workflow to a sub-workflow, you must select the nodes in the original workflow that you want to convert.\n\nDo this by selecting a group of valid nodes. The selection must be continuous and must connect to the rest of the workflow from at most one start node and one end node. The selection must fulfill these conditions:\n\n* Must not include trigger nodes.\n* Only a single node in the selection can have incoming connections from nodes _outside_ of the selection.\n * That node can have multiple incoming connections, but only a single input _branch_ (which means it can't be a [Merge node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/) for example).\n * That node can't have incoming connections from other nodes in the selection.\n* Only a single node in the selection can have outgoing connections to nodes _outside_ of the selection.\n * That node can have multiple outgoing connections, but only a single output branch (it can't be an [If node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) for example).\n * That node can't have outgoing connections to other nodes in the selection.\n* The selection must include all nodes between the input and output nodes.\n\n## How to convert part of a workflow to a sub-workflow[#](#how-to-convert-part-of-a-workflow-to-a-sub-workflow \"Permanent link\")\n\nSelect the desired nodes on the canvas. Right-click the canvas background and select **Convert to sub-workflow**.\n\n## Things to keep in mind[#](#things-to-keep-in-mind \"Permanent link\")\n\nMost sub-workflow conversions work without issues, but there are some caveats and limitations to keep in mind:\n\n* **You must set type constraints for input and output manually**: By default, sub-workflow input and output allow all types. You can set expected types in sub-workflow's [Execute Sub-workflow Trigger node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger/) and [Edit Fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) (labeled as **Return** and only included if the sub-workflow has outputs).\n* **Limited support for AI nodes**: When dealing with sub-nodes like AI tools, you must select them all and may need to duplicate any nodes shared with other AI Agents before conversion.\n* **Uses v1 execution ordering:** New workflows use [`v1` execution ordering](https://docs.n8n.io/flow-logic/execution-order/) regardless of the parent workflow's settings - you can change this back in the settings.\n* **Accessor functions like `first()`, `last()`, and `all()` require extra care**: Expressions using these functions don't always translate cleanly to a sub-workflow context. n8n may transform them to try to preserve their functionality, but you should check that they work as intended in their new context.\n \n Sub-node parameter suffixes\n \n n8n adds suffixes like `_firstItem`, `_lastItem`, and `_allItems` to variable names accessed by these functions. This helps preserve information about the original expression, since item ordering may be different in the sub-workflow context.\n \n\n* **The `itemMatching` function requires a fixed index**: You can't use expressions for the index value when using the [`itemMatching` function](https://docs.n8n.io/code/builtin/output-other-nodes/). You must pass it a fixed number."
},
{
"url": "https://docs.n8n.io/credentials/",
"markdown": "# Credentials | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/credentials/index.md \"Edit this page\")\n\n[Credentials](https://docs.n8n.io/glossary/#credential-n8n) are private pieces of information issued by apps and services to authenticate you as a user and allow you to connect and share information between the app or service and the n8n node.\n\nAccess the credentials UI by opening the left menu and selecting **Credentials**. n8n lists credentials you created on the **My credentials** tab. The **All credentials** tab shows all credentials you can use, included credentials shared with you by other users.\n\n* [Create and edit credentials](https://docs.n8n.io/credentials/add-edit-credentials/).\n* Learn about [credential sharing](https://docs.n8n.io/credentials/credential-sharing/).\n* Find information on setting up credentials for your services in the [credentials library](https://docs.n8n.io/integrations/builtin/credentials/)."
},
{
"url": "https://docs.n8n.io/credentials/credential-sharing/",
"markdown": "# Credential sharing | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/credentials/credential-sharing.md \"Edit this page\")\n\nFeature availability\n\nAvailable on all Cloud plans, and Enterprise self-hosted plans.\n\nYou can share a credential directly with other users to use in their own workflows. Or share a credential in a [project](https://docs.n8n.io/glossary/#project-n8n) for all members of that project to use. Any users using a shared credential won't be able to view or edit the credential details.\n\nUsers can share credentials they created and own. Only project admins can share credentials created in and owned by a project. Instance owners and instance admins can view and share all credentials on an instance.\n\nRefer to [Account types](https://docs.n8n.io/user-management/account-types/) for more information about owners and admins.\n\nIn [projects](https://docs.n8n.io/user-management/rbac/), a user's role controls how they can interact with the workflows and credentials associated to the projects they're a member of.\n\nTo share a credential:\n\n1. From the left menu, select either **Overview** or a project.\n2. Select **Credentials** to see a list of your credentials.\n3. Select the credential you want to share.\n4. Select **Sharing**.\n5. In the **Share with projects or users** dropdown, browse or search for the user or project with which you want to share your credentials.\n6. Select a user or project.\n7. Select **Save** to apply the changes.\n\n## Remove access to a credential[#](#remove-access-to-a-credential \"Permanent link\")\n\nTo unshare a credential:\n\n1. From the left menu, select either **Overview** or a project.\n2. Select **Credentials** to see a list of your credentials.\n3. Select the credential you want to unshare.\n4. Select **Sharing**.\n5. Select **trash icon** on the user or project you want to remove from the list of shared users and projects.\n6. Select **Save** to apply the changes."
},
{
"url": "https://docs.n8n.io/credentials/add-edit-credentials/",
"markdown": "# Create and edit | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/credentials/add-edit-credentials.md \"Edit this page\")\n\n## Create and edit credentials[#](#create-and-edit-credentials \"Permanent link\")\n\nCredentials are securely stored authentication information used to connect n8n workflows to external services such as APIs, or databases.\n\n## Create a credential[#](#create-a-credential \"Permanent link\")\n\n1. Select the  **button** in the upper-left corner of the side menu. Select credential.\n2. If your n8n instance supports [projects](https://docs.n8n.io/glossary/#project-n8n), you'll also need to choose whether to create the credential inside your personal space or a specific project you have access to. If you're using the community version, you'll create the credential inside your personal space.\n3. Select the app or service you wish to connect to.\n\nOr:\n\n1. Using the  **Create** button in the upper-right corner from either the **Overview** page or a specific project. Select Credential.\n2. If you're doing this from the **Overview** page, you'll create the credential inside your personal space. If you're doing this from inside a project, you'll create the credential inside that specific project.\n3. Select the app or service you wish to connect to.\n\nYou can also create new credential in the credential drop down when editing a node on the workflow editor.\n\nOnce in the credential modal, enter the details required by your service. Refer to your service's page in the [credentials library](https://docs.n8n.io/integrations/builtin/credentials/) for guidance.\n\nWhen you save a credential, n8n tests it to confirm it works.\n\nCredentials naming\n\nn8n names new credentials \"_node name_ account\" by default. You can rename the credentials by clicking on the name, similarly to renaming nodes. It's good practice to give them names that identify the app or service, type, and purpose of the credential. A naming convention makes it easier to keep track of and identify your credentials.\n\n## Expressions in credentials[#](#expressions-in-credentials \"Permanent link\")\n\nYou can use [expressions](https://docs.n8n.io/glossary/#expression-n8n) to set credentials dynamically as your workflow runs:\n\n1. In your workflow, find the data path containing the credential. This varies depending on the exact parameter names in your data. Make sure that the data containing the credential is available in the workflow when you get to the node that needs it.\n2. When creating your credential, hover over the field where you want to use an expression.\n3. Toggle **Expression** on.\n4. Enter your expression.\n\n### Example workflow[#](#example-workflow \"Permanent link\")\n\n#### Using the example[#](#using-the-example \"Permanent link\")\n\nTo load the template into your n8n instance:\n\n1. Download the workflow JSON file.\n2. Open a new workflow in your n8n instance.\n3. Copy in the JSON, or select **Workflow menu**  > **Import from file...**.\n\nThe example workflows use Sticky Notes to guide you:\n\n* Yellow: notes and information.\n* Green: instructions to run the workflow.\n* Orange: you need to change something to make the workflow work.\n* Blue: draws attention to a key feature of the example."
},
{
"url": "https://docs.n8n.io/user-management/",
"markdown": "# User management | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/index.md \"Edit this page\")\n\nUser management in n8n allows you to invite people to work in your n8n instance. It includes:\n\n* Login and password management\n* Adding and removing users\n* Three [account types](https://docs.n8n.io/user-management/account-types/): **Owner** and **Member** (and **Admin** for Pro & Enterprise plans)\n\nPrivacy\n\nThe user management feature doesn't send personal information, such as email or username, to n8n.\n\n## Setup guides[#](#setup-guides \"Permanent link\")\n\nThis section contains most usage information for user management, and the [Cloud setup guide](https://docs.n8n.io/user-management/cloud-setup/). If you self-host n8n, there are extra steps to configure your n8n instance. Refer to the [Self-hosted guide](https://docs.n8n.io/hosting/configuration/user-management-self-hosted/).\n\nThis section includes guides to configuring [LDAP](https://docs.n8n.io/user-management/ldap/) and [SAML](https://docs.n8n.io/user-management/saml/) in n8n."
},
{
"url": "https://docs.n8n.io/user-management/cloud-setup/",
"markdown": "# Cloud setup | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/cloud-setup.md \"Edit this page\")\n\n## Set up user management on n8n Cloud[#](#set-up-user-management-on-n8n-cloud \"Permanent link\")\n\nTo access user management, upgrade to version 0.195.0 or newer.\n\nIrreversible upgrade\n\nOnce you upgrade your Cloud instance to an n8n version with user management, you can't downgrade your version.\n\n## Step one: In-app setup[#](#step-one-in-app-setup \"Permanent link\")\n\nWhen you set up user management for the first time, you create an owner account.\n\n1. Open n8n. The app displays a signup screen.\n2. Enter your details. Your password must be at least eight characters, including at least one number and one capital letter.\n3. Click **Next**. n8n logs you in with your new owner account.\n\n## Step two: Invite users[#](#step-two-invite-users \"Permanent link\")\n\nYou can now invite other people to your n8n instance.\n\n1. Sign into your workspace with your owner account. (If you are in the Admin Panel open your **Workspace** from the Dashboard)\n2. Click the three dots next to your user icon at the bottom left and click **Settings**. n8n opens your **Personal settings** page.\n3. Click **Users** to go to the **Users** page.\n4. Click **Invite**.\n5. Enter the new user's email address.\n6. Click **Invite user**. n8n sends an email with a link for the new user to join."
},
{
"url": "https://docs.n8n.io/user-management/rbac/role-types/",
"markdown": "# RBAC role types | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/rbac/role-types.md \"Edit this page\")\n\nFeature availability\n\n* The Project Editor role is available on Pro Cloud and Self-hosted Enterprise plans.\n* The Project Viewer role is only available on Self-hosted Enterprise and Cloud Enterprise plans.\n\nWithin projects, there are three user roles: Admin, Editor, and Viewer. These roles control what the user can do in a project. A user can have different roles within different projects.\n\n## Project Admin[#](#project-admin \"Permanent link\")\n\nA Project Admin role has the highest level of permissions. Project admins can:\n\n* Manage project settings: Change name, delete project.\n* Manage project members: Invite members and remove members, change members' roles.\n* View, create, update, and delete any workflows, credentials, or executions within a project.\n\n## Project Editor[#](#project-editor \"Permanent link\")\n\nA Project Editor can view, create, update, and delete any workflows, credentials, or executions within a project.\n\n## Project Viewer[#](#project-viewer \"Permanent link\")\n\nA Project Viewer is effectively a `read-only` role with access to all workflows, credentials, and executions within a project.\n\nViewers aren't able to manually execute any workflows that exist in a project.\n\nRole types and account types\n\nRole types and [account types](https://docs.n8n.io/user-management/account-types/) are different things. Every account has one type. The account can have different role types for different [projects](https://docs.n8n.io/user-management/rbac/projects/).\n\n| Permission | Admin | Editor | Viewer |\n| --- | --- | --- | --- |\n| View workflows in the project | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") |\n| View credentials in the project | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") |\n| View executions | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") |\n| Edit credentials and workflows | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Add workflows and credentials | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Execute workflows | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Manage members | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Modify the project | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n\n[Variables](https://docs.n8n.io/code/variables/) and [tags](https://docs.n8n.io/workflows/tags/) aren't affected by RBAC: they're global across the n8n instance."
},
{
"url": "https://docs.n8n.io/user-management/rbac/",
"markdown": "# Role-based access control (RBAC) | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/rbac/index.md \"Edit this page\")\n\nFeature availability\n\nRBAC is available on all plans except the Community edition. Different plans have different numbers of projects and roles. Refer to n8n's [pricing page](https://n8n.io/pricing/) for plan details.\n\nRole types and account types\n\nRole types and [account types](https://docs.n8n.io/user-management/account-types/) are different things. Every account has one type. The account can have different role types for different [projects](https://docs.n8n.io/user-management/rbac/projects/).\n\nRBAC is a way of managing access to workflows and [credentials](https://docs.n8n.io/glossary/#credential-n8n) based on user roles and projects. You group workflows into projects, and user access depends on the user's project role. This section provides guidance on using RBAC in n8n.\n\n* [Role types](https://docs.n8n.io/user-management/rbac/role-types/)\n* [Projects](https://docs.n8n.io/user-management/rbac/projects/)"
},
{
"url": "https://docs.n8n.io/user-management/account-types/",
"markdown": "# Account types | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/account-types.md \"Edit this page\")\n\nThere are three account types: owner, admin, and member. The account type affects the user permissions and access.\n\nFeature availability\n\nTo use admin accounts, you need a pro or enterprise plan.\n\nAccount types and role types\n\nAccount types and role types are different things. Role types are part of [RBAC](https://docs.n8n.io/user-management/rbac/).\n\nEvery account has one type. The account can have different [role types](https://docs.n8n.io/user-management/rbac/role-types/) for different [projects](https://docs.n8n.io/user-management/rbac/projects/).\n\nCreate a member-level account for the owner\n\nn8n recommends that owners create a member-level account for themselves. Owners can see and edit all workflows, credentials, and projects. However, there is no way to see who created a particular workflow, so there is a risk of overriding other people's work if you build and edit workflows as an owner.\n\n| Permission | Owner | Admin | Member |\n| --- | --- | --- | --- |\n| Manage own email and password | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") |\n| Manage own workflows | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") |\n| View, create, and use tags | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") |\n| Delete tags | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| View and share all workflows | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| View, edit, and share all credentials | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Set up and use [Source control](https://docs.n8n.io/source-control-environments/) | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Create [projects](https://docs.n8n.io/user-management/rbac/projects/) | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| View all projects | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Add and remove users | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |\n| Access the Cloud dashboard | ![✅](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/2705.svg \":white_check_mark:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") | ![❌](https://cdn.jsdelivr.net/gh/jdecked/twemoji@15.1.0/assets/svg/274c.svg \":x:\") |"
},
{
"url": "https://docs.n8n.io/user-management/rbac/projects/",
"markdown": "# RBAC projects | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/rbac/projects.md \"Edit this page\")\n\nFeature availability\n\nRBAC is available on all plans except the Community edition. Different plans have different numbers of projects and roles. Refer to n8n's [pricing page](https://n8n.io/pricing/) for plan details.\n\nn8n uses projects to group workflows and [credentials](https://docs.n8n.io/glossary/#credential-n8n), and assigns [roles](https://docs.n8n.io/user-management/rbac/role-types/) to users in each project. This means that a single user can have different roles in different projects, giving them different levels of access.\n\n## Create a project[#](#create-a-project \"Permanent link\")\n\nInstance owners and instance admins can create projects.\n\nTo create a project:\n\n1. Select  **Add project**.\n2. Fill out the project settings.\n3. Select **Save**.\n\n## Add and remove users in a project[#](#add-and-remove-users-in-a-project \"Permanent link\")\n\nProject admins can add and remove users.\n\nTo add a user to a project:\n\n1. Select the project.\n2. Select **Project settings**.\n3. Under **Project members**, browse for users or search by username or email address.\n4. Select the user you want to add.\n5. Check the [role type](https://docs.n8n.io/user-management/rbac/role-types/) and change it if needed.\n6. Select **Save**.\n\nTo remove a user from a project:\n\n1. Select the project.\n2. Select **Project settings**.\n3. In the role type dropdown for the user you want to remove, select **Remove access**.\n4. Select **Save**.\n\n## Delete a project[#](#delete-a-project \"Permanent link\")\n\nTo delete a project:\n\n1. Select the project.\n2. Select **Project settings**.\n3. Select **Delete project**.\n4. Choose what to do with the workflows and credentials. You can select:\n * **Transfer its workflows and credentials to another project**: n8n prompts you to choose a project to move the data to.\n * **Delete its workflows and credentials**: n8n prompts you to confirm that you want to delete all the data in the project.\n\n## Move workflows and credentials between projects or users[#](#move-workflows-and-credentials-between-projects-or-users \"Permanent link\")\n\nWorkflow and credential owners can move workflows or credentials (changing ownership) to other users or projects they have access to.\n\nMoving revokes sharing\n\nMoving workflows or credentials removes all existing sharing. Be aware that this could impact other workflows currently sharing these resources.\n\n1. Select **Workflow menu**  or **Credential menu**  > **Move**.\n \n Moving workflows with credentials\n \n When moving a workflow with credentials you have permission to share, you can choose to share the credentials as well. This ensures that the workflow continues to have access to the credentials it needs to execute. n8n will note any credentials that can't be moved (credentials you don't have permission to share).\n \n2. Select the project or user you want to move to.\n \n3. Select **Next**.\n4. Confirm you understand the impact of the move: workflows may stop working if the credentials they need aren't available in the target project, and n8n removes any current individual sharing.\n5. Select **Confirm move to new project**.\n\n## Using external secrets in projects[#](#using-external-secrets-in-projects \"Permanent link\")\n\nTo use [external secrets](https://docs.n8n.io/external-secrets/) in a project, you must have an [instance owner or instance admin](https://docs.n8n.io/user-management/account-types/) as a member of the project."
},
{
"url": "https://docs.n8n.io/user-management/best-practices/",
"markdown": "# Best practices | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/best-practices.md \"Edit this page\")\n\n## Best practices for user management[#](#best-practices-for-user-management \"Permanent link\")\n\nThis page contains advice on best practices relating to user management in n8n.\n\n## All platforms[#](#all-platforms \"Permanent link\")\n\n* n8n recommends that owners create a member-level account for themselves. Owners can see all workflows, but there is no way to see who created a particular workflow, so there is a risk of overriding other people's work if you build and edit workflows as an owner.\n* Users must be careful not to edit the same workflow simultaneously. It's possible to do it, but the users will overwrite each other's changes.\n* To move workflows between accounts, export the workflow as JSON, then import it to the new account. Note that this action loses the workflow history.\n* Webhook paths must be unique across the entire instance. This means each webhook path must be unique for all workflows and all users. By default, n8n generates a long random value for the webhook path, but users can edit this to their own custom path. If two users set the same path value:\n * The path works for the first workflow that's run or activated.\n * Other workflows will error if they try to run with the same path.\n\n## Self-hosted[#](#self-hosted \"Permanent link\")\n\nIf you run n8n behind a reverse proxy, set the following environment variables so that n8n generates emails with the correct URL:\n\n* `N8N_HOST`\n* `N8N_PORT`\n* `N8N_PROTOCOL`\n* `N8N_EDITOR_BASE_URL`\n\nMore information on these variables is available in [Environment variables](https://docs.n8n.io/hosting/configuration/environment-variables/)."
},
{
"url": "https://docs.n8n.io/user-management/two-factor-auth/",
"markdown": "# 2FA | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/two-factor-auth.md \"Edit this page\")\n\n## Two-factor authentication (2FA)[#](#two-factor-authentication-2fa \"Permanent link\")\n\nTwo-factor authentication (2FA) adds a second authentication method on top of username and password. This increases account security. n8n supports 2FA using an authenticator app.\n\n## Enable 2FA[#](#enable-2fa \"Permanent link\")\n\nYou need an authenticator app on your phone.\n\nTo enable 2FA in n8n:\n\n1. Go to you **Settings** > **Personal**.\n2. Select **Enable 2FA**. n8n opens a modal with a QR code.\n3. Scan the QR code in your authenticator app.\n4. Enter the code from your app in **Code from authenticator app**.\n5. Select **Continue**. n8n displays recovery codes.\n6. Save the recovery codes. You need these to regain access to your account if you lose your authenticator.\n\n## Disable 2FA for your instance[#](#disable-2fa-for-your-instance \"Permanent link\")\n\nSelf-hosted users can configure their n8n instance to disable 2FA for all users by setting `N8N_MFA_ENABLED` to false. Note that n8n ignores this if existing users have 2FA enabled. Refer to [Configuration methods](https://docs.n8n.io/hosting/configuration/configuration-methods/) for more information on configuring your n8n instance with environment variables."
},
{
"url": "https://docs.n8n.io/user-management/ldap/",
"markdown": "# LDAP | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/ldap.md \"Edit this page\")\n\n## Lightweight Directory Access Protocol (LDAP)[#](#lightweight-directory-access-protocol-ldap \"Permanent link\")\n\nFeature availability\n\n* Available on Self-hosted Enterprise and Cloud Enterprise plans.\n* You need access to the n8n instance owner account.\n\nThis page tells you how to enable LDAP in n8n. It assumes you're familiar with LDAP, and have an existing LDAP server set up.\n\nLDAP allows users to sign in to n8n with their organization credentials, instead of an n8n login.\n\n## Enable LDAP[#](#enable-ldap \"Permanent link\")\n\n1. Log in to n8n as the instance owner.\n2. Select **Settings**  > **LDAP**.\n3. Toggle on **Enable LDAP Login**.\n4. Complete the fields with details from your LDAP server.\n5. Select **Test connection** to check your connection setup, or **Save connection** to create the connection.\n\nAfter enabling LDAP, anyone on your LDAP server can sign in to the n8n instance, unless you exclude them using the **User Filter** setting.\n\nYou can still create non-LDAP users (email users) on the **Settings** > **Users** page.\n\n## Merging n8n and LDAP accounts[#](#merging-n8n-and-ldap-accounts \"Permanent link\")\n\nIf n8n finds matching accounts (matching emails) for email users and LDAP users, the user must sign in with their LDAP account. n8n instance owner accounts are excluded from this: n8n never converts owner accounts to LDAP users.\n\n## LDAP user accounts in n8n[#](#ldap-user-accounts-in-n8n \"Permanent link\")\n\nOn first sign in, n8n creates a user account in n8n for the LDAP user.\n\nYou must manage user details on the LDAP server, not in n8n. If you update or delete a user on your LDAP server, the n8n account updates at the next scheduled sync, or when the user next tries to log in, whichever happens first.\n\nUser deletion\n\nIf you remove a user from your LDAP server, they lose n8n access on the next sync.\n\n## Turn LDAP off[#](#turn-ldap-off \"Permanent link\")\n\nTo turn LDAP off:\n\n1. Log in to n8n as the instance owner.\n2. Select **Settings**  > **LDAP**.\n3. Toggle off **Enable LDAP Login**.\n\nIf you turn LDAP off, n8n converts existing LDAP users to email users on their next login. The users must reset their password."
},
{
"url": "https://docs.n8n.io/user-management/saml/",
"markdown": "# Security Assertion Markup Language (SAML)\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/saml/index.md \"Edit this page\")\n\nFeature availability\n\n* Available on Enterprise plans.\n* You need access to the n8n instance owner account to enable and configure SAML\n\nAvailable from version 0.225.0.\n\nThis section provides guidance on using SAML SSO (single sign-on) with n8n. It assumes you're familiar with SAML. If you're not, [SAML Explained in Plain English](https://www.onelogin.com/learn/saml) can help you understand how SAML works, and its benefits.\n\n* [Set up SAML](https://docs.n8n.io/user-management/saml/setup/): a general guide to setting up SAML in n8n, and links to resources for common IdPs. Start here.\n* [Okta Workforce Identity SAML setup](https://docs.n8n.io/user-management/saml/okta/): step-by-step guidance to configuring Okta.\n* [Troubleshooting](https://docs.n8n.io/user-management/saml/troubleshooting/): a list of things to check if you encounter issues.\n* [Managing users with SAML](https://docs.n8n.io/user-management/saml/managing/): performing user management tasks with SAML enabled."
},
{
"url": "https://docs.n8n.io/user-management/manage-users/",
"markdown": "# Manage users | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/manage-users.md \"Edit this page\")\n\nThe **Settings** > **Users** page shows all users, including ones with pending invitations.\n\n## Delete a user[#](#delete-a-user \"Permanent link\")\n\n1. Select the menu icon by the user you want to delete.\n2. Confirm you want to delete them.\n3. If they're an active user, choose whether to copy their workflow data and credentials to a new user, or permanently delete their workflows and credentials.\n\n## Resend an invitation to a pending user[#](#resend-an-invitation-to-a-pending-user \"Permanent link\")\n\nClick the menu icon by the user, then click **Resend invite**."
},
{
"url": "https://docs.n8n.io/learning-path/",
"markdown": "# Learning path | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/learning-path.md \"Edit this page\")\n\nThis guide outlines a series of tutorials and resources designed to get you started with n8n.\n\nIt's not necessary to complete all items listed to start using n8n. Use this as a reference to navigate to the most relevant parts of the documentation and other resources according to your needs.\n\nn8n has an active community where you can get and offer help. Connect, share, and learn with other n8n users:\n\n* [Ask questions](https://community.n8n.io/t/readme-welcome-to-the-n8n-community/44381) and [make feature requests](https://community.n8n.io/c/feature-requests) in the Community Forum.\n* [Report bugs](https://github.com/n8n-io/n8n/issues) and [contribute](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md) on GitHub.\n\n## Set up your n8n[#](#set-up-your-n8n \"Permanent link\")\n\nIf you don't have an account yet, sign up to a [free trial on n8n Cloud](https://app.n8n.cloud/register) or install n8n's community edition with [Docker](https://docs.n8n.io/hosting/installation/docker/) (recommended) or [npm](https://docs.n8n.io/hosting/installation/npm/). See [Choose your n8n](https://docs.n8n.io/choose-n8n/) for more details.\n\n## Try it out[#](#try-it-out \"Permanent link\")\n\nStart with the quickstart guides to help you get up and running with building basic workflows.\n\n* [A very quick quickstart](https://docs.n8n.io/try-it-out/quickstart/)\n* [A longer introduction](https://docs.n8n.io/try-it-out/tutorial-first-workflow/)\n* [Build an AI workflow in n8n](https://docs.n8n.io/advanced-ai/intro-tutorial/)\n\n## Structured Courses[#](#structured-courses \"Permanent link\")\n\nn8n offers two sets of courses.\n\n### Video courses[#](#video-courses \"Permanent link\")\n\nLearn key concepts and n8n features, while building examples as you go.\n\n* The [Beginner](https://www.youtube.com/playlist?list=PLlET0GsrLUL59YbxstZE71WszP3pVnZfI) course covers the basics of n8n.\n* The [Advanced](https://www.youtube.com/playlist?list=PLlET0GsrLUL5bxmx5c1H1Ms_OtOPYZIEG) course covers more complex workflows, more technical nodes, and enterprise features\n\n### Text courses[#](#text-courses \"Permanent link\")\n\nBuild more complex workflows while learning key concepts along the way. Earn a badge and an avatar in your community profile.\n\n* [Level 1: Beginner Course](https://blog.n8n.io/announcing-the-n8n-certification-course-for-beginners-level-1/)\n* [Level 2: Intermediate Course](https://blog.n8n.io/announcing-course-level-two/)\n\n## Self-hosting n8n[#](#self-hosting-n8n \"Permanent link\")\n\nExplore various [self-hosting options in n8n](https://docs.n8n.io/hosting/). If you’re not sure where to start, these are two popular options:\n\n* [Hosting n8n on DigitalOcean](https://docs.n8n.io/hosting/installation/server-setups/digital-ocean/)\n* [Hosting n8n on Amazon Web Services](https://docs.n8n.io/hosting/installation/server-setups/aws/)\n\n## Build a node[#](#build-a-node \"Permanent link\")\n\nIf you can't find a node for a specific app or a service, you can build a node yourself and share with the community. See what others have built on [npm website](https://www.npmjs.com/search?q=keywords:n8n-community-node-package).\n\n* [Build a declarative-style node](https://docs.n8n.io/integrations/creating-nodes/build/declarative-style-node/)\n* [Learn how to build your own n8n nodes (Youtube Video)](https://www.youtube.com/live/OI6zHJ56eW0?si=SMD7L1J5fZ2mf79W)\n\n## Stay updated[#](#stay-updated \"Permanent link\")\n\n* Follow new features and bug fixes in the [Release Notes](https://docs.n8n.io/release-notes/)\n* Follow n8n on socials: [Twitter/X](https://twitter.com/n8n_io), [Discord](https://discord.com/invite/vWwMVThRta), [LinkedIn](https://www.linkedin.com/company/n8n/), [YouTube](https://www.youtube.com/@n8n-io)"
},
{
"url": "https://docs.n8n.io/user-management/saml/okta/",
"markdown": "# Okta Workforce Identity SAML setup\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/saml/okta.md \"Edit this page\")\n\nSet up SAML SSO in n8n with Okta.\n\nWorkforce Identity and Customer Identity\n\nThis guide covers setting up Workforce Identity. This is the original Okta product. Customer Identity is Okta's name for Auth0, which they've acquired.\n\n## Prerequisites[#](#prerequisites \"Permanent link\")\n\nYou need an Okta Workforce Identity account, and the redirect URL and entity ID from n8n's SAML settings.\n\nOkta Workforce may enforce two factor authentication for users, depending on your Okta configuration.\n\nRead the [Set up SAML](https://docs.n8n.io/user-management/saml/setup/) guide first.\n\n## Setup[#](#setup \"Permanent link\")\n\n1. In your Okta admin panel, select **Applications** > **Applications**.\n2. Select **Create App Integration**. Okta opens the app creation modal.\n3. Select **SAML 2.0**, then select **Next**.\n4. On the **General Settings** tab, enter `n8n` as the **App name**.\n5. Select **Next** .\n6. On the **Configure SAML** tab, complete the following **General** fields:\n * **Single sign-on URL**: the **Redirect URL** from n8n.\n * **Audience URI (SP Entity ID)**: the **Entity ID** from n8n.\n * **Default RelayState**: leave this empty.\n * **Name ID format**: `EmailAddress`.\n * **Application username**: `Okta username`.\n * **Update application username on**: `Create and update`.\n7. Create **Attribute Statements**:\n \n | **Name** | **Name format** | **Value** |\n | --- | --- | --- |\n | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/firstname | URI Reference | user.firstName |\n | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/lastname | URI Reference | user.lastName |\n | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn | URI Reference | user.login |\n | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress | URI Reference | user.email |\n \n8. Select **Next**. Okta may prompt you to complete a marketing form, or may take you directly to your new n8n Okta app.\n \n9. Assign the n8n app to people:\n 1. On the n8n app dashboard in Okta, select **Assignments**.\n 2. Select **Assign** > **Assign to People**. Okta displays a modal with a list of available people.\n 3. Select **Assign** next to the person you want to add. Okta displays a prompt to confirm the username.\n 4. Leave the username as email address. Select **Save and Go Back**.\n 5. Select **Done**.\n10. Get the metadata XML: on the **Sign On** tab, copy the Metadata URL. Navigate to it, and copy the XML. Paste this into **Identity Provider Settings** in n8n.\n11. Select **Save settings**.\n12. Select **Test settings**. n8n opens a new tab. If you're not currently logged in, Okta prompts you to sign in. n8n then displays a success message confirming the attributes returned by Okta."
},
{
"url": "https://docs.n8n.io/integrations/",
"markdown": "# n8n Integrations Documentation and Guides\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/index.md \"Edit this page\")\n\nn8n calls integrations nodes.\n\nNodes are the building blocks of workflows in n8n. They're an entry point for retrieving data, a function to process data, or an exit for sending data. The data process includes filtering, recomposing, and changing data. There can be one or several nodes for your API, service or app. You can connect multiple nodes, which allows you to create complex workflows.\n\n## Built-in nodes[#](#built-in-nodes \"Permanent link\")\n\nn8n includes a collection of built-in integrations. Refer to [Built-in nodes](https://docs.n8n.io/integrations/builtin/node-types/) for documentation on all n8n's built-in nodes.\n\nAs well as using the built-in nodes, you can also install community-built nodes. Refer to [Community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) for more information.\n\n## Credential-only nodes and custom operations[#](#credential-only-nodes-and-custom-operations \"Permanent link\")\n\nOne of the most complex parts of setting up [API](https://docs.n8n.io/glossary/#api) calls is managing authentication. n8n provides [credentials](https://docs.n8n.io/glossary/#credential-n8n) support for operations and services beyond those supported by built-in nodes.\n\n* Custom operations for existing nodes: n8n supplies hundreds of nodes to create workflows that link multiple products. However, some nodes don't include all the possible operations supported by a product's API. You can work around this by making a custom API call using the [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node.\n* Credential-only nodes: n8n includes credential-only nodes. These are integrations where n8n supports setting up credentials for use in the HTTP Request node, but doesn't provide a standalone node. You can find a credential-only node in the nodes panel, as you would for any other integration.\n\nRefer to [Custom operations](https://docs.n8n.io/integrations/custom-operations/) for more information.\n\n## Generic integrations[#](#generic-integrations \"Permanent link\")\n\nIf you need to connect to a service where n8n doesn't have a node, or a credential-only node, you can still use the [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node. Refer to the node page for details on how to set up authentication and create your API call.\n\n## Where to go next[#](#where-to-go-next \"Permanent link\")\n\n* If you want to create your own node, head over to the [Creating Nodes](https://docs.n8n.io/integrations/creating-nodes/overview/) section.\n* Check out [Community nodes](https://docs.n8n.io/integrations/community-nodes/usage/) to learn about installing and managing community-built nodes.\n* If you'd like to learn more about the different nodes in n8n, their functionalities and example usage, check out n8n's node libraries: [Core nodes](https://docs.n8n.io/integrations/builtin/core-nodes/), [Actions](https://docs.n8n.io/integrations/builtin/app-nodes/), and [Triggers](https://docs.n8n.io/integrations/builtin/trigger-nodes/).\n* If you'd like to learn how to add the credentials for the different nodes, head over to the [Credentials](https://docs.n8n.io/integrations/builtin/credentials/) section."
},
{
"url": "https://docs.n8n.io/user-management/saml/setup/",
"markdown": "# Set up SAML | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/saml/setup.md \"Edit this page\")\n\nFeature availability\n\n* Available on Enterprise plans.\n* You need access to the n8n instance owner account to enable and configure SAML\n\nAvailable from version 0.225.0.\n\nThis page tells you how to enable SAML SSO (single sign-on) in n8n. It assumes you're familiar with SAML. If you're not, [SAML Explained in Plain English](https://www.onelogin.com/learn/saml) can help you understand how SAML works, and its benefits.\n\n## Enable SAML[#](#enable-saml \"Permanent link\")\n\n1. In n8n, go to **Settings** > **SSO**.\n2. Make a note of the n8n **Redirect URL** and **Entity ID**.\n 1. **Optional**: if your IdP allows you to set up SAML from imported metadata, navigate to the **Entity ID** URL and save the XML.\n 2. **Optional**: if you are running n8n behind a load balancer make sure you have `N8N_EDITOR_BASE_URL` configured.\n3. Set up SAML with your IdP (identity provider). You need the redirect URL and entity ID. You may also need an email address and name for the IdP user.\n4. After completing setup in your IdP, load the metadata XML into n8n. You can use a metadata URL or raw XML:\n 1. **Metadata URL**: Copy the metadata URL from your IdP into the **Identity Provider Settings** field in n8n.\n 2. **Raw XML**: Download the metadata XML from your IdP, toggle **Identiy Provider Settings** to **XML**, then copy the raw XML into **Identity Provider Settings**.\n5. Select **Save settings**.\n6. Select **Test settings** to check your SAML setup is working.\n7. Set SAML 2.0 to **Activated**.\n\nSAML Request Type\n\nPlease note, n8n currently doesn't support `POST` binding. Please configure your IdP to use `HTTP` request binding instead.\n\n## Generic IdP setup[#](#generic-idp-setup \"Permanent link\")\n\nThe steps to configure the IdP vary depending on your chosen IdP. These are some common setup tasks:\n\n* Create an app for n8n in your IdP.\n* Map n8n attributes to IdP attributes:\n \n\n## Setup resources for common IdPs[#](#setup-resources-for-common-idps \"Permanent link\")\n\nDocumentation links for common IdPs."
},
{
"url": "https://docs.n8n.io/advanced-ai/",
"markdown": "# n8n Advanced AI Documentation and Guides\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/advanced-ai/index.md \"Edit this page\")\n\nBuild AI functionality using n8n: from creating your own chat bot, to using AI to process documents and data from other sources.\n\nFeature availability\n\nThis feature is available on Cloud and self-hosted n8n, in version 1.19.4 and above.\n\n* **Get started**\n \n Work through the short tutorial to learn the basics of building AI workflows in n8n.\n \n [Tutorial](https://docs.n8n.io/advanced-ai/intro-tutorial/)\n \n* **Use a Starter Kit**\n \n Try n8n's Self-hosted AI Starter Kit to quickly start building AI workflows.\n \n [Self-hosted AI Starter Kit](https://docs.n8n.io/hosting/starter-kits/ai-starter-kit/)\n \n* **Explore examples and concepts**\n \n Browse examples and workflow templates to help you build. Includes explanations of important AI concepts.\n \n [Examples](https://docs.n8n.io/advanced-ai/examples/introduction/)\n \n* **How n8n uses LangChain**\n \n Learn more about how n8n builds on LangChain.\n \n [LangChain in n8n](https://docs.n8n.io/advanced-ai/langchain/overview/)\n \n* **Browse AI templates**\n \n Explore a wide range of AI workflow templates on the n8n website.\n \n [AI workflows on n8n.io](https://n8n.io/workflows/?categories=25)\n \n\nRelated documentation and tools.\n\n### Node types[#](#node-types \"Permanent link\")\n\nThis feature uses [Cluster nodes](https://docs.n8n.io/integrations/builtin/cluster-nodes/): groups of [root](https://docs.n8n.io/integrations/builtin/cluster-nodes/root-nodes/) and [sub](https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/) nodes that work together.\n\n[Cluster nodes](https://docs.n8n.io/glossary/#cluster-node-n8n) are node groups that work together to provide functionality in an n8n workflow. Instead of using a single node, you use a [root node](https://docs.n8n.io/glossary/#root-node-n8n) and one or more [sub-nodes](https://docs.n8n.io/glossary/#sub-node-n8n) that extend the functionality of the node.\n\n\n\n### Workflow templates[#](#workflow-templates \"Permanent link\")\n\nYou can browse [workflow templates](https://docs.n8n.io/glossary/#template-n8n) in-app or on the n8n website [Workflows](https://n8n.io/workflows/?categories=25,26) page.\n\nRefer to [Templates](https://docs.n8n.io/workflows/templates/) for information on accessing templates in-app.\n\n### Chat trigger[#](#chat-trigger \"Permanent link\")\n\nUse the [n8n Chat Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/) to trigger a workflow based on chat interactions.\n\n### Chatbot widget[#](#chatbot-widget \"Permanent link\")\n\nn8n provides a chatbot widget that you can use as a frontend for AI-powered chat workflows. Refer to the [@n8n/chat npm page](https://www.npmjs.com/package/@n8n/chat) for usage information."
},
{
"url": "https://docs.n8n.io/code/",
"markdown": "# Code in n8n Documentation and Guides\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/code/index.md \"Edit this page\")\n\nn8n is a low-code tool. This means you can do a lot without code, then add code when needed.\n\n## Code in your workflows[#](#code-in-your-workflows \"Permanent link\")\n\nThere are two places in your workflows where you can use code:\n\n* **Expressions**\n \n Use [expressions](https://docs.n8n.io/glossary/#expression-n8n) to transform [data](https://docs.n8n.io/data/) in your nodes. You can use JavaScript in expressions, as well as n8n's [Built-in methods and variables](https://docs.n8n.io/code/builtin/overview/) and [Data transformation functions](https://docs.n8n.io/code/builtin/data-transformation-functions/).\n \n [Expressions](https://docs.n8n.io/code/expressions/)\n \n* **Code node**\n \n Use the Code node to add JavaScript or Python to your workflow.\n \n [Code node](https://docs.n8n.io/code/code-node/)\n \n\n## Other technical resources[#](#other-technical-resources \"Permanent link\")\n\nThese are features that are relevant to technical users.\n\n### Technical nodes[#](#technical-nodes \"Permanent link\")\n\nn8n provides core nodes, which simplify adding key functionality such as API requests, webhooks, scheduling, and file handling.\n\n* **Write a backend**\n \n The [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/), [Webhook](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.webhook/), and [Code](https://docs.n8n.io/code/code-node/) nodes help you make API calls, respond to webhooks, and write any JavaScript in your workflow.\n \n Use this do things like [Create an API endpoint](https://n8n.io/workflows/1750-creating-an-api-endpoint/).\n \n [Core nodes](https://docs.n8n.io/integrations/builtin/core-nodes/)\n \n* **Represent complex logic**\n \n You can build complex flows, using nodes like [If](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/), [Switch](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.switch/), and [Merge](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/) nodes.\n \n [Flow logic](https://docs.n8n.io/flow-logic/)\n \n\n### Other developer resources[#](#other-developer-resources \"Permanent link\")\n\n* **The n8n API**\n \n n8n provides an API, where you can programmatically perform many of the same tasks as you can in the GUI. There's an [n8n API node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.n8n/) to access the API in your workflows.\n \n [API](https://docs.n8n.io/api/)\n \n* **Self-host**\n \n You can self-host n8n. This keeps your data on your own infrastructure.\n \n [Hosting](https://docs.n8n.io/hosting/)\n \n* **Build your own nodes**\n \n You can build custom nodes, install them on your n8n instance, and publish them to [npm](https://www.npmjs.com/).\n \n [Creating nodes](https://docs.n8n.io/integrations/creating-nodes/overview/)"
},
{
"url": "https://docs.n8n.io/hosting/",
"markdown": "# n8n Hosting Documentation and Guides\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/hosting/index.md \"Edit this page\")\n\n## Self-hosting n8n[#](#self-hosting-n8n \"Permanent link\")\n\nThis section provides guidance on setting up n8n for both the Enterprise and Community self-hosted editions. The Community edition is free, the Enterprise edition isn't.\n\nSee [Community edition features](https://docs.n8n.io/hosting/community-edition-features/) for a list of available features.\n\n* **Installation and server setups**\n \n Install n8n on any platform using npm or Docker. Or follow our guides to popular hosting platforms.\n \n [Docker installation guide](https://docs.n8n.io/hosting/installation/docker/)\n \n* **Configuration**\n \n Learn how to configure n8n with environment variables.\n \n [Environment Variables](https://docs.n8n.io/hosting/configuration/environment-variables/)\n \n* **Users and authentication**\n \n Choose and set up user authentication for your n8n instance.\n \n [Authentication](https://docs.n8n.io/hosting/configuration/user-management-self-hosted/)\n \n* **Scaling**\n \n Manage data, modes, and processes to keep n8n running smoothly at scale.\n \n [Scaling](https://docs.n8n.io/hosting/scaling/queue-mode/)\n \n* **Securing n8n**\n \n Secure your n8n instance by setting up SSL, SSO, or 2FA or blocking or opting out of some data collection or features.\n \n [Securing n8n guide](https://docs.n8n.io/hosting/securing/overview/)\n \n* **Starter kits**\n \n New to n8n or AI? Try our Self-hosted AI Starter Kit. Curated by n8n, it combines the self-hosted n8n platform with compatible AI products and components to get you started building self-hosted AI workflows.\n \n [Starter kits](https://docs.n8n.io/hosting/starter-kits/ai-starter-kit/)\n \n\nSelf-hosting knowledge prerequisites\n\nSelf-hosting n8n requires technical knowledge, including:\n\n* Setting up and configuring servers and containers\n* Managing application resources and scaling\n* Securing servers and applications\n* Configuring n8n\n\nn8n recommends self-hosting for expert users. Mistakes can lead to data loss, security issues, and downtime. If you aren't experienced at managing servers, n8n recommends [n8n Cloud](https://n8n.io/cloud/)."
},
{
"url": "https://docs.n8n.io/api/",
"markdown": "# n8n public REST API Documentation and Guides\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/api/index.md \"Edit this page\")\n\nFeature availability\n\nThe n8n API isn't available during the free trial. Please upgrade to access this feature.\n\nUsing n8n's public [API](https://docs.n8n.io/glossary/#api), you can programmatically perform many of the same tasks as you can in the GUI. This section introduces n8n's REST API, including:\n\n* How to [authenticate](https://docs.n8n.io/api/authentication/)\n* [Paginating](https://docs.n8n.io/api/pagination/) results\n* Using the [built-in API playground](https://docs.n8n.io/api/using-api-playground/) (self-hosted n8n only)\n* [Endpoint reference](https://docs.n8n.io/api/api-reference/)\n\nn8n provides an [n8n API node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.n8n/) to access the API in your workflows.\n\n## Learn about REST APIs[#](#learn-about-rest-apis \"Permanent link\")\n\nThe API documentation assumes you are familiar with REST APIs. If you're not, these resources may be helpful:\n\n* [KnowledgeOwl's guide to working with APIs](https://support.knowledgeowl.com/help/working-with-apis): a basic introduction, including examples of how to call REST APIs.\n* [IBM Cloud Learn Hub - What is an Application Programming Interface (API)](https://www.ibm.com/cloud/learn/api): this gives a general, but technical, introduction to APIs.\n* [IBM Cloud Learn Hub - What is a REST API?](https://www.ibm.com/cloud/learn/rest-apis): more detailed information about REST APIs.\n* [MDN web docs - An overview of HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview): REST APIs work over HTTP and use HTTP verbs, or methods, to specify the action to perform.\n\nUse the API playground (self-hosted n8n only)\n\nTrying out the API in the [playground](https://docs.n8n.io/api/using-api-playground/) can help you understand how APIs work. If you're worried about changing live data, consider setting up a test workflow, or test n8n instance, to explore safely."
},
{
"url": "https://docs.n8n.io/choose-n8n/",
"markdown": "# Choose your n8n | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/choose-n8n.md \"Edit this page\")\n\nThis section contains information on n8n's range of platforms, pricing plans, and licenses.\n\n## Platforms[#](#platforms \"Permanent link\")\n\nThere are different ways to set up n8n depending on how you intend to use it:\n\n* [n8n Cloud](https://docs.n8n.io/manage-cloud/overview/): hosted solution, no need to install anything.\n* [Self-host](https://docs.n8n.io/hosting/): recommended method for production or customized use cases.\n * [npm](https://docs.n8n.io/hosting/installation/npm/)\n * [Docker](https://docs.n8n.io/hosting/installation/docker/)\n * [Server setup guides](https://docs.n8n.io/hosting/installation/server-setups/) for popular platforms\n* [Embed](https://docs.n8n.io/embed/): n8n Embed allows you to white label n8n and build it into your own product. Contact n8n on the [Embed website](https://n8n.io/embed/) for pricing and support.\n\nSelf-hosting knowledge prerequisites\n\nSelf-hosting n8n requires technical knowledge, including:\n\n* Setting up and configuring servers and containers\n* Managing application resources and scaling\n* Securing servers and applications\n* Configuring n8n\n\nn8n recommends self-hosting for expert users. Mistakes can lead to data loss, security issues, and downtime. If you aren't experienced at managing servers, n8n recommends [n8n Cloud](https://n8n.io/cloud/).\n\n## Licenses[#](#licenses \"Permanent link\")\n\nn8n's [Sustainable Use License](https://github.com/n8n-io/n8n/blob/master/LICENSE.md) and [n8n Enterprise License](https://github.com/n8n-io/n8n/blob/master/LICENSE_EE.md) are based on the [fair-code](https://faircode.io/) model.\n\nFor a detailed explanation of the license, refer to [Sustainable Use License](https://docs.n8n.io/sustainable-use-license/).\n\n## Free versions[#](#free-versions \"Permanent link\")\n\nn8n offers the following free options:\n\n* A free trial of Cloud\n* A free self-hosted community edition for self-hosted users\n\n## Paid versions[#](#paid-versions \"Permanent link\")\n\nn8n has two paid versions:\n\n* n8n Cloud: choose from a range of paid plans to suit your usage and feature needs.\n* Self-hosted: there are both free and paid versions of self-hosted.\n\nFor details of the Cloud plans and contact details for Enterprise Self-hosted, refer to [Pricing](https://n8n.io/pricing/) on the n8n website."
},
{
"url": "https://docs.n8n.io/embed/",
"markdown": "# n8n Embed Documentation and Guides\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/embed/index.md \"Edit this page\")\n\nn8n Embed is part of n8n's paid offering. Using Embed, you can white label n8n, or incorporate it in your software as part of your commercial product.\n\nFor more information about when to use Embed, as well as costs and licensing processes, refer to [Embed](https://n8n.io/embed/) on the n8n website.\n\n## Support[#](#support \"Permanent link\")\n\nThe [community forum](https://community.n8n.io/) can help with various issues. If you are a current Embed customer, you can also contact n8n support, using the email provided when you bought the license.\n\n## Russia and Belarus[#](#russia-and-belarus \"Permanent link\")\n\nn8n Embed isn't available in Russia and Belarus. Refer to n8n's blog post [Update on n8n cloud accounts in Russia and Belarus](https://blog.n8n.io/update-on-n8n-cloud-accounts-in-russia-and-belarus/) for more information."
},
{
"url": "https://docs.n8n.io/try-it-out/",
"markdown": "# Try it out | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/try-it-out/index.md \"Edit this page\")\n\nThe best way to learn n8n is by using our tutorials to get familiar with the user interface and the many different types of nodes and integrations available. Here is a selection of material to get you started:\n\n* Looking for a quick introduction? Check out the [\"First Workflow\" tutorial](https://docs.n8n.io/try-it-out/tutorial-first-workflow/).\n* Interested in what you could do with AI? Find out [how to build an AI chat agent with n8n](https://docs.n8n.io/advanced-ai/intro-tutorial/).\n* Prefer to work through extensive examples? Maybe the [courses](https://docs.n8n.io/courses/) are for you."
},
{
"url": "https://docs.n8n.io/try-it-out/quickstart/",
"markdown": "# A very quick quickstart | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/try-it-out/quickstart.md \"Edit this page\")\n\nThis quickstart gets you started using n8n as quickly as possible. Its allows you to try out the UI and introduces two key features: [workflow templates](https://docs.n8n.io/glossary/#template-n8n) and [expressions](https://docs.n8n.io/glossary/#expression-n8n). It doesn't include detailed explanations or explore concepts in-depth.\n\nIn this tutorial, you will:\n\n* Load a [workflow](https://docs.n8n.io/glossary/#workflow-n8n) from the workflow templates library\n* Add a node and configure it using expressions\n* Run your first workflow\n\n## Step one: Sign up for n8n[#](#step-one-sign-up-for-n8n \"Permanent link\")\n\nThis quickstart uses [n8n Cloud](https://docs.n8n.io/manage-cloud/overview/). A free trial is available for new users. If you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now.\n\n## Step two: Open a workflow template[#](#step-two-open-a-workflow-template \"Permanent link\")\n\nn8n provides a quickstart template using training nodes. You can use this to work with fake data and avoid setting up [credentials](https://docs.n8n.io/glossary/#credential-n8n).\n\n1. Go to [Templates | Very quick quickstart](https://n8n.io/workflows/1700-very-quick-quickstart/).\n2. Select **Use workflow** to view the options for using the template.\n3. Select **Import template to cloud workspace** to load the template into your Cloud instance.\n\nThis workflow:\n\n1. Gets example data from the [Customer Datastore](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.n8ntrainingcustomerdatastore/) node.\n2. Uses the [Edit Fields](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) node to extract only the desired data and assigns that data to variables. In this example, you map the customer name, ID, and description.\n\nThe individual pieces in an n8n workflow are called [nodes](https://docs.n8n.io/glossary/#node-n8n). Double click a node to explore its settings and how it processes data.\n\n## Step three: Run the workflow[#](#step-three-run-the-workflow \"Permanent link\")\n\nSelect **Execute Workflow**. This runs the workflow, loading the data from the Customer Datastore node, then transforming it with Edit Fields. You need this data available in the workflow so that you can work with it in the next step.\n\n## Step four: Add a node[#](#step-four-add-a-node \"Permanent link\")\n\nAdd a third node to message each customer and tell them their description. Use the Customer Messenger node to send a message to fake recipients.\n\n1. Select the **Add node**  connector on the Edit Fields node.\n2. Search for **Customer Messenger**. n8n shows a list of nodes that match the search.\n3. Select **Customer Messenger (n8n training)** to add the node to the [canvas](https://docs.n8n.io/glossary/#canvas-n8n). n8n opens the node automatically.\n4. Use [expressions](https://docs.n8n.io/code/expressions/) to map in the **Customer ID** and create the **Message**:\n 1. In the **INPUT** panel select the **Schema** tab.\n 2. Drag **Edit Fields1** > **customer\\_id** into the **Customer ID** field in the node settings.\n 3. Hover over **Message**. Select the **Expression** tab, then select the expand button  to open the full expressions editor.\n 4. Copy this expression into the editor:\n \n | | |\n | --- | --- |\n | | `Hi {{ $json.customer_name }}. Your description is: {{ $json.customer_description }}` |\n \n5. Close the expressions editor, then close the **Customer Messenger** node by clicking outside the node or selecting **Back to canvas**.\n6. Select **Execute Workflow**. n8n runs the workflow.\n\nThe complete workflow should look like this:\n\n## Next steps[#](#next-steps \"Permanent link\")\n\n* Read n8n's [longer try it out tutorial](https://docs.n8n.io/try-it-out/tutorial-first-workflow/) for a more complex workflow, and an introduction to more features and n8n concepts.\n* Take the [text courses](https://docs.n8n.io/courses/) or [video courses](https://docs.n8n.io/video-courses/)."
},
{
"url": "https://docs.n8n.io/video-courses/",
"markdown": "# Video courses | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/video-courses.md \"Edit this page\")\n\nn8n provides two video courses on YouTube.\n\nFor support, join the [Forum](https://community.n8n.io/).\n\n## Beginner[#](#beginner \"Permanent link\")\n\nThe [Beginner](https://www.youtube.com/playlist?list=PLlET0GsrLUL59YbxstZE71WszP3pVnZfI) course covers the basics of n8n:\n\n* [Introduction and workflows](https://youtu.be/4BVTkqbn_tY?si=g2A5eD8kAoia5k6y)\n* [APIs and Webhooks](https://youtu.be/y_cpFMF1pzk?si=zi3wM4W7nx8Jkcw3)\n* [Nodes](https://youtu.be/rCPXBkeBWCQ?si=-T2iUsydwS5ym6yI)\n* [Data in n8n](https://youtu.be/2YfWuNziPE4?si=4jB-fubG1_T0HXYx)\n* [Core workflow concepts](https://youtu.be/kkrA7tGHYNo?si=mLVbuV98ohL5YVnm)\n* [Useful nodes](https://youtu.be/Rmi-ckbMOQE?si=H_dF77uf5KJU7RtH)\n* [Error handling](https://youtu.be/XEUVl3bbMhI?si=nUyaME5kyxe6daGO)\n* [Debugging](https://youtu.be/Gxe_RfCRH-o?si=F-pAviLTIeL3-X13)\n* [Collaboration](https://youtu.be/pI0W-0Qcwmo?si=X7sALFXo2e-cY9FQ)\n\n## Advanced[#](#advanced \"Permanent link\")\n\nThe [Advanced](https://www.youtube.com/playlist?list=PLlET0GsrLUL5bxmx5c1H1Ms_OtOPYZIEG) course covers more complex workflows, more technical nodes, and enterprise features:\n\n* [Introduction and complex data flows](https://youtu.be/TFTLMQLozCI?si=vX0ooIH1RmbsgAkC)\n* [Advanced technical nodes](https://youtu.be/JM4jqYs4Fxo?si=YSNMeSay3C29C8HS)\n* [Pinning and editing output data](https://youtu.be/zcNB8L4_9mA?si=LZJ9DlYDQQxL7eeP)\n* [Sub-workflows](https://youtu.be/xr05Ie_Hkyg?si=rqqP8llttZPBjBeD)\n* [Error workflows](https://youtu.be/77Ewdaby47M?si=6YRlC4nMgG4hVQPV)\n* [Building a full example](https://youtu.be/wOKLEfeJLVE?si=YMW5t-PzPq7QKbPY)\n* [Handling files](https://youtu.be/2RAZYNigqOY?si=9x4vLX2Qo08xx8vC)\n* [Enterprise features](https://youtu.be/fXEubzmVJ_E?si=aK9_fI9tkF6F5CtB)"
},
{
"url": "https://docs.n8n.io/try-it-out/tutorial-first-workflow/",
"markdown": "# A longer introduction | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/try-it-out/tutorial-first-workflow.md \"Edit this page\")\n\n## Your first workflow[#](#your-first-workflow \"Permanent link\")\n\nThis guide will show you how to construct a [workflow](https://docs.n8n.io/glossary/#workflow-n8n) in n8n, explaining key concepts along the way. You will:\n\n* Create a workflow from scratch.\n* Understand key concepts and skills, including:\n * Starting workflows with trigger nodes\n * Configuring [credentials](https://docs.n8n.io/glossary/#credential-n8n)\n * Processing data\n * Representing logic in an n8n workflow\n * Using [expressions](https://docs.n8n.io/glossary/#expression-n8n)\n\n\n\nThis quickstart uses [n8n Cloud](https://docs.n8n.io/manage-cloud/overview/), which is recommended for new users. A free trial is available - if you haven't already done so, [sign up](https://app.n8n.cloud/register) for an account now.\n\n## Step one: Create a new workflow[#](#step-one-create-a-new-workflow \"Permanent link\")\n\nWhen you open n8n, you'll see either:\n\n* A window with a welcome message and two large buttons: Choose **Start from Scratch** to create a new workflow.\n* The **Workflows** list on the **Overview** page. Select the **Create Workflow** to create a new workflow.\n\n## Step two: Add a trigger node[#](#step-two-add-a-trigger-node \"Permanent link\")\n\nn8n provides two ways to start a workflow:\n\n* Manually, by selecting **Execute Workflow**.\n* Automatically, using a trigger node as the first node. The trigger node runs the workflow in response to an external event, or based on your settings.\n\nFor this tutorial, we'll use the [Schedule trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/). This allows you to run the workflow on a schedule:\n\n1. Select **Add first step**.\n2. Search for **Schedule**. n8n shows a list of nodes that match the search.\n3. Select **Schedule Trigger** to add the node to the canvas. n8n opens the node.\n4. For **Trigger Interval**, select **Weeks**.\n5. For **Weeks Between Triggers**, enter `1`.\n6. Enter a time and day. For this example, select **Monday** in **Trigger on Weekdays**, select **9am** in **Trigger at Hour**, and enter `0` in **Trigger at Minute**.\n7. Close the node details view to return to the canvas.\n\n## Step three: Add the NASA node and set up credentials[#](#step-three-add-the-nasa-node-and-set-up-credentials \"Permanent link\")\n\nThe [NASA node](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.nasa/) interacts with NASA's [public APIs](https://api.nasa.gov/) to fetch useful data. We will use the real-time data from the API to find solar events.\n\nCredentials\n\nCredentials are private pieces of information issued by apps and services to authenticate you as a user and allow you to connect and share information between the app or service and the n8n node. The type of information required varies depending on the app/service concerned. You should be careful about sharing or revealing the credentials outside of n8n.\n\n1. Select the **Add node**  connector on the Schedule Trigger node.\n2. Search for **NASA**. n8n shows a list of nodes that match the search.\n3. Select **NASA** to view a list of operations.\n4. Search for and select **Get a DONKI solar flare**. This operation returns a report about recent solar flares. When you select the operation, n8n adds the node to the canvas and opens it.\n5. To access the NASA APIs, you need to set up credentials:\n \n 1. Select the **Credential for NASA API** dropdown.\n 2. Select **Create new credential**. n8n opens the credentials view.\n 3. Go to [NASA APIs](https://api.nasa.gov/) and fill out the form from the **Generate API Key** link. The NASA site generates the key and emails it to the address you entered.\n 4. Check your email account for the API key. Copy the key, and paste it into **API Key** in n8n.\n 5. Select **Save**.\n 6. Close the credentials screen. n8n returns to the node. The new credentials should be automatically selected in **Credential for NASA API**.\n6. By default, DONKI Solar Flare provides data for the past 30 days. To limit it to just the last week, use **Additional Fields**:\n \n 1. Select **Add field**.\n 2. Select **Start date**.\n 3. To get a report starting from a week ago, you can use an expression: next to **Start date**, select the **Expression** tab, then select the expand button  to open the full expressions editor.\n 4. In the **Expression** field, enter the following expression:\n \n | | |\n | --- | --- |\n | | `{{ $today.minus(7, 'days') }}` |\n \n This generates a date in the correct format, seven days before the current date.\n \n \n \n Date and time formats in n8n...\n \n n8n uses Luxon to work with date and time, and also provides two variables for convenience: `$now` and `$today`. For more information, refer to [Expressions > Luxon](https://docs.n8n.io/code/cookbook/luxon/).\n \n7. Close the **Edit Expression** modal to return to the NASA node.\n \n8. You can now check that the node is working and returning the expected date: select **Execute step** to run the node manually. n8n calls the NASA API and displays details of solar flares in the past seven days in the **OUTPUT** section.\n9. Close the NASA node to return to the workflow canvas.\n\n## Step four: Add logic with the If node[#](#step-four-add-logic-with-the-if-node \"Permanent link\")\n\nn8n supports complex logic in workflows. In this tutorial we will use the [If node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) to create two branches that each generate a report from the NASA data. Solar flares have five possible classifications; we will add logic that sends a report with the lower classifications to one output, and the higher classifications to another.\n\nAdd the If node:\n\n1. Select the **Add node**  connector on the NASA node.\n2. Search for **If**. n8n shows a list of nodes that match the search.\n3. Select **If** to add the node to the canvas. n8n opens the node.\n4. You need to check the value of the `classType` property in the NASA data. To do this:\n \n 1. Drag **classType** into **Value 1**.\n \n Make sure you ran the NASA node in the previous section\n \n If you didn't follow the step in the previous section to run the NASA node, you won't see any data to work with in this step.\n \n 2. Change the comparison operation to **String > Contains**.\n \n 3. In **Value 2**, enter **X**. This is the highest classification of solar flare. In the next step, you will create two reports: one for X class solar flares, and one for all the smaller solar flares.\n 4. You can now check that the node is working and returning the expected date: select **Execute step** to run the node manually. n8n tests the data against the condition, and shows which results match true or false in the **OUTPUT** panel.\n \n Weeks without large solar flares\n \n In this tutorial, you are working with live data. If you find there aren't any X class solar flares when you run the workflow, try replacing **X** in **Value 2** with either **A**, **B**, **C**, or **M**.\n \n5. Once you are happy the node will return some events, you can close the node to return to the canvas.\n \n\n## Step five: Output data from your workflow[#](#step-five-output-data-from-your-workflow \"Permanent link\")\n\nThe last step of the workflow is to send the two reports about solar flares. For this example, you'll send data to [Postbin](https://www.toptal.com/developers/postbin/). Postbin is a service that receives data and displays it on a temporary web page.\n\n1. On the If node, select the **Add node**  connector labeled **true**.\n2. Search for **PostBin**. n8n shows a list of nodes that match the search.\n3. Select **PostBin**.\n4. Select **Send a request**. n8n adds the node to the canvas and opens it.\n5. Go to [Postbin](https://www.toptal.com/developers/postbin/) and select **Create Bin**. Leave the tab open so you can come back to it when testing the workflow.\n6. Copy the bin ID. It looks similar to `1651063625300-2016451240051`.\n7. In n8n, paste your Postbin ID into **Bin ID**.\n8. Now, configure the data to send to Postbin. Next to **Bin Content**, select the **Expression** tab (you will need to mouse-over the **Bin Content** for the tab to appear), then select the expand button  to open the full expressions editor.\n9. You can now click and drag the correct field from the If Node output into the expressions editor to automatically create a reference for this label. In this case the input we want is 'classType'.\n10. Once dropped into the expressions editor it will transform into this reference: `{{$json[\"classType\"]}}`. Add a message to it, so that the full expression is:\n \n | | |\n | --- | --- |\n | | `There was a solar flare of class {{$json[\"classType\"]}}` |\n \n \n \n11. Close the expressions editor to return to the node.\n \n12. Close the Postbin node to return to the canvas.\n13. Add another Postbin node, to handle the **false** output path from the If node:\n 1. Hover over the Postbin node, then select **Node context menu**  > **Duplicate node** to duplicate the first Postbin node.\n 2. Drag the **false** connector from the If node to the left side of the new Postbin node.\n\n## Step six: Test the workflow[#](#step-six-test-the-workflow \"Permanent link\")\n\n1. You can now test the entire workflow. Select **Execute Workflow**. n8n runs the workflow, showing each stage in progress.\n2. Go back to your Postbin bin. Refresh the page to see the output.\n3. If you want to use this workflow (in other words, if you want it to run once a week automatically), you need to activate it by selecting the **Active** toggle.\n\nTime limit\n\nPostbin's bins exist for 30 minutes after creation. You may need to create a new bin and update the ID in the Postbin nodes, if you exceed this time limit.\n\n## Congratulations[#](#congratulations \"Permanent link\")\n\nYou now have a fully functioning workflow that does something useful! It should look something like this:\n\nAlong the way you have discovered:\n\n* How to find the nodes you want and join them together\n* How to use expressions to manipulate data\n* How to create credentials and attach them to nodes\n* How to use logic in your workflows\n\nThere are plenty of things you could add to this (perhaps add some more credentials and a node to send you an email of the results), or maybe you have a specific project in mind. Whatever your next steps, the resources linked below should help.\n\n## Next steps[#](#next-steps \"Permanent link\")\n\n* Interested in what you could do with AI? Find out [how to build an AI chat agent with n8n](https://docs.n8n.io/advanced-ai/intro-tutorial/).\n* Take n8n's [text courses](https://docs.n8n.io/courses/) or [video courses](https://docs.n8n.io/video-courses/).\n* Explore more examples in [workflow templates](https://n8n.io/workflows/)."
},
{
"url": "https://docs.n8n.io/courses/level-one/",
"markdown": "# Index | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/index.md \"Edit this page\")\n\n## Level one: Introduction[#](#level-one-introduction \"Permanent link\")\n\nWelcome to the **n8n Course Level 1**!\n\n## Is this course right for me?[#](#is-this-course-right-for-me \"Permanent link\")\n\nThis course introduces you to the fundamental concepts within n8n and develops your low-code automation expertise.\n\nThis course is for you if you:\n\n* Are starting to use n8n for the first time.\n* Are looking for some extra help creating your first workflow.\n* Want to automate processes in your personal or working life.\n\nThis course introduces n8n concepts and demonstrates practical workflow building without assuming any prior familiarity with n8n. If you'd like to get a feel for the basics without as much explanation, consult our [quickstart guide](https://docs.n8n.io/try-it-out/tutorial-first-workflow/).\n\n## What will I learn in this course?[#](#what-will-i-learn-in-this-course \"Permanent link\")\n\nWe believe in learning by doing. You can expect some theoretical information about the basic concepts and components of n8n, followed by practice of building workflows step by step.\n\nBy the end of this course you will know:\n\n* How to set up n8n and navigate the Editor UI.\n* How n8n structures data.\n* How to configure different node parameters and add credentials.\n* When and how to use conditional logic in workflows.\n* How to schedule and control workflows.\n* How to import, download, and share workflows with others.\n\nYou will build two workflows:\n\n* A two-node workflow to get articles from Hacker News\n* A seven-node workflow to help your client get records from a data warehouse, filter them, make calculations, and notify team members about the results\n\n## What do I need to get started?[#](#what-do-i-need-to-get-started \"Permanent link\")\n\n1. **n8n set up**: You can use [n8n Cloud](https://docs.n8n.io/manage-cloud/overview/) (or the [self-hosted version](https://docs.n8n.io/hosting/installation/docker/) if you have experience hosting services).\n2. **A course user ID**: [Sign up here](https://n8n-community.typeform.com/to/PDEMrevI) to get your unique ID and other credentials you will need in the course.\n3. Basic knowledge of JavaScript and [APIs](https://blog.n8n.io/what-are-apis-how-to-use-them-with-no-code/) would be helpful, but isn't necessary.\n4. An [account on the n8n community forum](https://community.n8n.io/) if you wish to receive a profile badge and avatar upon successful completion.\n\n## How long does the course take?[#](#how-long-does-the-course-take \"Permanent link\")\n\nCompleting the course should take around **two hours**. You don't have to complete it in one go; feel free to take breaks and resume whenever you are ready.\n\n## How do I complete the course?[#](#how-do-i-complete-the-course \"Permanent link\")\n\nThere are two milestones in this course that test your knowledge of what you have learned in the lessons:\n\n* Building the [main workflow](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.1/)\n* Passing the [quiz](https://n8n-community.typeform.com/to/JMoBXeGA) at the end of the course\n\nCheck your progress\n\nYou can always **check your progress** throughout the course by entering your unique ID [here](https://internal.users.n8n.cloud/webhook/course-level-1/verify).\n\nIf you complete the milestones above, you will get [**a badge and an avatar**](https://community.n8n.io/badges/104/completed-n8n-course-level-1) in your forum profile. You can then share your profile and course verification ID to showcase your n8n skills to others.\n\n[Let's get started!](https://docs.n8n.io/courses/level-one/chapter-1/)"
},
{
"url": "https://docs.n8n.io/courses/",
"markdown": "# Text courses | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/index.md \"Edit this page\")\n\nIf you've found your way here, it means you're serious about your interest in automation. Maybe you're tired of manually entering data into the same spreadsheet every day, of clicking through a series of tabs and buttons for that one piece of information you need, of managing tens of different tools and systems.\n\nWhatever the reason, one thing is clear: you shouldn't spend precious time doing things that don't spark joy or contribute to your personal and professional growth.\n\nThese tasks can and should be automated! And you don't need advanced technical knowledge or excellent coding skills to do this–with no-code tools like n8n, automation is for everyone.\n\n## Available courses[#](#available-courses \"Permanent link\")\n\n* [Level 1: Beginner course](https://docs.n8n.io/courses/level-one/)\n* [Level 2: Intermediate course](https://docs.n8n.io/courses/level-two/)"
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-1/",
"markdown": "# Navigating the editor UI | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-1.md \"Edit this page\")\n\nIn this lesson you will learn how to navigate the [Editor UI](https://docs.n8n.io/glossary/#editor-n8n). We will walk through the [canvas](https://docs.n8n.io/glossary/#canvas-n8n) and show you what each icon means and where to find things you will need while building workflows in n8n.\n\nn8n version\n\nThis course is based on n8n version 1.82.1. In other versions, some user interfaces might look different, but this shouldn't impact the core functionality.\n\n## Getting started[#](#getting-started \"Permanent link\")\n\nBegin by setting up n8n.\n\nWe recommend starting with [n8n Cloud](https://app.n8n.cloud/register), a hosted solution that doesn't require installation and includes a free trial.\n\nAlternative set up\n\nIf n8n Cloud isn't a good option for you, you can [self-host with Docker](https://docs.n8n.io/hosting/installation/docker/). This is an advanced option recommended only for technical users familiar with hosting services, Docker, and the command line.\n\nFor more details on the different ways to set up n8n, see our [platforms documentation](https://docs.n8n.io/choose-n8n/#platforms).\n\nOnce you have n8n running, open the Editor UI in a browser window. Log in to your n8n instance. Select **Overview** and then **Create Workflow** to view the main canvas.\n\nIt should look like this:\n\n\n\n_Editor UI_\n\n## Editor UI settings[#](#editor-ui-settings \"Permanent link\")\n\nThe editor UI is the web interface where you build [workflows](https://docs.n8n.io/workflows/). You can access all your workflows and [credentials](https://docs.n8n.io/glossary/#credential-n8n), as well as support pages, from the Editor UI.\n\n### Left-side panel[#](#left-side-panel \"Permanent link\")\n\nOn the left side of the **Editor UI**, there is a panel which contains the core functionalities and settings for managing your workflows. Expand and collapse it by selecting the small arrow icon.\n\nThe panel contains the following sections:\n\n* **Overview**: Contains all the workflows and credentials you have access to. During this course, create new workflows here.\n* **Projects**: (Not available on Community edition) Projects group workflows and credentials. You can assign [roles](https://docs.n8n.io/user-management/rbac/role-types/) to users in a project to control what they can do in a project. A **Personal** project is available by default.\n* **Admin Panel**: n8n Cloud only. Access your n8n instance usage, billing, and version settings.\n* **Templates**: A collection of pre-made workflows. Great place to get started with common use cases.\n* **Variables**: Used to store and access fixed data across your workflows. This feature is available on the Pro and Enterprise Plans.\n* **All executions**: Contains information about your workflow executions.\n* **Help**: Contains resources around n8n product and community.\n* **Update**: (When updates are available) Indicator for any recent product updates.\n* **Settings**: Under the ellipsis (`...`) menu by your username. Manage users and access settings for a variety of features.\n\n\n\n_Editor UI left-side menu_\n\n### Top bar[#](#top-bar \"Permanent link\")\n\nThe top bar of the **Editor UI** contains the following information:\n\n* **Workflow Name**: By default, n8n names a new workflow as \"My workflow\", but you can edit the name at any time.\n* **\\+ Add Tag**: Tags help you organise your workflows by category, use case, or whatever is relevant for you. Tags are optional.\n* **Inactive/active toggle**: This button activates or deactivates the current workflow. By default, workflows are deactivated.\n* **Share**: You can share and collaborate with others on workflows on the Starter, Pro, and Enterprise plans.\n* **Save**: This button saves the current workflow.\n* **History**: Once you save your workflow, you can view previous versions here.\n\n\n\n_Editor UI top bar_\n\n### Canvas[#](#canvas \"Permanent link\")\n\nThe **canvas** is the gray dotted grid background in the Editor UI. It displays several icons and a node with different functionalities:\n\n* Buttons to zoom the canvas to fit the screen, zoom in or out of the canvas, and tidy up the nodes on screen.\n* A button to **Execute workflow** once you add your first node. When you click on it, n8n executes all nodes on the canvas in sequence.\n* A button with a **+** sign inside. This button opens the nodes panel.\n* A button with a note icon inside. This button adds a [sticky note](https://docs.n8n.io/workflows/components/sticky-notes/) to the canvas (visible when hovering on the top right + icon).\n* A dotted square with the text \"Add first step.\" This is where you add your first node.\n\n\n\n_Workflow canvas_\n\nMoving the canvas\n\nYou can move the workflow canvas around in three ways:\n\n* Select Ctrl+Left Button on the canvas and move it around.\n* Select Middle Button on the canvas and move it around.\n* Place two fingers on your touchpad and slide.\n\nDon't worry about workflow execution and activation for now; we'll explain these concepts later on in the course.\n\n## Nodes[#](#nodes \"Permanent link\")\n\nYou can think of nodes as building blocks that serve different functions that, when put together, make up a functioning machine: an automated workflow.\n\nNode\n\nA node is an individual step in your workflow: one that either (a) loads, (b) processes, or (c) sends data.\n\nBased on their function, n8n classifies nodes into four types:\n\n* **App** or **Action Nodes** add, remove, and edit data; request and send external data; and trigger events in other systems. Refer to the [Action nodes library](https://docs.n8n.io/integrations/builtin/app-nodes/) for a full list of these nodes.\n* **Trigger Nodes** start a workflow and supply the initial data. Refer to the [Trigger nodes library](https://docs.n8n.io/integrations/builtin/trigger-nodes/) for a list of trigger nodes.\n* **Core Nodes** can be trigger or app nodes. Whereas most nodes connect to a specific external service, core nodes provide functionality such as logic, scheduling, or generic API calls. Refer to the [Core Nodes library](https://docs.n8n.io/integrations/builtin/core-nodes/) for a full list of core nodes.\n* **Cluster Nodes** are node groups that work together to provide functionality in a workflow, primarily for AI workflows. Refer to [Cluster nodes](https://docs.n8n.io/integrations/builtin/cluster-nodes/) for more information.\n\nLearn more\n\nRefer to [Node types](https://docs.n8n.io/integrations/builtin/node-types/) for a more detailed explanation of all node types.\n\n### Finding nodes[#](#finding-nodes \"Permanent link\")\n\nYou can find all available nodes in the **nodes panel** on the right side of the Editor UI. There are three ways in which you can open the nodes panel:\n\n* Click the **+** icon in the top right corner of the canvas.\n* Click the **+** icon on the right side of an existing node on the canvas (the node to which you want to add another one).\n* Click the Tab key on your keyboard.\n\n\n\n_Nodes panel_\n\nIn the nodes panel, notice that when adding your first node, you will see the different trigger node categories. After you have added your trigger node, you'll see that the nodes panel changes to show Advanced AI, Actions in an App, Data transformation, Flow, Core, and Human in the loop nodes.\n\nIf you want to find a specific node, use the search input at the top of the nodes panel.\n\n### Adding nodes[#](#adding-nodes \"Permanent link\")\n\nThere are two ways to add nodes to your canvas:\n\n* Select the node you want in the nodes panel. The new node will automatically connect to the selected node on the canvas.\n* Drag and drop the node from the nodes panel to the canvas.\n\n### Node buttons[#](#node-buttons \"Permanent link\")\n\nIf you hover on a node, you'll notice that three icons appear on top:\n\n* Execute the node (Play icon)\n* Deactivate/Activate the node (Power icon)\n* Delete the node (Trash icon)\n\nThere will also be an ellipsis icon, which opens a context menu containing other [node options](https://docs.n8n.io/workflows/components/nodes/#node-controls).\n\nMoving a workflow\n\nTo move a workflow around the canvas, select all nodes with your mouse or Ctrl+A, select and hold on a node, then drag it to any point you want on the canvas.\n\n## Summary[#](#summary \"Permanent link\")\n\nIn this lesson you learned how to navigate the Editor UI, what the icons mean, how to access the left-side and node panels, and how to add nodes to the canvas.\n\nIn the next lesson, you will build a mini-workflow to put into practice what you've learned so far."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.1/",
"markdown": "# Getting data from the data warehouse\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.1.md \"Edit this page\")\n\nIn this part of the workflow, you will learn how to get data by making HTTP requests with the [**HTTP Request**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node.\n\nAfter completing this section, your workflow will look like this:\n\nFirst, let's set the scene for building Nathan's workflow.\n\n## Create new workflow[#](#create-new-workflow \"Permanent link\")\n\nOpen your Editor UI and create a new workflow with one of the two possible commands:\n\n* Select Ctrl+Alt+N or Cmd+Option+N on your keyboard.\n* Open the left menu, navigate to **Workflows**, and select **Add workflow**.\n\nName this new workflow \"Nathan's workflow.\"\n\nThe first thing you need to do is get data from ABCorp's old data warehouse.\n\nIn a previous chapter, you used an action node designed for a specific service (Hacker News). But not all apps or services have dedicated nodes, like the legacy data warehouse from Nathan's company.\n\nThough we can't directly export the data, Nathan told us that the data warehouse has a couple of API endpoints. That's all we need to access the data using the [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node in n8n.\n\nNo node for that service?\n\nThe HTTP Request node is one of the most versatile nodes, allowing you to make HTTP requests to query data from apps and services. You can use it to access data from apps or services that don't have a dedicated node in n8n.\n\n## Add an HTTP Request node[#](#add-an-http-request-node \"Permanent link\")\n\nNow, in your Editor UI, add an HTTP Request node like you learned in the lesson [Adding nodes](https://docs.n8n.io/courses/level-one/chapter-1/#adding-nodes). The node window will open, where you need to configure some parameters.\n\n\n\n_HTTP Request node_\n\nThis node will use credentials.\n\nCredentials\n\n[Credentials](https://docs.n8n.io/glossary/#credential-n8n) are unique pieces of information that identify a user or a service and allow them to access apps or services (in our case, represented as n8n nodes). A common form of credentials is a username and a password, but they can take other forms depending on the service.\n\nIn this case, you'll need the credentials for the ABCorp data warehouse API included in the email from n8n you received when you signed up for this course. If you haven't signed up yet, [sign up here](https://n8n-community.typeform.com/to/PDEMrevI).\n\nIn the **Parameters** of the HTTP Request node, make the following adjustments:\n\n* **Method**: This should default to GET. Make sure it's set to GET.\n* **URL**: Add the **Dataset URL** you received in the email when you signed up for this course.\n* **Send Headers**: Toggle this control to true. In **Specify Headers**, ensure **Using Fields Below** is selected.\n * **Header Parameters** > **Name**: Enter `unique_id`.\n * **Header Parameters** > **Value**: The Unique ID you received in the email when you signed up for this course.\n* **Authentication**: Select **Generic Credential Type**. This option requires credentials before allowing you to access the data.\n * **Generic Auth Type**: Select **Header Auth**. (This field will appear after you select the Generic Credential Type for the Authentication.)\n * **Credential for Header Auth**: To add your credentials, select **\\+ Create new credential**. This will open the Credentials window.\n * In the Credentials window, set **Name** to be the **Header Auth name** you received in the email when you signed up for this course.\n * In the Credentials window, set **Value** to be the **Header Auth value** you received in the email when you signed up for this course.\n * Select the **Save** button in the Credentials window to save your credentials. Your **Credentials Connection** window should look like this:\n \n \n \n _HTTP Request node credentials_\n \n\nCredentials naming\n\nNew credential names follow the \" account\" format by default. You can rename the credentials by clicking on the name, similarly to renaming nodes. It's good practice to give them names that identify the app/service, type, and purpose of the credential. A naming convention makes it easier to keep track of and identify your credentials.\n\nOnce you save, exit out of the Credentials window to return to the HTTP Request node.\n\n## Get the data[#](#get-the-data \"Permanent link\")\n\nSelect the **Execute step** button in the HTTP Request node window. The table view of the HTTP request results should look like this:\n\n\n\n_HTTP Request node output_\n\nThis view should be familiar to you from the [Building a mini-workflow](https://docs.n8n.io/courses/level-one/chapter-2/) page.\n\nThis is the data from ABCorp's data warehouse that Nathan needs to work with. This data set includes sales information from 30 customers with five columns:\n\n* `orderID`: The unique id of each order.\n* `customerID`: The unique id of each customer.\n* `employeeName`: The name of Nathan's colleague responsible for the customer.\n* `orderPrice`: The total price of the customer's order.\n* `orderStatus`: Whether the customer's order status is `booked` or still in `processing`.\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**Nathan 🙋**: This is great! You already automated an important part of my job with only one node. Now instead of manually accessing the data every time I need it, I can use the HTTP Request Node to automatically get the information.\n\n**You 👩🔧**: Exactly! In the next step, I'll help you one step further and insert the data you retrieved into Airtable."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-3/",
"markdown": "# Automating a (real-world) use case\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-3.md \"Edit this page\")\n\nMeet Nathan 🙋. Nathan works as an Analytics Manager at ABCorp. His job is to support the ABCorp team with reporting and analytics. Being a true jack of all trades, he also handles several miscellaneous initiatives.\n\nSome things that Nathan does are repetitive and mind-numbing. He wants to automate some of these tasks so that he doesn't burn out. As an **Automation Expert**, you are meeting with Nathan today to help him understand how he can offload some of his responsibilities to n8n.\n\n## Understanding the scenario[#](#understanding-the-scenario \"Permanent link\")\n\n**You 👩🔧:** Nice to meet you, Nathan. Glad to be doing this! What's a repetitive task that's error-prone and that you'd like to get off your plate first?\n\n**Nathan 🙋:** Thanks for coming in! The most annoying one's gotta be the weekly sales reporting.\n\nI have to collect sales data from our legacy data warehouse, which manages data from the main business processes of an organization, such as sales or production. Now, each sales order can have the status Processing or Booked. I have to calculate the sum of all the Booked orders and announce them in the company Discord every Monday. Then I have to create a spreadsheet of all the Processing sales so that the Sales Managers can review them and check if they need to follow up with customers.\n\nThis manual work is tough and requires high attention to detail to make sure that all the numbers are right. Inevitably, I lose my focus and mistype a number or I don't get it done on time. I've been criticized once by my manager for miscalculating the data.\n\n**You 👩🔧:** Oh no! Doesn't the data warehouse have a way to export the data?\n\n**Nathan 🙋:** The data warehouse was written in-house ages ago. It doesn't have a CSV export but they recently added a couple of API endpoints that expose this data, if that helps.\n\n**You 👩🔧:** Perfect! That's a good start. If you have a generic API, we can add some custom code and a couple of services to make an automated workflow. This gig has n8n written all over it. Let's get started!"
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-4/",
"markdown": "# Designing the workflow | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-4.md \"Edit this page\")\n\nNow that we know what Nathan wants to automate, let's consider the steps he needs to take to achieve his goals:\n\n1. Get the relevant data (order id, order status, order value, employee name) from the data warehouse\n2. Filter the orders by their status (Processing or Booked)\n3. Calculate the total value of all the Booked orders\n4. Notify the team members about the Booked orders in the company's Discord channel\n5. Insert the details about the Processing orders in Airtable for follow-up\n6. Schedule this workflow to run every Monday morning\n\nNathan's workflow involves sending data from the company's data warehouse to two external services:\n\n* Discord\n* Airtable\n\nBefore that, the data has to be wrangled with general functions (conditional filtering, calculation, scheduling).\n\nn8n provides integrations for all these steps, so Nathan's workflow in n8n would look like this:\n\nYou will build this workflow in eight steps:\n\n1. [Getting data from the data warehouse](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.1/)\n2. [Inserting data into Airtable](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.2/)\n3. [Filtering orders](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.3/)\n4. [Setting values for processing orders](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.4/)\n5. [Calculating booked orders](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.5/)\n6. [Notifying the team](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.6/)\n7. [Scheduling the workflow](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.7/)\n8. [Activating and examining the workflow](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.8/)\n\nTo build this workflow, you will need the credentials found in the email you received from n8n when you signed up for this course. If you haven't signed up already, you can do it [here](https://n8n-community.typeform.com/to/PDEMrevI?typeform-source=127.0.0.1). If you haven't received a confirmation email after signing up, [contact us](mailto:help@n8n.io).\n\n[Start building!](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.1/)"
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.2/",
"markdown": "# Inserting data into airtable | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.2.md \"Edit this page\")\n\nIn this step of the workflow, you will learn how to insert the data received from the HTTP Request node into Airtable using the [Airtable node](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.airtable/).\n\nSpreadsheet nodes\n\nYou can replace the Airtable node with another spreadsheet app/service. For example, n8n also has a node for [**Google Sheets**](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/).\n\nAfter this step, your workflow should look like this:\n\n## Configure your table[#](#configure-your-table \"Permanent link\")\n\nIf we're going to insert data into Airtable, we first need to set up a table there. To do this:\n\n1. [Create an Airtable account](https://airtable.com/signup).\n2. In your Airtable workspace add a new base from scratch and name it, for example, _beginner course_.\n \n \n \n _Create an Airtable base_\n \n3. In the beginner course base, by default, you have a table called **Table 1** with four fields: `Name`, `Notes`, `Assignee`, and `Status`. These fields aren't relevant for us since they aren't in our \"orders\" data set. This brings us to the next point: the names of the fields in Airtable have to match the names of the columns in the node result. Prepare the table by doing the following:\n \n * Rename the table from **Table 1** to **orders** to make it easier to identify.\n * Delete the 3 blank records created by default.\n * Delete the `Notes`, `Assignee`, and `Status` fields.\n * Edit the `Name` field (the primary field) to read `orderID`, with the **Number** field type.\n * Add the rest of the fields, and their field types, using the table below as a reference:\n \n | Field name | Field type |\n | --- | --- |\n | `orderID` | Number |\n | `customerID` | Number |\n | `employeeName` | Single line text |\n | `orderPrice` | Number |\n | `orderStatus` | Single line text |\n \n\nNow your table should look like this:\n\n\n\n_Orders table in Airtable_\n\nNow that the table is ready, let's return to the workflow in the n8n Editor UI.\n\n## Add an Airtable node to the HTTP Request node[#](#add-an-airtable-node-to-the-http-request-node \"Permanent link\")\n\nAdd an Airtable node connected to the HTTP Request node.\n\nRemember\n\nYou can add a node connected to an existing node by selecting the **+** icon next to the existing node.\n\nIn the node panel:\n\n1. Search for Airtable.\n2. Select **Create a record** from the **Record Actions** search results.\n\nThis will add the Airtable node to your canvas and open the node details window.\n\nIn the Airtable node window, configure the following parameters:\n\n* **Credential to connect with**:\n * Select **Create new credential**.\n * Keep the default option **Connect using: Access Token** selected.\n * **Access token**: Follow the instructions from the [Airtable credential](https://docs.n8n.io/integrations/builtin/credentials/airtable/) page to create your token. Use the recommended scopes and add access to your beginners course base. Save the credential and close the Credential window when you're finished.\n* **Resource**: Record.\n* **Operation**: Create. This operation will create new records in the table.\n* **Base**: You can pick your base from a list (for example, beginner course).\n* **Table**: orders.\n* **Mapping Column Mode**: Map automatically. In this mode, the incoming data fields must have the same as the columns in Airtable.\n\n## Test the Airtable node[#](#test-the-airtable-node \"Permanent link\")\n\nOnce you've finished configuring the Airtable node, execute it by selecting **Execute step**. This might take a moment to process, but you can follow the progress by viewing the base in Airtable.\n\nYour results should look like this:\n\n\n\n_Airtable node results_\n\nAll 30 data records will now appear in the orders table in Airtable:\n\n\n\n_Imported records in the orders table_\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**Nathan 🙋**: Wow, this automation is already so useful! But this inserts all collected data from the HTTP Request node into Airtable. Remember that I actually need to insert only processing orders in the table and calculate the price of booked orders?\n\n**You 👩🔧**: Sure, no problem. As a next step, I'll use a new node to filter the orders based on their status."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-2/",
"markdown": "# Building a mini-workflow | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-2.md \"Edit this page\")\n\nIn this lesson, you will build a small [workflow](https://docs.n8n.io/glossary/#workflow-n8n) that gets 10 articles about automation from Hacker News. The process consists of five steps:\n\n1. [Add a Manual Trigger node](#1-add-a-manual-trigger-node)\n2. [Add the Hacker News node](#2-add-the-hacker-news-node)\n3. [Configure the Hacker News node](#3-configure-the-hacker-news-node)\n4. [Execute the node](#4-execute-the-node)\n5. [Save the workflow](#5-save-the-workflow)\n\nThe finished workflow will look like this:\n\n## 1\\. Add a Manual Trigger node[#](#1-add-a-manual-trigger-node \"Permanent link\")\n\nOpen the nodes panel (reminder: you can open this by selecting the **+** icon in the top right corner of the [canvas](https://docs.n8n.io/glossary/#canvas-n8n) or selecting Tab on your keyboard).\n\nThen:\n\n1. Search for the **Manual Trigger** node.\n2. Select it when it appears in the search.\n\nThis will add the [Manual Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger/) node to your canvas, which allows you to run the workflow at any time by selecting the **Execute workflow** button.\n\nManual triggers\n\nFor faster workflow creation, you can skip this step in the future. Adding any other node without a trigger will add the Manual Trigger node to the workflow.\n\nIn a real-world scenario, you would probably want to set up a schedule or some other [trigger](https://docs.n8n.io/glossary/#trigger-node-n8n) to run the workflow.\n\n## 2\\. Add the Hacker News node[#](#2-add-the-hacker-news-node \"Permanent link\")\n\nSelect the **+** icon to the right of the Manual Trigger node to open the nodes panel.\n\nThen:\n\n1. Search for the **Hacker News** node.\n2. Select it when it appears in the search.\n3. In the **Actions** section, select **Get many items**.\n\nn8n adds the node to your canvas and the node window opens to display its configuration details.\n\n## 3\\. Configure the Hacker News node[#](#3-configure-the-hacker-news-node \"Permanent link\")\n\nWhen you add a new node to the Editor UI, the node is automatically activated. The node details will open in a window with several options:\n\n* **Parameters**: Adjust parameters to refine and control the node's functionality.\n* **Settings**: Adjust settings to control the node's design and executions.\n* **Docs**: Open the n8n documentation for this node in a new window.\n\nParameters vs. Settings\n\n* **Parameters** are different for each node, depending on its functionality.\n* **Settings** are the same for all nodes.\n\n### Parameters[#](#parameters \"Permanent link\")\n\nWe need to configure several parameters for the Hacker News node to make it work:\n\n* **Resource**: All \n This resource selects all data records (articles).\n* **Operation**: Get Many \n This operation fetches all the selected articles.\n* **Limit**: 10 \n This parameter sets a limit to the number of results the Get Many operation returns.\n* **Additional Fields** > **Add Field** > **Keyword**: automation \n **Additional fields** are options that you can add to certain nodes to make your request more specific or filter the results. For this example, we want to get only articles that include the keyword \"automation.\" \n \n\nThe configuration of the parameters for the Hacker News node should now look like this:\n\n\n\n_Hacker News node parameters_\n\n### Settings[#](#settings \"Permanent link\")\n\nThe **Settings** section includes several options for node design and executions. In this case, we'll configure only the final two settings, which set the node's appearance in the Editor UI canvas.\n\nIn the Hacker News node Settings, edit:\n\n* **Notes**: Get the 10 latest articles.\n \n Node notes\n \n It's often helpful to add a short description in the node about what it does. This is helpful for complex or shared workflows in particular!\n \n* **Display note in flow?**: toggle to true \n This option will display the Note under the node in the canvas.\n \n\nThe configuration of the settings for the Hacker News node should now look like this:\n\n\n\n_Hacker News node settings_\n\nRenaming a node\n\nYou can rename the node with a name that's more descriptive for your use case. There are three ways to do this:\n\n* Select the node you want to rename and at the same time press the F2 key on your keyboard.\n* Double-click on the node to open the node window. Click on the name of the node in the top left corner of the window, rename it as you like, then click **Rename** to save the node under the new name.\n* Right-click on the node and select the **Rename** option.\n\n\n\n_Renaming a node from the keyboard_\n\nTo find the original node name (the type of node), open the node window and select **Settings**. The bottom of the page contains the node type and version.\n\n## 4\\. Execute the node[#](#4-execute-the-node \"Permanent link\")\n\nSelect the **Execute step** button in the node details window. You should see 10 results in the Output **Table** view.\n\n\n\n_Results in Table view for the Hacker News node_\n\n### Node executions[#](#node-executions \"Permanent link\")\n\nNode execution\n\nA node execution represents a run of that node to retrieve or process the specified data.\n\nIf a node executes successfully, a small green checkmark appears on top of the node in the canvas\n\n\n\n_Successfully executed workflow_\n\nIf there are no problems with the parameters and everything works fine, the requested data displays in the node window in **Table**, **JSON**, and **Schema** format. You can switch between these views by selecting the one you want from the **Table | JSON | Schema** button at the top of the node window.\n\nTable vs JSON views\n\nThe **Table** view is the default. It displays the requested data in a table, where the rows are the records and the columns are the available attributes of those records.\n\nHere's our Hacker News output in JSON view:\n\n\n\n_Results in JSON view for the Hacker News node_\n\nThe node window displays more information about the node execution:\n\n* Next to the **Output** title, notice a small icon (this will be a green checkmark if the node execution succeeded). Beside it, there is an info icon. If you hover on it, you'll get two more pieces of information that can provide insights into the performance of each individual node in a workflow:\n * **Start Time**: When the node execution started.\n * **Execution Time**: How long it took for the node to return the results from the moment it started executing.\n* Just below the **Output** title, you'll notice another piece of information: **10 items**. This field displays the number of items (records) that the node request returned. In this example, it's expected to be 10, since this is the limit we set in step 2. But if you don't set a limit, it's useful to see how many records are actually returned.\n\nError in nodes\n\nA red warning icon on a node means that the node has errors. This might happen if the node credentials are missing or incorrect or the node parameters aren't configured correctly.\n\n\n\n_Error in nodes_\n\n## 5\\. Save the workflow[#](#5-save-the-workflow \"Permanent link\")\n\nOnce you're finished editing the node, select **Back to canvas** to return to the main canvas.\n\nBy default, your workflow is automatically saved as \"My workflow.\"\n\nFor this lesson, rename the workflow to be \"Hacker News workflow.\"\n\nReminder\n\nYou can rename a workflow by clicking on the workflow's name at the top of the Editor UI.\n\nOnce you've renamed the workflow, be sure to save it.\n\nThere are two ways in which you can save a workflow:\n\n* From the Canvas in Editor UI, click **Ctrl + S** or **Cmd + S** on your keyboard.\n* Select the **Save** button in the top right corner of the Editor UI. You may need to leave the node editor first by clicking outside the dialog.\n\nIf you see a grey **Saved** text instead of the **Save** button, your workflow was automatically saved.\n\n## Summary[#](#summary \"Permanent link\")\n\nCongratulations, you just built your first workflow! In this lesson, you learned how to use actions in app nodes, configure their parameters and settings, and save and execute your workflow.\n\nIn the next lesson, you'll meet your new client, Nathan, who needs to automate his sales reporting work. You will build a more complex workflow for his use case, helping him become more productive at work."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.4/",
"markdown": "# Setting values for processing orders\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.4.md \"Edit this page\")\n\nIn this step of the workflow, you will learn how to select and set data before transferring it to Airtable using the Edit Fields (Set) node. After this step, your workflow should look like this:\n\nThe next step in Nathan's workflow is to filter the data to only insert the `employeeName` and `orderID` of all `processing` orders into Airtable.\n\nFor this, you need to use the [Edit Fields (Set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/), which allows you to select and set the data you want to transfer from one node to another.\n\nEdit Fields node\n\nThe Edit Fields node can set completely new data as well as overwrite data that already exists. This node is crucial in workflows which expect incoming data from previous nodes, such as when inserting values into spreadsheets or databases.\n\n## Add another node before the Airtable node[#](#add-another-node-before-the-airtable-node \"Permanent link\")\n\nIn your workflow, add another node before the **Airtable node** from the **If node** in the same way we did it in the [Filtering Orders](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.3/#add-if-node-before-the-airtable-node) lesson on the If node's `true` connector. Feel free to drag the Airtable node further away if your canvas feels crowded.\n\n## Configure the Edit Fields node[#](#configure-the-edit-fields-node \"Permanent link\")\n\nNow search for the **Edit Fields (Set) node** after you've selected the **+** sign coming off the If node's `true` connector.\n\nWith the Edit Fields node window open, configure these parameters:\n\n* Ensure **Mode** is set to **Manual Mapping**.\n* While you can use the **Expression editor** we used in the [Filtering Orders](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.3/) lesson, this time, let's drag the fields from the **Input** into the **Fields to Set**:\n * Drag **If** > **orderID** as the first field.\n * Drag **If** > **employeeName** as the second field.\n* Ensure that **Include Other Input Fields** is set to false.\n\nSelect **Execute step**. You should see the following results:\n\n\n\n_Edit Fields (Set) node_\n\n## Add data to Airtable[#](#add-data-to-airtable \"Permanent link\")\n\nNext, let's insert these values into Airtable:\n\n1. Go to your Airtable base.\n2. Add a new table called `processingOrders`.\n3. Replace the existing columns with two new columns:\n \n * `orderID` (primary field): Number\n * `employeeName`: Single line text\n4. Delete the three empty rows in the new table.\n \n5. In n8n, connect the Edit Fields node **connector to the** Airtable node\\*\\*.\n6. Update the Airtable node configuration to point to the new `processingOrders` table instead of the `orders` table.\n7. Test your Airtable node to be sure it inserts records into the new `processingOrders` table.\n\nAt this stage, your workflow should now look like this:\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**Nathan 🙋**: You've already automated half of my work! Now I still need to calculate the booked orders for my colleagues. Can we automate that as well?\n\n**You 👩🔧**: Yes! In the next step, I'll use some JavaScript code in a node to calculate the booked orders."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.7/",
"markdown": "# Scheduling the workflow | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.7.md \"Edit this page\")\n\nIn this step of the workflow, you will learn how to schedule your workflow so that it runs automatically at a set time/interval using the Schedule Trigger node. After this step, your workflow should look like this:\n\nThe workflow you've built so far executes only when you click on **Execute Workflow**. But Nathan needs it to run automatically every Monday morning. You can do this with the [Schedule Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/), which allows you to schedule workflows to run periodically at fixed dates, times, or intervals.\n\nTo achieve this, we'll remove the Manual Trigger node we started with and replace it with a Schedule Trigger node instead.\n\n## Remove the Manual Trigger node[#](#remove-the-manual-trigger-node \"Permanent link\")\n\nFirst, let's remove the Manual Trigger node:\n\n1. Select the Manual Trigger node connected to your HTTP Request node.\n2. Select the trash can icon to delete.\n\nThis removes the Manual Trigger node and you'll see an \"Add first step\" option.\n\n## Add the Schedule Trigger node[#](#add-the-schedule-trigger-node \"Permanent link\")\n\n1. Open the nodes panel and search for **Schedule Trigger**.\n2. Select it when it appears in the search results.\n\nIn the Schedule Trigger node window, configure these parameters:\n\n* **Trigger Interval**: Select **Weeks**.\n* **Weeks Between Triggers**: Enter `1`.\n* **Trigger on weekdays**: Select **Monday** (and remove **Sunday** if added by default).\n* **Trigger at Hour**: Select **9am**.\n* **Trigger at Minute**: Enter `0`.\n\nYour Schedule Trigger node should look like this:\n\n\n\n_Schedule Trigger Node_\n\nKeep in mind\n\nTo ensure accurate scheduling with the Schedule Trigger node, be sure to set the correct timezone for your [n8n instance](https://docs.n8n.io/manage-cloud/set-cloud-timezone/) or the [workflow's settings](https://docs.n8n.io/workflows/settings/). The Schedule Trigger node will use the workflow's timezone if it's set; it will fall back to the n8n instance's timezone if it's not.\n\n## Connect the Schedule Trigger node[#](#connect-the-schedule-trigger-node \"Permanent link\")\n\nReturn to the canvas and connect your Schedule Trigger node to the HTTP Request node by dragging the arrow from it to the HTTP Request node.\n\nYour full workflow should look like this:\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**You 👩🔧**: That was it for the workflow! I've added and configured all necessary nodes. Now every time you click on **Execute workflow**, n8n will execute all the nodes: getting, filtering, calculating, and transferring the sales data.\n\n**Nathan 🙋**: This is just what I needed! My workflow will run automatically every Monday morning, correct?\n\n**You 👩🔧**: Not so fast. To do that, you need to activate your workflow. I'll do this in the next step and show you how to interpret the execution log."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.3/",
"markdown": "# Filtering orders | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.3.md \"Edit this page\")\n\nIn this step of the workflow, you will learn how to filter data using conditional logic and how to use expressions in nodes using the [If node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/).\n\nAfter this step, your workflow should look like this:\n\nTo insert only processing orders into Airtable we need to filter our data by `orderStatus`. Basically, we want to tell the program that _if_ the `orderStatus` is processing, _then_ insert all records with this status into Airtable; _else_, for example, if the `orderStatus` isn't _processing_, calculate the sum of all orders with the other `orderStatus` (`booked`).\n\nThis if-then-else command is conditional logic. In n8n workflows, you can add conditional logic with the [If node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/), which splits a workflow conditionally based on comparison operations.\n\nIf vs. Switch\n\nIf you need to filter data on more than boolean values (true and false), use the [Switch node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.switch/). The Switch node is similar to the If node, but supports multiple output connectors.\n\n## Add If node before the Airtable node[#](#add-if-node-before-the-airtable-node \"Permanent link\")\n\nFirst, let's add an If node between the connection from the HTTP Request node to the Airtable node:\n\n1. Hover over the arrow connection the **HTTP Request** node and the **Airtable** node.\n2. Select the **+** sign between the HTTP Request node and the Airtable node.\n\n## Configure the If node[#](#configure-the-if-node \"Permanent link\")\n\nSelecting the plus removes the connection to the Airtable node to the HTTP request. Now, let's add an If node connected to the HTTP Request node:\n\n1. Search for the If node.\n2. Select it when it appears in the search.\n\nFor the If node, we'll use an expression.\n\nExpressions\n\nAn [expression](https://docs.n8n.io/glossary/#expression-n8n) is a string of characters and symbols in a programming language that can be evaluated to get a value, often according to its input. In n8n workflows, you can use expressions in a node to refer to another node for input data. In our example, the If node references the data output by the HTTP Request node.\n\nIn the If node window, configure the parameters:\n\n* Set the `value1` placeholder to `{{ $json.orderStatus }}` with the following steps:\n \n 1. Hover over the value1 field.\n 2. Select the **Expression** tab on the right side of the `value1` field.\n 3. Next, open the expression editor by selecting the link icon:\n \n \n \n _Opening the Expression Editor_\n \n 4. Use the left-side panel to select **HTTP Request** > **orderStatus** and drag it into the **Expression** field in the center of the window.\n \n \n \n _Expression Editor in the If node_\n \n 5. Once you add the expression, close the **Edit Expression** dialog.\n* **Operation**: Select **String** > **is equal to**\n \n* Set the `value2` placeholder to `processing`.\n\nData Type\n\nMake sure to select the correct data type (boolean, date & time, number, or string) when you select the **Operation**.\n\nSelect **Execute step** to test the If node.\n\nYour results should look like this:\n\n\n\n_If node output_\n\nNote that the orders with a `processing` order status should show for the **True Branch** output, while the orders with a `booked` order status should show in the **False Branch** output.\n\nClose the If node detail view when you're finished.\n\n## Insert data into Airtable[#](#insert-data-into-airtable \"Permanent link\")\n\nNext, we want to insert this data into Airtable. Remember what Nathan said at the end of the [Inserting data into Airtable](https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.2/) lesson?\n\n> I actually need to insert only processing orders in the table...\n\nSince Nathan only needs the `processing` orders in the table, we'll connect the Airtable node to the If node's `true` connector.\n\nIn this case, since the Airtable node is already on our canvas, select the **If node** `true` connector and drag it to the Airtable node.\n\nIt's a good idea at this point to retest the Airtable node. Before you do, open your table in Airtable and delete all existing rows. Then open the Airtable node window in n8n and select **Execute step**.\n\nReview your data in Airtable to be sure your workflow only added the correct orders (those with `orderStatus` of `processing`). There should be 14 records now instead of 30.\n\nAt this stage, your workflow should look like this:\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**Nathan 🙋**: This If node is so useful for filtering data! Now I have all the information about processing orders. I actually only need the `employeeName` and `orderID`, but I guess I can keep all the other fields just in case.\n\n**You 👩🔧**: Actually, I wouldn't recommend doing that. Inserting more data requires more computational power, the data transfer is slower and takes longer, and takes up more storage resources in your table. In this particular case, 14 records with 5 fields might not seem like it'd make a significant difference, but if your business grows to thousands of records and dozens of fields, things add up and even one extra column can affect performance.\n\n**Nathan 🙋**: Oh, that's good to know. Can you select only two fields from the processing orders?\n\n**You 👩🔧**: Sure, I'll do that in the next step."
},
{
"url": "https://docs.n8n.io/keyboard-shortcuts/",
"markdown": "# Keyboard shortcuts | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/keyboard-shortcuts.md \"Edit this page\")\n\n## Keyboard shortcuts and controls[#](#keyboard-shortcuts-and-controls \"Permanent link\")\n\nn8n provides keyboard shortcuts for some actions.\n\n## Workflow controls[#](#workflow-controls \"Permanent link\")\n\n* **Ctrl** + **Alt** + **n**: create new workflow\n* **Ctrl** + **o**: open workflow\n* **Ctrl** + **s**: save the current workflow\n* **Ctrl** + **z**: undo\n* **Ctrl** + **shift** + **z**: redo\n* **Ctrl** + **Enter**: execute workflow\n\n## Canvas[#](#canvas \"Permanent link\")\n\n### Move the canvas[#](#move-the-canvas \"Permanent link\")\n\n* **Ctrl** + **Left Mouse Button** + drag: move node view\n* **Ctrl** + **Middle mouse button** + drag: move node view\n* **Space** + drag: move node view\n* **Middle mouse button** + drag: move node view\n* Two fingers on a touch screen: move node view\n\n### Canvas zoom[#](#canvas-zoom \"Permanent link\")\n\n* **+** or **\\=**: zoom in\n* **\\-** or **\\_**: zoom out\n* **0**: reset zoom level\n* **1**: zoom to fit workflow\n* **Ctrl** + **Mouse wheel**: zoom in/out\n\n### Nodes on the canvas[#](#nodes-on-the-canvas \"Permanent link\")\n\n* **Double click** on a node: open the node details\n* **Ctrl/Cmd** + **Double click** on a sub-workflow node: open the sub-workflow in a new tab\n* **Ctrl** + **a**: select all nodes\n* **Ctrl** + **v**: paste nodes\n* **Shift** + **s**: add sticky note\n\n### With one or more nodes selected in canvas[#](#with-one-or-more-nodes-selected-in-canvas \"Permanent link\")\n\n* **ArrowDown**: select sibling node below the current one\n* **ArrowLeft**: select node left of the current one\n* **ArrowRight**: select node right of the current one\n* **ArrowUp**: select sibling node above the current one\n* **Ctrl** + **c**: copy\n* **Ctrl** + **x**: cut\n* **D**: deactivate\n* **Delete**: delete\n* **Enter**: open\n* **F2**: rename\n* **P**: pin data in node. Refer to [Data pinning](https://docs.n8n.io/data/data-pinning/) for more information.\n* **Shift** + **ArrowLeft**: select all nodes left of the current one\n* **Shift** + **ArrowRight**: select all nodes right of the current one\n* **Ctrl/Cmd** + **Shift** + **o** on a sub-workflow node: open the sub-workflow in a new tab\n\n## Node panel[#](#node-panel \"Permanent link\")\n\n* **Tab**: open the Node Panel\n* **Enter**: insert selected node into workflow\n* **Escape**: close Node panel\n\n### Node panel categories[#](#node-panel-categories \"Permanent link\")\n\n* **Enter**: insert node into workflow, collapse/expand category, open subcategory\n* **ArrowRight**: expand category, open subcategory\n* **ArrowLeft**: collapse category, close subcategory view\n\n## Within nodes[#](#within-nodes \"Permanent link\")\n\n* **\\=**: in an empty parameter input, this switches to [expressions](https://docs.n8n.io/glossary/#expression-n8n) mode."
},
{
"url": "https://docs.n8n.io/user-management/saml/troubleshooting/",
"markdown": "# Troubleshooting SAML SSO | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/saml/troubleshooting.md \"Edit this page\")\n\nIf you get an error when testing your SAML setup, check the following:\n\n* Does the app you created in your IdP support SAML?\n* Did you enter the n8n redirect URL and entity ID in the correct fields in your IdP?\n* Is the metadata XML correct? Check that the metadata you copied into n8n is formatted correctly.\n\nFor more support, use the [forum](https://community.n8n.io/), or contact your support representative if you have a paid support plan."
},
{
"url": "https://docs.n8n.io/user-management/saml/managing/",
"markdown": "# Manage users with SAML | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/user-management/saml/managing.md \"Edit this page\")\n\nThere are some user management tasks that are affected by SAML.\n\n## Exempt users from SAML[#](#exempt-users-from-saml \"Permanent link\")\n\nYou can allow users to log in without using SAML. To do this:\n\n1. Go to **Settings** > **Users**.\n2. Select the menu icon by the user you want to exempt from SAML.\n3. Select **Allow Manual Login**.\n\n## Deleting users[#](#deleting-users \"Permanent link\")\n\nIf you remove a user from your IdP, they remain logged in to n8n. You need to manually remove them from n8n as well. Refer to [Manage users](https://docs.n8n.io/user-management/manage-users/) for guidance on deleting users."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.5/",
"markdown": "# Calculating booked orders | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.5.md \"Edit this page\")\n\nIn this step of the workflow you will learn how n8n structures data and how to add custom JavaScript code to perform calculations using the Code node. After this step, your workflow should look like this:\n\nThe next step in Nathan's workflow is to calculate two values from the booked orders:\n\n* The total number of booked orders\n* The total value of all booked orders\n\nTo calculate data and add more functionality to your workflows you can use the Code node, which lets you write custom JavaScript code.\n\n## About the Code node[#](#about-the-code-node \"Permanent link\")\n\nCode node modes\n\nThe Code node has two operational **modes**, depending on how you want to process items:\n\n* **Run Once for All Items** allows you to write code to process all input items at once, as a group.\n* **Run Once for Each Item** executes your code once for each input item.\n\nLearn more about how to use the [Code node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/).\n\nIn n8n, the data that's passed between nodes is an array of objects with the following JSON structure:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 | `[ { \t \"json\": { \t\t \"apple\": \"beets\", \t\t \"carrot\": { \t\t\t \"dill\": 1 \t\t } \t }, \t \"binary\": { \t\t \"apple-picture\": { \t\t\t \"data\": \"....\", \t\t\t \"mimeType\": \"image/png\", \t\t\t \"fileExtension\": \"png\", \t\t\t \"fileName\": \"example.png\", \t\t } \t } }, ... ]` |\n\nYou can learn more about the expected format on the [n8n data structure](https://docs.n8n.io/data/data-structure/) page.\n\n## Configure the Code node[#](#configure-the-code-node \"Permanent link\")\n\nNow let's see how to accomplish Nathan's task using the Code node.\n\nIn your workflow, add a **Code node** connected to the `false` branch of the **If node**.\n\nWith the Code node window open, configure these parameters:\n\n* **Mode**: Select **Run Once for All Items**.\n* **Language**: Select **JavaScript**.\n \n Using Python in code nodes\n \n While we use JavaScript below, you can also use Python in the Code node. To learn more, refer to the [Code node](https://docs.n8n.io/code/code-node/) documentation.\n \n* Copy the Code below and paste it into the **Code** box to replace the existing code:\n \n | | |\n | --- | --- |\n | | `let items = $input.all(); let totalBooked = items.length; let bookedSum = 0; for (let i=0; i < items.length; i++) { bookedSum = bookedSum + items[i].json.orderPrice; } return [{ json: {totalBooked, bookedSum} }];` |\n \n\nNotice the format in which we return the results of the calculation:\n\n| | |\n| --- | --- |\n| | `return [{ json: {totalBooked, bookedSum} }]` |\n\nData structure error\n\nIf you don't use the correct data structure, you will get an error message: `Error: Always an Array of items has to be returned!`\n\nNow select **Execute step** and you should see the following results:\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-five/l1-c5-5-5-code-node.png)\n\n_Code node output_\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**Nathan 🙋**: Wow, the Code node is powerful! This means that if I have some basic JavaScript skills I can power up my workflows.\n\n**You 👩🔧**: Yes! You can progress from no-code to low-code!\n\n**Nathan 🙋**: Now, how do I send the calculations for the booked orders to my team's Discord channel?\n\n**You 👩🔧**: There's an n8n node for that. I'll set it up in the next step."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.6/",
"markdown": "# Notifying the team | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.6.md \"Edit this page\")\n\nIn this step of the workflow, you will learn how to send messages to a Discord channel using the [Discord node](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.discord/). After this step, your workflow should look like this:\n\nNow that you have a calculated summary of the booked orders, you need to notify Nathan's team in their Discord channel. For this workflow, you will send messages to the [n8n server](https://discord.gg/G98WXzsjky) on Discord.\n\nBefore you begin the steps below, use the link above to connect to the n8n server on Discord. Be sure you can access the `#course-level-1` channel.\n\nCommunication app nodes\n\nYou can replace the Discord node with another communication app. For example, n8n also has nodes for [Slack](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.slack/) and [Mattermost](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mattermost/).\n\nIn your workflow, add a Discord node connected to the Code node.\n\nWhen you search for the Discord node, look for **Message Actions** and select **Send a message** to add the node.\n\nIn the Discord node window, configure these parameters:\n\n* **Connection Type**: Select **Webhook**.\n* **Credential for Discord Webhook**: Select **\\- Create New Credential -**.\n * Copy the **Webhook URL** from the email you received when you signed up for this course and paste it into the **Webhook URL** field of the credentials.\n * Select **Save** and then close the credentials dialog.\n* **Operation**: Select **Send a Message**.\n* **Message**:\n * Select the **Expression** tab on the right side of the Message field.\n * Copy the text below and paste it into the **Expression** window, or construct it manually using the **Expression Editor**.\n \n | | |\n | --- | --- |\n | | `This week we've {{$json[\"totalBooked\"]}} booked orders with a total value of {{$json[\"bookedSum\"]}}. My Unique ID: {{ $('HTTP Request').params[\"headerParameters\"][\"parameters\"][0][\"value\"] }}` |\n \n\nNow select **Execute step** in the Discord node. If all works well, you should see this output in n8n:\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-five/l1-c5-5-6-discord-output.png)\n\n_Discord node output_\n\nAnd your message should appear in the Discord channel #course-level-1:\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-two/discord-output.png)\n\n_Discord message_\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**Nathan 🙋**: Incredible, you've saved me hours of tedious work already! Now I can execute this workflow when I need it. I just need to remember to run it every Monday morning at 9 AM.\n\n**You 👩🔧**: Don't worry about that, you can actually schedule the workflow to run on a specific day, time, or interval. I'll set this up in the next step."
},
{
"url": "https://docs.n8n.io/flow-logic/merging/",
"markdown": "# Merging data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/merging.md \"Edit this page\")\n\nMerging brings multiple data streams together. You can achieve this using different nodes depending on your workflow requirements.\n\n* Merge data from different data streams or nodes: Use the [Merge](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/) node to combine data from various sources into one.\n* Merge data from multiple node executions: Use the [Code](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/) node for complex scenarios where you need to merge data from multiple executions of a node or multiple nodes.\n* Compare and merge data: Use the [Compare Datasets](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets/) node to compare, merge, and output data streams based on the comparison.\n\nExplore each method in more detail in the sections below.\n\n## Merge data from different data streams[#](#merge-data-from-different-data-streams \"Permanent link\")\n\nIf your workflow [splits](https://docs.n8n.io/flow-logic/splitting/), you combine the separate streams back into one stream.\n\nHere's an [example workflow](https://n8n.io/workflows/1747-joining-different-datasets/) showing different types of merging: appending data sets, keeping only new items, and keeping only existing items. The [Merge node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/) documentation contains details on each of the merge operations.\n\n## Merge data from different nodes[#](#merge-data-from-different-nodes \"Permanent link\")\n\nYou can use the Merge node to combine data from two previous nodes, even if the workflow hasn't split into separate data streams. This can be useful if you want to generate a single dataset from the data generated by multiple nodes.\n\n\n\nMerging data from two previous nodes\n\n## Merge data from multiple node executions[#](#merge-data-from-multiple-node-executions \"Permanent link\")\n\nUse the Code node to merge data from multiple node executions. This is useful in some [Looping](https://docs.n8n.io/flow-logic/looping/) scenarios.\n\nNode executions and workflow executions\n\nThis section describes merging data from multiple node executions. This is when a node executes multiple times during a single workflow execution.\n\nRefer to this [example workflow](https://n8n.io/workflows/1814-merge-multiple-runs-into-one/) using Loop Over Items and Wait to artificially create multiple executions.\n\n## Compare, merge, and split again[#](#compare-merge-and-split-again \"Permanent link\")\n\nThe [Compare Datasets](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets/) node compares data streams before merging them. It outputs up to four different data streams.\n\nRefer to this [example workflow](https://n8n.io/workflows/1943-comparing-data-with-the-compare-datasets-node/) for an example."
},
{
"url": "https://docs.n8n.io/flow-logic/looping/",
"markdown": "# Looping | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/looping.md \"Edit this page\")\n\nLooping is useful when you want to process multiple items or perform an action repeatedly, such as sending a message to every contact in your address book. n8n handles this repetitive processing automatically, meaning you don't need to specifically build loops into your workflows. There are [some nodes](#node-exceptions) where this isn't true.\n\n## Using loops in n8n[#](#using-loops-in-n8n \"Permanent link\")\n\nn8n nodes take any number of items as input, process these items, and output the results. You can think of each item as a single data point, or a single row in the output table of a node.\n\n\n\nNodes usually run once for each item. For example, if you wanted to send the name and notes of the customers in the Customer Datastore node as a message on Slack, you would:\n\n1. Connect the Slack node to the Customer Datastore node.\n2. Configure the parameters.\n3. Execute the node.\n\nYou would receive five messages: one for each item.\n\nThis is how you can process multiple items without having to explicitly connect nodes in a loop.\n\n### Executing nodes once[#](#executing-nodes-once \"Permanent link\")\n\nFor situations where you don't want a node to process all received items, for example sending a Slack message only to the first customer, you can do so by toggling the **Execute Once** parameter in the **Settings** tab of that node This setting is helpful when the incoming data contains multiple items and you want to only process the first one.\n\n## Creating loops[#](#creating-loops \"Permanent link\")\n\nn8n typically handles the iteration for all incoming items. However, there are certain scenarios where you will have to create a loop to iterate through all items. Refer to [Node exceptions](#node-exceptions) for a list of nodes that don't automatically iterate over all incoming items.\n\n### Loop until a condition is met[#](#loop-until-a-condition-is-met \"Permanent link\")\n\nTo create a loop in an n8n workflow, connect the output of one node to the input of a previous node. Add an [IF](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) node to check when to stop the loop.\n\nHere is an [example workflow](https://n8n.io/workflows/1130) that implements a loop with an `IF` node:\n\n\n\n### Loop until all items are processed[#](#loop-until-all-items-are-processed \"Permanent link\")\n\nUse the [Loop Over Items](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/) node when you want to loop until all items are processed. To process each item individually, set **Batch Size** to `1`.\n\nYou can batch the data in groups and process these batches. This approach is useful for avoiding API rate limits when processing large incoming data or when you want to process a specific group of returned items.\n\nThe Loop Over Items node stops executing after all the incoming items get divided into batches and passed on to the next node in the workflow so it's not necessary to add an IF node to stop the loop.\n\n## Node exceptions[#](#node-exceptions \"Permanent link\")\n\nNodes and operations where you need to design a loop into your workflow:\n\n* [CrateDB](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.cratedb/) executes once for `insert` and `update`.\n* [Code](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/) node in **Run Once for All Items** mode: processes all the items based on the entered code snippet.\n* [Execute Workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) node in **Run Once for All Items** mode.\n* [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/): you must handle pagination yourself. If your API call returns paginated results you must create a loop to fetch one page at a time.\n* [Microsoft SQL](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.microsoftsql/) executes once for `insert`, `update`, and `delete`.\n* [MongoDB](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.mongodb/) executes once for `insert` and `update`.\n* [QuestDB](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.questdb/) executes once for `insert`.\n* [Redis](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.redis/):\n * Info: this operation executes only once, regardless of the number of items in the incoming data.\n* [RSS Read](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.rssfeedread/) executes once for the requested URL.\n* [TimescaleDB](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.timescaledb/) executes once for `insert` and `update`."
},
{
"url": "https://docs.n8n.io/flow-logic/",
"markdown": "# Flow logic | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/index.md \"Edit this page\")\n\nn8n allows you to represent complex logic in your workflows.\n\nThis section covers:\n\n* [Splitting with conditionals](https://docs.n8n.io/flow-logic/splitting/)\n* [Merging data](https://docs.n8n.io/flow-logic/merging/)\n* [Looping](https://docs.n8n.io/flow-logic/looping/)\n* [Waiting](https://docs.n8n.io/flow-logic/waiting/)\n* [Sub-workflows](https://docs.n8n.io/flow-logic/subworkflows/)\n* [Error handling](https://docs.n8n.io/flow-logic/error-handling/)\n* [Execution order in multi-branch workflows](https://docs.n8n.io/flow-logic/execution-order/)\n\n## Related sections[#](#related-sections \"Permanent link\")\n\nYou need some understanding of [Data](https://docs.n8n.io/data/) in n8n, including [Data structure](https://docs.n8n.io/data/data-structure/) and [Data flow within nodes](https://docs.n8n.io/data/data-flow-nodes/).\n\nWhen building your logic, you'll use n8n's [Core nodes](https://docs.n8n.io/integrations/builtin/core-nodes/), including:\n\n* Splitting: [IF](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) and [Switch](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.switch/).\n* Merging: [Merge](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/), [Compare Datasets](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets/), and [Code](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/).\n* Looping: [IF](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) and [Loop Over Items](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/).\n* Waiting: [Wait](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.wait/).\n* Creating sub-workflows: [Execute Workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) and [Execute Workflow Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger/).\n* Error handling: [Stop And Error](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror/) and [Error Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger/)."
},
{
"url": "https://docs.n8n.io/flow-logic/splitting/",
"markdown": "# Splitting with conditionals | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/splitting.md \"Edit this page\")\n\n## Splitting workflows with conditional nodes[#](#splitting-workflows-with-conditional-nodes \"Permanent link\")\n\nSplitting uses the [IF](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) or [Switch](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.switch/) nodes. It turns a single-branch workflow into a multi-branch workflow. This is a key piece of representing complex logic in n8n.\n\nCompare these workflows:\n\n[](https://docs.n8n.io/_images/flow-logic/splitting/single-multi-branch-workflow.png)\n\nThis is the power of splitting and conditional nodes in n8n.\n\nRefer to the [IF](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.if/) or [Switch](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.switch/) documentation for usage details."
},
{
"url": "https://docs.n8n.io/flow-logic/subworkflows/",
"markdown": "# Sub-workflows | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/subworkflows.md \"Edit this page\")\n\nYou can call one workflow from another workflow. This allows you to build modular, microservice-like workflows. It can also help if your workflow grows large enough to encounter [memory issues](https://docs.n8n.io/hosting/scaling/memory-errors/). Creating sub-workflows uses the [Execute Workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) and [Execute Sub-workflow Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger/) nodes.\n\nSub-wokflow executions don't count towards your plan's monthly execution or active workflow limits.\n\n## Set up and use a sub-workflow[#](#set-up-and-use-a-sub-workflow \"Permanent link\")\n\nThis section walks through setting up both the parent workflow and sub-workflow.\n\n### Create the sub-workflow[#](#create-the-sub-workflow \"Permanent link\")\n\n1. Create a new workflow.\n \n Create sub-workflows from existing workflows\n \n You can optionally create a sub-workflow directly from an existing parent workflow using the [Execute Sub-workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) node. In the node, select the **Database** and **From list** options and select **Create a sub-workflow** in the list.\n \n You can also extract selected nodes directly using [Sub-workflow conversion](https://docs.n8n.io/workflows/subworkflow-conversion/) in the context menu.\n \n2. **Optional**: configure which workflows can call the sub-workflow:\n \n 1. Select the **Options**  menu > **Settings**. n8n opens the **Workflow settings** modal.\n 2. Change the **This workflow can be called by** setting. Refer to [Workflow settings](https://docs.n8n.io/workflows/settings/) for more information on configuring your workflows.\n3. Add the **Execute Sub-workflow** trigger node (if you are searching under trigger nodes, this is also titled **When Executed by Another Workflow**).\n4. Set the **Input data mode** to choose how you will define the sub-workflow's input data:\n * **Define using fields below**: Choose this mode to define individual input names and data types that the calling workflow needs to provide. The [Execute Sub-workflow node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) or [Call n8n Workflow Tool node](https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow/) in the calling workflow will automatically pull in the fields defined here.\n * **Define using JSON example**: Choose this mode to provide an example JSON object that demonstrates the expected input items and their types.\n * **Accept all data**: Choose this mode to accept all data unconditionally. The sub-workflow won't define any required input items. This sub-workflow must handle any input inconsistencies or missing values.\n5. Add other nodes as needed to build your sub-workflow functionality.\n6. Save the sub-workflow.\n\nSub-workflow mustn't contain errors\n\nIf there are errors in the sub-workflow, the parent workflow can't trigger it.\n\nLoad data into sub-workflow before building\n\nThis requires the ability to [load data from previous executions](https://docs.n8n.io/workflows/executions/debug/), which is available on n8n Cloud and registered Community plans.\n\nIf you want to load data into your sub-workflow to use while building it:\n\n1. Create the sub-workflow and add the **Execute Sub-workflow Trigger**.\n2. Set the node's **Input data mode** to **Accept all data** or define the input items using fields or JSON if they're already known.\n3. In the sub-workflow [settings](https://docs.n8n.io/workflows/settings/), set **Save successful production executions** to **Save**.\n4. Skip ahead to setting up the parent workflow, and run it.\n5. Follow the steps to [load data from previous executions](https://docs.n8n.io/workflows/executions/debug/).\n6. Adjust the **Input data mode** to match the input sent by the parent workflow if necessary.\n\nYou can now pin example data in the trigger node, enabling you to work with real data while configuring the rest of the workflow.\n\n### Call the sub-workflow[#](#call-the-sub-workflow \"Permanent link\")\n\n1. Open the workflow where you want to call the sub-workflow.\n2. Add the **Execute Sub-workflow** node.\n3. In the **Execute Sub-workflow** node, set the sub-workflow you want to call. You can choose to call the workflow by ID, load a workflow from a local file, add workflow JSON as a parameter in the node, or target a workflow by URL.\n \n Find your workflow ID\n \n Your sub-workflow's ID is the alphanumeric string at the end of its URL.\n \n4. Fill in the required input items defined by the sub-workflow.\n \n5. Save your workflow.\n\nWhen your workflow executes, it will send data to the sub-workflow, and run it.\n\nYou can follow the execution flow from the parent workflow to the sub-workflow by opening the Execute Sub-workflow node and selecting the **View sub-execution** link. Likewise, the sub-workflow's execution contains a link back to the parent workflow's execution to navigate in the other direction.\n\n## How data passes between workflows[#](#how-data-passes-between-workflows \"Permanent link\")\n\nAs an example, imagine you have an Execute Sub-workflow node in **Workflow A**. The Execute Sub-workflow node calls another workflow called **Workflow B**:\n\n1. The Execute Sub-workflow node passes the data to the Execute Sub-workflow Trigger node (titled \"When executed by another node\" in the canvas) of **Workflow B**.\n2. The last node of **Workflow B** sends the data back to the Execute Sub-workflow node in **Workflow A**.\n\n## Sub-workflow conversion[#](#sub-workflow-conversion \"Permanent link\")\n\nSee [sub-workflow conversion](https://docs.n8n.io/workflows/subworkflow-conversion/) for how to divide your existing workflows into sub-workflows."
},
{
"url": "https://docs.n8n.io/flow-logic/waiting/",
"markdown": "# Waiting | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/waiting.md \"Edit this page\")\n\nWaiting allows you to pause a workflow mid-execution, then resume where the workflow left off, with the same data. This is useful if you need to rate limit your calls to a service, or wait for an external event to complete. You can wait for a specified duration, or until a webhook fires.\n\nMaking a workflow wait uses the [Wait](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.wait/) node. Refer to the node documentation for usage details.\n\nn8n provides a workflow template with a basic example of [Rate limiting and waiting for external events](https://n8n.io/workflows/1749-rate-limiting-and-waiting-for-external-events/)."
},
{
"url": "https://docs.n8n.io/flow-logic/error-handling/",
"markdown": "# Error handling | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/error-handling.md \"Edit this page\")\n\nWhen designing your flow logic, it's a good practice to consider potential errors, and set up methods to handle them gracefully. With an error workflow, you can control how n8n responds to a workflow execution failure.\n\n## Create and set an error workflow[#](#create-and-set-an-error-workflow \"Permanent link\")\n\nFor each workflow, you can set an error workflow in **Workflow Settings**. It runs if an execution fails. This means you can, for example, send email or Slack alerts when a workflow execution errors. The error workflow must start with the [Error Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger/).\n\nYou can use the same error workflow for multiple workflows.\n\n1. Create a new workflow, with the Error Trigger as the first node.\n2. Give the workflow a name, for example `Error Handler`.\n3. Select **Save**.\n4. In the workflow where you want to use this error workflow:\n 1. Select **Options**  > **Settings**.\n 2. In **Error workflow**, select the workflow you just created. For example, if you used the name Error Handler, select **Error handler**.\n 3. Select **Save**. Now, when this workflow errors, the related error workflow runs.\n\n## Error data[#](#error-data \"Permanent link\")\n\nThe default error data received by the Error Trigger is:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 | `[ \t{ \t\t\"execution\": { \t\t\t\"id\": \"231\", \t\t\t\"url\": \"https://n8n.example.com/execution/231\", \t\t\t\"retryOf\": \"34\", \t\t\t\"error\": { \t\t\t\t\"message\": \"Example Error Message\", \t\t\t\t\"stack\": \"Stacktrace\" \t\t\t}, \t\t\t\"lastNodeExecuted\": \"Node With Error\", \t\t\t\"mode\": \"manual\" \t\t}, \t\t\"workflow\": { \t\t\t\"id\": \"1\", \t\t\t\"name\": \"Example Workflow\" \t\t} \t} ]` |\n\nAll information is always present, except:\n\n* `execution.id`: requires the execution to be saved in the database. Not present if the error is in the trigger node of the main workflow, as the workflow doesn't execute.\n* `execution.url`: requires the execution to be saved in the database. Not present if the error is in the trigger node of the main workflow, as the workflow doesn't execute.\n* `execution.retryOf`: only present when the execution is a retry of a failed execution.\n\nIf the error is caused by the trigger node of the main workflow, rather than a later stage, the data sent to the error workflow is different. There's less information in `execution{}` and more in `trigger{}`:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 | `{ \"trigger\": { \"error\": { \"context\": {}, \"name\": \"WorkflowActivationError\", \"cause\": { \"message\": \"\", \"stack\": \"\" }, \"timestamp\": 1654609328787, \"message\": \"\", \"node\": { . . . } }, \"mode\": \"trigger\" }, \"workflow\": { \"id\": \"\", \"name\": \"\" } }` |\n\n## Cause a workflow execution failure using Stop And Error[#](#cause-a-workflow-execution-failure-using-stop-and-error \"Permanent link\")\n\nWhen you create and set an error workflow, n8n runs it when an execution fails. Usually, this is due to things like errors in node settings, or the workflow running out of memory.\n\nYou can add the [Stop And Error](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror/) node to your workflow to force executions to fail under your chosen circumstances, and trigger the error workflow."
},
{
"url": "https://docs.n8n.io/flow-logic/execution-order/",
"markdown": "# Execution order in multi-branch workflows\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/flow-logic/execution-order.md \"Edit this page\")\n\nn8n's node execution order depends on the version of n8n you're using:\n\n* For workflows created before version 1.0: n8n executes the first node of each branch, then the second node of each branch, and so on.\n* For workflows created in version 1.0 and above: executes each branch in turn, completing one branch before starting another. n8n orders the branches based on their position on the [canvas](https://docs.n8n.io/glossary/#canvas-n8n), from topmost to bottommost. If two branches are at the same height, the leftmost branch executes first.\n\nYou can change the execution order in your [workflow settings](https://docs.n8n.io/workflows/settings/)."
},
{
"url": "https://docs.n8n.io/data/",
"markdown": "# Data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/index.md \"Edit this page\")\n\nData is the information that n8n nodes receive and process. For basic usage of n8n you don't need to understand data structures and manipulation. However, it becomes important if you want to:\n\n* Create your own node\n* Write custom [expressions](https://docs.n8n.io/glossary/#expression-n8n)\n* Use the Function or Function Item node\n\nThis section covers:\n\n* [Data structure](https://docs.n8n.io/data/data-structure/)\n* [Data flow within nodes](https://docs.n8n.io/data/data-flow-nodes/)\n* [Transforming data](https://docs.n8n.io/data/transforming-data/)\n* [Process data using code](https://docs.n8n.io/data/code/)\n* [Pinning](https://docs.n8n.io/data/data-pinning/) and [editing](https://docs.n8n.io/data/data-editing/) data during workflow development.\n* [Data mapping](https://docs.n8n.io/data/data-mapping/) and [Item linking](https://docs.n8n.io/data/data-mapping/data-item-linking/): how data items link to each other.\n\n### Data transformation nodes[#](#data-transformation-nodes \"Permanent link\")\n\nn8n provides a collection of nodes to transform data:\n\n* [Aggregate](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.aggregate/): take separate items, or portions of them, and group them together into individual items.\n* [Limit](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.aggregate/): remove items beyond a defined maximum number.\n* [Remove Duplicates](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.removeduplicates/): identify and delete items that are identical across all fields or a subset of fields.\n* [Sort](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.sort/): organize lists of in a desired ordering, or generate a random selection.\n* [Split Out](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitout/): separate a single data item containing a list into multiple items.\n* [Summarize](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.summarize/): aggregate items together, in a manner similar to Excel pivot tables."
},
{
"url": "https://docs.n8n.io/data/data-structure/",
"markdown": "# Data structure | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-structure.md \"Edit this page\")\n\nIn n8n, all data passed between nodes is an array of objects. It has the following structure:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 | `[ \t{ \t\t// For most data: \t\t// Wrap each item in another object, with the key 'json' \t\t\"json\": { \t\t\t// Example data \t\t\t\"apple\": \"beets\", \t\t\t\"carrot\": { \t\t\t\t\"dill\": 1 \t\t\t} \t\t}, \t\t// For binary data: \t\t// Wrap each item in another object, with the key 'binary' \t\t\"binary\": { \t\t\t// Example data \t\t\t\"apple-picture\": { \t\t\t\t\"data\": \"....\", // Base64 encoded binary data (required) \t\t\t\t\"mimeType\": \"image/png\", // Best practice to set if possible (optional) \t\t\t\t\"fileExtension\": \"png\", // Best practice to set if possible (optional) \t\t\t\t\"fileName\": \"example.png\", // Best practice to set if possible (optional) \t\t\t} \t\t} \t}, ]` |\n\nSkipping the `json` key and array syntax\n\nFrom 0.166.0 on, when using the Function node or Code node, n8n automatically adds the `json` key if it's missing. It also automatically wraps your items in an array (`[]`) if needed. This is only the case when using the Function or Code nodes. When building your own nodes, you must still make sure the node returns data with the `json` key.\n\n## Data item processing[#](#data-item-processing \"Permanent link\")\n\nNodes can process multiple items.\n\nFor example, if you set the Trello node to `Create-Card`, and create an expression that sets `Name` using a property called `name-input-value` from the incoming data, the node creates a card for each item, always choosing the `name-input-value` of the current item.\n\nFor example, this input will create two cards. One named `test1` the other one named `test2`:\n\n| | |\n| --- | --- |\n| | `[ \t{ \t\tname-input-value: \"test1\" \t}, \t{ \t\tname-input-value: \"test2\" \t} ]` |"
},
{
"url": "https://docs.n8n.io/data/data-flow-nodes/",
"markdown": "# Data flow within nodes | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-flow-nodes.md \"Edit this page\")\n\nNodes can process multiple items.\n\nFor example, if you set the Trello node to `Create-Card`, and create an expression that sets `Name` using a property called `name-input-value` from the incoming data, the node creates a card for each item, always choosing the `name-input-value` of the current item.\n\nFor example, this input will create two cards. One named `test1` the other one named `test2`:\n\n| | |\n| --- | --- |\n| | `[ \t{ \t\tname-input-value: \"test1\" \t}, \t{ \t\tname-input-value: \"test2\" \t} ]` |"
},
{
"url": "https://docs.n8n.io/data/code/",
"markdown": "# Process data using code | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/code.md \"Edit this page\")\n\n## Processing data with code[#](#processing-data-with-code \"Permanent link\")\n\n## Function[#](#function \"Permanent link\")\n\nA function is a block of code designed to perform a certain task. In n8n, you can write custom JavaScript or Python code snippets to add, remove, and update the data you receive from a node.\n\nThe [Code](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/) node gives you access to the incoming data and you can manipulate it. With this node you can create any function you want using JavaScript code."
},
{
"url": "https://docs.n8n.io/data/transforming-data/",
"markdown": "# Transforming data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/transforming-data.md \"Edit this page\")\n\nn8n uses a predefined [data structure](https://docs.n8n.io/data/data-structure/) that allows all nodes to process incoming data correctly.\n\nYour incoming data may have a different data structure, in which case you will need to transform it to allow each item to be processed individually.\n\nFor example, the image below shows the output of an [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node that returns data incompatible with n8n's data structure. The node returns the data and displays that only one item was returned.\n\n\n\nTo transform this kind of structure into the n8n data structure you can use the data transformation nodes:\n\n* [Aggregate](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.aggregate/): take separate items, or portions of them, and group them together into individual items.\n* [Limit](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.limit/): remove items beyond a defined maximum number.\n* [Remove Duplicates](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.removeduplicates/): identify and delete items that are identical across all fields or a subset of fields.\n* [Sort](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.sort/): organize lists of in a desired ordering, or generate a random selection.\n* [Split Out](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitout/): separate a single data item containing a list into multiple items.\n* [Summarize](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.summarize/): aggregate items together, in a manner similar to Excel pivot tables."
},
{
"url": "https://docs.n8n.io/data/data-mapping/",
"markdown": "# Data mapping | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/index.md \"Edit this page\")\n\nData mapping means referencing data from previous nodes.\n\nThis section contains guidance on:\n\n* Mapping data in most scenarios: [Data mapping in the UI](https://docs.n8n.io/data/data-mapping/data-mapping-ui/) and [Data mapping in expression](https://docs.n8n.io/data/data-mapping/data-mapping-expressions/)\n* How to handle [item linking](https://docs.n8n.io/data/data-mapping/data-item-linking/) when using the Code node or building your own nodes."
},
{
"url": "https://docs.n8n.io/data/data-mapping/data-mapping-expressions/",
"markdown": "# Data mapping in the expressions editor\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/data-mapping-expressions.md \"Edit this page\")\n\nThese examples show how to access linked items in the expressions editor. Refer to [expressions](https://docs.n8n.io/code/expressions/) for more information on expressions, including built in variables and methods.\n\nFor information on errors with mapping and linking items, refer to [Item linking errors](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/).\n\n## Access the linked item in a previous node's output[#](#access-the-linked-item-in-a-previous-nodes-output \"Permanent link\")\n\nWhen you use this, n8n works back up the item linking chain, to find the parent item in the given node.\n\n| | |\n| --- | --- |\n| | `// Returns the linked item {{$(\"\").item}}` |\n\nAs a longer example, consider a scenario where a node earlier in the workflow has the following output data:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 | `[ { \"id\": \"23423532\", \"name\": \"Jay Gatsby\", }, { \"id\": \"23423533\", \"name\": \"José Arcadio Buendía\", }, { \"id\": \"23423534\", \"name\": \"Max Sendak\", }, { \"id\": \"23423535\", \"name\": \"Zaphod Beeblebrox\", }, { \"id\": \"23423536\", \"name\": \"Edmund Pevensie\", } ]` |\n\nTo extract the name, use the following expression:\n\n| | |\n| --- | --- |\n| | `{{$(\"\").item.json.name}}` |\n\n### Access the linked item in the current node's input[#](#access-the-linked-item-in-the-current-nodes-input \"Permanent link\")\n\nIn this case, the item linking is within the node: find the input item that the node links to an output item.\n\n| | |\n| --- | --- |\n| | `// Returns the linked item {{$input.item}}` |\n\nAs a longer example, consider a scenario where the current node has the following input data:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 | `[ { \"id\": \"23423532\", \"name\": \"Jay Gatsby\", }, { \"id\": \"23423533\", \"name\": \"José Arcadio Buendía\", }, { \"id\": \"23423534\", \"name\": \"Max Sendak\", }, { \"id\": \"23423535\", \"name\": \"Zaphod Beeblebrox\", }, { \"id\": \"23423536\", \"name\": \"Edmund Pevensie\", } ]` |\n\nTo extract the name, you'd normally use drag-and-drop [Data mapping](https://docs.n8n.io/data/data-mapping/), but you could also write the following expression:\n\n| | |\n| --- | --- |\n| | `{{$input.item.json.name}}` |"
},
{
"url": "https://docs.n8n.io/data/data-mapping/data-mapping-ui/",
"markdown": "# Data mapping in the UI\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/data-mapping-ui.md \"Edit this page\")\n\nData mapping means referencing data from previous nodes. It doesn't include changing (transforming) data, just referencing it.\n\nYou can map data in the following ways:\n\n* Using the expressions editor.\n* By dragging and dropping data from the **INPUT** into parameters. This generates the expression for you.\n\nFor information on errors with mapping and linking items, refer to [Item linking errors](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/).\n\n## How to drag and drop data[#](#how-to-drag-and-drop-data \"Permanent link\")\n\n1. Run your workflow to load data.\n2. Open the node where you need to map data.\n3. You can map in table, JSON, and schema view:\n * In table view: click and hold a table heading to map top level data, or a field in the table to map nested data.\n * In JSON view: click and hold a key.\n * In schema view: click and hold a key.\n4. Drag the item into the field where you want to use the data.\n\n### Understand what you're mapping with drag and drop[#](#understand-what-youre-mapping-with-drag-and-drop \"Permanent link\")\n\nData mapping maps the key path, and loads the key's value into the field. For example, given the following data:\n\n| | |\n| --- | --- |\n| | `[ \t{ \t\t\"fruit\": \"apples\", \t\t\"color\": \"green\" \t} ]` |\n\nYou can map `fruit` by dragging and dropping **fruit** from the **INPUT** into the field where you want to use its value. This creates an expression, `{{ $json.fruit }}`. When the node iterates over input items, the value of the field becomes the value of `fruit` for each item.\n\n### Understand nested data[#](#understand-nested-data \"Permanent link\")\n\nGiven the following data:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 | `[ { \"name\": \"First item\", \"nested\": { \"example-number-field\": 1, \"example-string-field\": \"apples\" } }, { \"name\": \"Second item\", \"nested\": { \"example-number-field\": 2, \"example-string-field\": \"oranges\" } } ]` |\n\nn8n displays it in table form like this:\n\n"
},
{
"url": "https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-concepts/",
"markdown": "# Item linking concepts | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/data-item-linking/item-linking-concepts.md \"Edit this page\")\n\nEach output item created by a node includes metadata that links them to the input item (or items) that the node used to generate them. This creates a chain of items that you can work back along to access previous items. This can be complicated to understand, especially if the node splits or merges data. You need to understand item linking when building your own programmatic nodes, or in some scenarios using the Code node.\n\nThis document provides a conceptual overview of this feature. For usage details, refer to:\n\n* [Item linking for node creators](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-node-building/), for details on how to handle item linking when building a node.\n* [Item linking in the Code node](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-code-node/), to learn how to handle item linking in the Code node.\n* [Item linking errors](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/), to understand the errors you may encounter in the editor UI.\n\n## n8n's automatic item linking[#](#n8ns-automatic-item-linking \"Permanent link\")\n\nIf a node doesn't control how to link input items to output items, n8n tries to guess how to link the items automatically:\n\n* Single input, single output: the output links to the input.\n* Single input, multiple outputs: all outputs link to that input.\n* Multiple inputs and outputs:\n * If you keep the input items, but change the order (or remove some but keep others), n8n can automatically add the correct linked item information.\n * If the number of inputs and outputs is equal, n8n links the items in order. This means that output-1 links to input-1, output-2 to input-2, and so on.\n * If the number isn't equal, or you create completely new items, n8n can't automatically link items.\n\nIf n8n can't link items automatically, and the node doesn't handle the item linking, n8n displays an error. Refer to [Item linking errors](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/) for more information.\n\n## Item linking example[#](#item-linking-example \"Permanent link\")\n\n\n\nIn this example, it's possible for n8n to link an item in one node back several steps, despite the item order changing. This means the node that sorts movies alphabetically can access information about the linked item in the node that gets famous movie actors.\n\nThe methods for accessing linked items are different depending on whether you're using the UI, expressions, or the code node. Explore the following resources:\n\n* [Mapping in the UI](https://docs.n8n.io/data/data-mapping/data-mapping-ui/)\n* [Mapping in the expressions editor](https://docs.n8n.io/data/data-mapping/data-mapping-expressions/)\n* [Item linking in the Code node](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-code-node/)\n* [Item linking errors](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/)"
},
{
"url": "https://docs.n8n.io/data/data-mapping/data-item-linking/",
"markdown": "# Data item linking | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/data-item-linking/index.md \"Edit this page\")\n\nAn item is a single piece of data. Nodes receive one or more items, operate on them, and output new items. Each item links back to previous items.\n\nYou need to understand this behavior if you're:\n\n* Building a programmatic-style node that implements complex behaviors with its input and output data.\n* Using the Code node or expressions editor to access data from earlier items in the workflow.\n* Using the Code node for complex behaviors with input and output data.\n\nThis section provides:\n\n* A conceptual overview of [Item linking concepts](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-concepts/).\n* Information on [Item linking for node creators](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-node-building/).\n* Support for end users who need to [Work with the data path](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-code-node/) to retrieve item data from previous nodes, and link items when using the Code node.\n* Guidance on troubleshooting [Errors](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/)."
},
{
"url": "https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-errors/",
"markdown": "# Item linking errors | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/data-item-linking/item-linking-errors.md \"Edit this page\")\n\nIn n8n you can reference data from any previous node. This doesn't have to be the node just before: it can be any previous node in the chain. When referencing nodes further back, you use the expression syntax `$(node_name).item`.\n\n\n\nDiagram of threads for different items. Due to the item linking, you can get the actor for each movie using `$('Get famous movie actors').item`.\n\nSince the previous node can have multiple items in it, n8n needs to know which one to use. When using `.item`, n8n figures this out for you behind the scenes. Refer to [Item linking concepts](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-concepts/) for detailed information on how this works.\n\n`.item` fails if information is missing. To figure out which item to use, n8n maintains a thread back through the workflow's nodes for each item. For a given item, this thread tells n8n which items in previous nodes generated it. To find the matching item in a given previous node, n8n follows this thread back until it reaches the node in question.\n\nWhen using `.item`, n8n displays an error when:\n\n* The thread is broken\n* The thread points to more than one item in the previous node (as it's unclear which one to use)\n\nTo solve these errors, you can either avoid using `.item`, or fix the root cause.\n\nYou can avoid `.item` by using `.first()`, `.last()` or `.all()[index]` instead. They require you to know the position of the item that you’re targeting within the target node's output items. Refer to [Built in methods and variables | Output of other nodes](https://docs.n8n.io/code/builtin/output-other-nodes/) for more detail on these methods.\n\nThe fix for the root cause depends on the exact error.\n\n### Fix for 'Info for expressions missing from previous node'[#](#fix-for-info-for-expressions-missing-from-previous-node \"Permanent link\")\n\nIf you see this error message:\n\n> ERROR: Info for expression missing from previous node\n\nThere's a node in the chain that doesn't return pairing information. The solution here depends on the type of the previous node:\n\n* Code nodes: make sure you return which input items the node used to produce each output item. Refer to [Item linking in the code node](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-code-node/) for more information.\n* Custom or community nodes: the node creator needs to update the node to return which input items it uses to produce each output item. Refer to [Item linking for node creators](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-node-building/) for more information.\n\n### Fix for 'Multiple matching items for expression'[#](#fix-for-multiple-matching-items-for-expression \"Permanent link\")\n\nThis is the error message:\n\n> ERROR: Multiple matching items for expression\n\nSometimes n8n uses multiple items to create a single item. Examples include the Summarize, Aggregate, and Merge nodes. These nodes can combine information from multiple items.\n\nWhen you use `.item` and there are multiple possible matches, n8n doesn't know which one to use. To solve this you can either:\n\n* Use `.first()`, `.last()` or `.all()[index]` instead. Refer to [Built in methods and variables | Output of other nodes](https://docs.n8n.io/code/builtin/output-other-nodes/) for more detail on these methods.\n* Reference a different node that contains the same information, but doesn't have multiple matching items."
},
{
"url": "https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-code-node/",
"markdown": "# Item linking in the Code node\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mapping/data-item-linking/item-linking-code-node.md \"Edit this page\")\n\nUse n8n's item linking to access data from items that precede the current item. It also has implications when using the Code node. Most nodes link every output item to an input item. This creates a chain of items that you can work back along to access previous items. For a deeper conceptual overview of this topic, refer to [Item linking concepts](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-concepts/). This document focuses on practical usage examples.\n\nWhen using the Code node, there are some scenarios where you need to manually supply item linking information if you want to be able to use `$(\"\").item` later in the workflow. All these scenarios only apply if you have more than one incoming item. n8n automatically handles item linking for single items.\n\nThese scenarios are when you:\n\n* Add new items: the new items aren't linked to any input.\n* Return new items.\n* Want to manually control the item linking.\n\n[n8n's automatic item linking](https://docs.n8n.io/data/data-mapping/data-item-linking/item-linking-concepts/) handles the other scenarios.\n\nTo control item linking, set `pairedItem` when returning data. For example, to link to the item at index 0:\n\n| | |\n| --- | --- |\n| | `[ \t{ \t\t\"json\": { \t\t\t. . . \t\t}, \t\t// The index of the input item that generated this output item \t\t\"pairedItem\": 0 \t} ]` |\n\n### `pairedItem` usage example[#](#paireditem-usage-example \"Permanent link\")\n\nTake this input data:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 | `[ { \"id\": \"23423532\", \"name\": \"Jay Gatsby\" }, { \"id\": \"23423533\", \"name\": \"José Arcadio Buendía\" }, { \"id\": \"23423534\", \"name\": \"Max Sendak\" }, { \"id\": \"23423535\", \"name\": \"Zaphod Beeblebrox\" }, { \"id\": \"23423536\", \"name\": \"Edmund Pevensie\" } ]` |\n\nAnd use it to generate new items, containing just the name, along with a new piece of data:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14 | `newItems = []; for(let i=0; i 2
3
4
5
6
7
8
9
10
11
12
13
14 | `newItems = []; for(let i=0; i 2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 | `// Use the pairedItem information of the incoming item newItem = { \t\"json\": { . . . }, \t\"pairedItem\": { \t\t\"item\": item.pairedItem, \t\t// Optional: choose the input to use \t\t// Set this if your node combines multiple inputs \t\t\"input\": 0 }; // Or set the index manually newItem = { \t\t\"json\": { . . . } \t\t\"pairedItem\": { \t\t\t\"item\": i, \t\t\t// Optional: choose the input to use \t\t\t// Set this if your node combines multiple inputs \t\t\t\"input\": 0 \t\t}, };` |"
},
{
"url": "https://docs.n8n.io/data/data-editing/",
"markdown": "# Data editing | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-editing.md \"Edit this page\")\n\nn8n allows you to edit [pinned data](https://docs.n8n.io/data/data-pinning/). This means you can check different scenarios without setting up each scenario and sending the relevant data from your external system. It makes it easier to test edge cases.\n\nFor development only\n\nData editing isn't available for production workflow executions. It's a feature to help test workflows during development.\n\n## Edit output data[#](#edit-output-data \"Permanent link\")\n\nTo edit output data:\n\n1. Run the node to load data.\n2. In the **OUTPUT** view, select **JSON** to switch to JSON view.\n3. Select **Edit** .\n4. Edit your data.\n5. Select **Save**. n8n saves your data changes and pins your data.\n\n## Use data from previous executions[#](#use-data-from-previous-executions \"Permanent link\")\n\nYou can copy data from nodes in previous workflow executions:\n\n1. Open the left menu.\n2. Select **Executions**.\n3. Browse the workflow executions list to find the one with the data you want to copy.\n4. Select **Open Past Execution** .\n5. Double click the node whose data you want to copy.\n6. If it's table layout, select **JSON** to switch to JSON view.\n7. There are two ways to copy the JSON:\n8. Select the JSON you want by highlighting it, like selecting text. Then use `ctrl` + `c` to copy it.\n9. Select the JSON you want to copy by clicking on a parameter. Then:\n 1. Hover over the JSON. n8n displays the **Copy**  button.\n 2. Select **Copy** .\n 3. You can choose what to copy:\n * **Copy Item Path** and **Copy Parameter Path** gives you expressions that access parts of the JSON.\n * **Copy Value**: copies the entire selected JSON.\n10. Return to the workflow you're working on:\n 1. Open the left menu.\n 2. Select **Workflows**.\n 3. Select **Open**.\n 4. Select the workflow you want to open.\n11. Open the node where you want to use the copied data.\n12. If there is no data, run the node to load data.\n13. In the **OUTPUT** view, select **JSON** to switch to JSON view.\n14. Select **Edit** .\n15. Paste in the data from the previous execution.\n16. Select **Save**. n8n saves your data changes and pins your data."
},
{
"url": "https://docs.n8n.io/data/data-pinning/",
"markdown": "# Data pinning | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-pinning.md \"Edit this page\")\n\nYou can 'pin' data during workflow development. Data pinning means saving the output data of a node, and using the saved data instead of fetching fresh data in future workflow executions.\n\nYou can use this when working with data from external sources to avoid having to repeat requests to the external system. This can save time and resources:\n\n* If your workflow relies on an external system to trigger it, such as a webhook call, being able to pin data means you don't need to use the external system every time you test the workflow.\n* If the external resource has data or usage limits, pinning data during tests avoids consuming your resource limits.\n* You can fetch and pin the data you want to test, then have confidence that the data is consistent in all your workflow tests.\n\nYou can only pin data for nodes that have a single main output (\"error\" outputs don't count for this purpose).\n\nFor development only\n\nData pinning isn't available for production workflow executions. It's a feature to help test workflows during development.\n\n## Pin data[#](#pin-data \"Permanent link\")\n\nTo pin data in a node:\n\n1. Run the node to load data.\n2. In the **OUTPUT** view, select **Pin data** . When data pinning is active, the button is disabled and a \"This data is pinned\" banner is displayed in the **OUTPUT** view.\n\nNodes that output binary data\n\nYou can't pin data if the output data includes binary data.\n\n## Unpin data[#](#unpin-data \"Permanent link\")\n\nWhen data pinning is active, a banner appears at the top of the node's output panel indicating that n8n has pinned the data. To unpin data and fetch fresh data on the next execution, select the **Unpin** link in the banner."
},
{
"url": "https://docs.n8n.io/data/data-filtering/",
"markdown": "# Data filtering | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-filtering.md \"Edit this page\")\n\nFeature availability\n\nAvailable on Cloud Pro and Enterprise plans.\n\nSearch and filter data in the node **INPUT** and **OUTPUT** panels. Use this to check your node's data.\n\nTo search:\n\n1. In a node, select **Search**  in the **INPUT** or **OUTPUT** panel.\n2. Enter your search term.\n\nn8n filters as you type your search, displaying the objects or rows containing the term.\n\nFiltering is purely visual: n8n doesn't change or delete data. The filter resets when you close and reopen the node."
},
{
"url": "https://docs.n8n.io/data/binary-data/",
"markdown": "# Binary data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/binary-data.md \"Edit this page\")\n\nBinary data is any file-type data, such as image files or documents.\n\nThis page collects resources relating to binary data in n8n.\n\n## Working with binary data in your workflows[#](#working-with-binary-data-in-your-workflows \"Permanent link\")\n\nYou can process binary data in n8n workflows. n8n provides nodes to help you work with binary data. You can also use code.\n\n### Nodes[#](#nodes \"Permanent link\")\n\nThere are three key nodes dedicated to handling binary data files:\n\n* [Read/Write Files from Disk](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile/) to read and write files from/to the machine where n8n is running.\n* [Convert to File](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.converttofile/) to take input data and output it as a file.\n* [Extract From File](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/) to get data from a binary format and convert it to JSON.\n\nThere are separate nodes for working with XML and HTML data:\n\n* [HTML](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.html/)\n* [XML](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.xml/)\n\nAnd nodes for performing common tasks:\n\n* [Compression](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.compression/)\n* [Edit Image](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.editimage/)\n* [FTP](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.ftp/)\n\nYou can trigger a workflow based on changes to a local file using the [Local File trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.localfiletrigger/).\n\nTo split or concatenate binary data items, use the [data transformation nodes](https://docs.n8n.io/data/#data-transformation-nodes).\n\n### Code[#](#code \"Permanent link\")\n\nYou can use the [Code node](https://docs.n8n.io/code/code-node/) to manipulate binary data in your workflows. For example, [Get the binary data buffer](https://docs.n8n.io/code/cookbook/code-node/get-binary-data-buffer/): get the binary data available in your workflow.\n\n## Configure binary data mode when self-hosting[#](#configure-binary-data-mode-when-self-hosting \"Permanent link\")\n\nYou can configure how your self-hosted n8n instance handles binary data using the [Binary data environment variables](https://docs.n8n.io/hosting/configuration/environment-variables/binary-data/). This includes tasks such as setting the storage path and choosing how to store binary data.\n\nYour configuration affects how well n8n scales: [Scaling | Binary data filesystem mode](https://docs.n8n.io/hosting/scaling/binary-data/).\n\nReading and writing binary files can have security implications. If you want to disable reading and writing binary data, use the `NODES_EXCLUDE` environment variable. Refer to [Environment variables | Nodes](https://docs.n8n.io/hosting/configuration/environment-variables/nodes/) for more information."
},
{
"url": "https://docs.n8n.io/data/data-mocking/",
"markdown": "# Data mocking | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/data-mocking.md \"Edit this page\")\n\nData mocking is simulating or faking data. It's useful when developing a workflow. By mocking data, you can:\n\n* Avoid making repeated calls to your data source. This saves time and costs.\n* Work with a small, predictable dataset during initial development.\n* Avoid the risk of overwriting live data: in the early stages of building your workflow, you don't need to connect your real data source.\n\n## Mocking with real data using data pinning[#](#mocking-with-real-data-using-data-pinning \"Permanent link\")\n\nUsing [data pinning](https://docs.n8n.io/data/data-pinning/), you load real data into your workflow, then pin it in the output panel of a node. Using this approach you have realistic data, with only one call to your data source. You can [edit pinned data](https://docs.n8n.io/data/data-editing/).\n\nUse this approach when you need to configure your workflow to handle the exact data structure and parameters provided by your data source.\n\nTo pin data in a node:\n\n1. Run the node to load data.\n2. In the **OUTPUT** view, select **Pin data** . When data pinning is active, the button is disabled and a \"This data is pinned\" banner is displayed in the **OUTPUT** view.\n\nNodes that output binary data\n\nYou can't pin data if the output data includes binary data.\n\n## Generate custom data using the Code or Edit Fields nodes[#](#generate-custom-data-using-the-code-or-edit-fields-nodes \"Permanent link\")\n\nYou can create a custom dataset in your workflow using either the [Code node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/) or the [Edit Fields (Set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/).\n\nIn the Code node, you can create any data set you want, and return it as the node output. In the Edit Fields node, select **Add fields** to add your custom data.\n\nThe Edit Fields node is a good choice for small tests. To create more complex datasets, use the Code node.\n\n## Output a sample data set from the Customer Datastore node[#](#output-a-sample-data-set-from-the-customer-datastore-node \"Permanent link\")\n\nThe Customer Datastore node provides a fake dataset to work with. Add and execute the node to explore the data.\n\nUse this approach if you need some test data when exploring n8n, and you don't have a real use-case to work with."
},
{
"url": "https://docs.n8n.io/data/schema-preview/",
"markdown": "# Schema preview | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/data/schema-preview.md \"Edit this page\")\n\nSchema Preview exposes expected schema data from the previous node in the Node Editor without the user having to provide credentials or execute the node. This makes it possible to construct workflows without having to provide credentials in advance. The preview doesn't include mock data, but it does expose the expected fields, making it possible to select and incorporate them into the input of subsequent nodes.\n\n## Using the preview[#](#using-the-preview \"Permanent link\")\n\n1. There must be a node with Schema Preview available in your workflow.\n2. When clicking on the details of the next node in the sequence, the Schema Preview data will show up in the Node Editor where schema data would typically be exposed.\n3. Use data from the Schema Preview just as you would other schemas - drag and drop fields as input into your node parameters and settings."
},
{
"url": "https://docs.n8n.io/glossary/",
"markdown": "# n8n Glossary | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/glossary.md \"Edit this page\")\n\n#### AI agent[#](#ai-agent \"Permanent link\")\n\nAI agents are artificial intelligence systems capable of responding to requests, making decisions, and performing real-world tasks for users. They use large language models (LLMs) to interpret user input and make decisions about how to best process requests using the information and resources they have available.\n\n#### AI chain[#](#ai-chain \"Permanent link\")\n\nAI chains allow you to interact with large language models (LLMs) and other resources in sequences of calls to components. AI chains in n8n don't use persistent memory, so you can't use them to reference previous context (use AI agents for this).\n\n#### AI embedding[#](#ai-embedding \"Permanent link\")\n\nEmbeddings are numerical representations of data using vectors. They're used by AI to interpret complex data and relationships by mapping values across many dimensions. Vector databases, or vector stores, are databases designed to store and access embeddings.\n\n#### AI groundedness[#](#ai-groundedness \"Permanent link\")\n\nIn AI, and specifically in retrieval-augmented generation (RAG) contexts, groundedness and ungroundedness are measures of how much a model's responses accurately reflect source information. The model uses its source documents to generate grounded responses, while ungrounded responses involve speculation or hallucination unsupported by those same sources.\n\n#### AI reranking[#](#ai-reranking \"Permanent link\")\n\nReranking is a technique that refines the order of a list of candidate documents to improve the relevance of search results. Retrieval-Augmented Generation (RAG) and other applications use reranking to prioritize the most relevant information for generation or downstream tasks.\n\n#### AI memory[#](#ai-memory \"Permanent link\")\n\nIn an AI context, memory allows AI tools to persist message context across interactions. This allows you to have a continuing conversations with AI agents, for example, without submitting ongoing context with each message. In n8n, AI agent nodes can use memory, but AI chains can't.\n\n#### AI retrieval-augmented generation (RAG)[#](#ai-retrieval-augmented-generation-rag \"Permanent link\")\n\nRetrieval-augmented generation, or RAG, is a technique for providing LLMs access to new information from external sources to improve AI responses. RAG systems retrieve relevant documents to ground responses in up-to-date, domain-specific, or proprietary knowledge to supplement their original training data. RAG systems often rely on vector stores to manage and search this external data efficiently.\n\n#### AI tool[#](#ai-tool \"Permanent link\")\n\nIn an AI context, a tool is an add-on resource that the AI can refer to for specific information or functionality when responding to a request. The AI model can use a tool to interact with external systems or complete specific, focused tasks.\n\n#### AI vector store[#](#ai-vector-store \"Permanent link\")\n\nVector stores, or vector databases, are databases designed to store numerical representations of information called embeddings.\n\n#### API[#](#api \"Permanent link\")\n\nAPIs, or application programming interfaces, offer programmatic access to a service's data and functionality. APIs make it easier for software to interact with external systems. They're often offered as an alternative to traditional user-focused interfaces accessed through web browsers or UI.\n\n#### canvas (n8n)[#](#canvas-n8n \"Permanent link\")\n\nThe canvas is the main interface for building workflows in n8n's editor UI. You use the canvas to add and connect nodes to compose workflows.\n\n#### cluster node (n8n)[#](#cluster-node-n8n \"Permanent link\")\n\nIn n8n, cluster nodes are groups of nodes that work together to provide functionality in a workflow. They consist of a root node and one or more sub nodes that extend the node's functionality.\n\n#### credential (n8n)[#](#credential-n8n \"Permanent link\")\n\nIn n8n, credentials store authentication information to connect with specific apps and services. After creating credentials with your authentication information (username and password, API key, OAuth secrets, etc.), you can use the associated app node to interact with the service.\n\n#### data pinning (n8n)[#](#data-pinning-n8n \"Permanent link\")\n\nData pinning allows you to temporarily freeze the output data of a node during workflow development. This allows you to develop workflows with predictable data without making repeated requests to external services. Production workflows ignore pinned data and request new data on each execution.\n\n#### editor (n8n)[#](#editor-n8n \"Permanent link\")\n\nThe n8n editor UI allows you to create and manage workflows. The main area is the canvas, where you can compose workflows by adding, configuring, and connecting nodes. The side and top panels allow you to access other areas of the UI like credentials, templates, variables, executions, and more.\n\n#### entitlement (n8n)[#](#entitlement-n8n \"Permanent link\")\n\nIn n8n, entitlements grant n8n instances access to plan-restricted features for a specific period of time.\n\nFloating entitlements are a pool of entitlements that you can distribute among various n8n instances. You can re-assign a floating entitlement to transfer its access to a different n8n instance.\n\n#### evaluation (n8n)[#](#evaluation-n8n \"Permanent link\")\n\nIn n8n, evaluation allows you to tag and organize execution history and compare it against new executions. You can use this to understand how your workflow performs over time as you make changes. In particular, this is useful while developing AI-centered workflows.\n\n#### expression (n8n)[#](#expression-n8n \"Permanent link\")\n\nIn n8n, expressions allow you to populate node parameters dynamically by executing JavaScript code. Instead of providing a static value, you can use the n8n expression syntax to define the value using data from previous nodes, other workflows, or your n8n environment.\n\n#### LangChain[#](#langchain \"Permanent link\")\n\nLangChain is an AI-development framework used to work with large language models (LLMs). LangChain provides a standardized system for working with a wide variety of models and other resources and linking different components together to build complex applications.\n\n#### Large language model (LLM)[#](#large-language-model-llm \"Permanent link\")\n\nLarge language models, or LLMs, are AI machine learning models designed to excel in natural language processing (NLP) tasks. They're built by training on large amounts of data to develop probabilistic models of language and other data.\n\n#### node (n8n)[#](#node-n8n \"Permanent link\")\n\nIn n8n, nodes are individual components that you compose to create workflows. Nodes define when the workflow should run, allow you to fetch, send, and process data, can define flow control logic, and connect with external services.\n\n#### project (n8n)[#](#project-n8n \"Permanent link\")\n\nn8n projects allow you to separate workflows, variables, and credentials into separate groups for easier management. Projects make it easier for teams to collaborate by sharing and compartmentalizing related resources.\n\n#### root node (n8n)[#](#root-node-n8n \"Permanent link\")\n\nEach n8n cluster node contains a single root nodes that defines the main functionality of the cluster. One or more sub nodes attach to the root node to extend its functionality.\n\n#### sub node (n8n)[#](#sub-node-n8n \"Permanent link\")\n\nn8n cluster nodes consist of one or more sub nodes connected to a root node. Sub nodes extend the functionality of the root node, providing access to specific services or resources or offering specific types of dedicated processing, like calculator functionality, for example.\n\n#### template (n8n)[#](#template-n8n \"Permanent link\")\n\nn8n templates are pre-built workflows designed by n8n and community members that you can import into your n8n instance. When using templates, you may need to fill in credentials and adjust the configuration to suit your needs.\n\n#### trigger node (n8n)[#](#trigger-node-n8n \"Permanent link\")\n\nA trigger node is a special node responsible for executing the workflow in response to certain conditions. All production workflows need at least one trigger to determine when the workflow should run.\n\n#### workflow (n8n)[#](#workflow-n8n \"Permanent link\")\n\nAn n8n workflow is a collection of nodes that automate a process. Workflows begin execution when a trigger condition occurs and execute sequentially to achieve complex tasks."
},
{
"url": "https://docs.n8n.io/manage-cloud/overview/",
"markdown": "# Overview | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/overview.md \"Edit this page\")\n\n## n8n Cloud[#](#n8n-cloud \"Permanent link\")\n\nn8n Cloud is n8n's hosted solution. It provides:\n\n* No technical set up or maintenance for your n8n instance\n* Continual uptime monitoring\n* Managed OAuth for authentication\n* One-click upgrades to the newest n8n versions\n\n[Sign up for n8n Cloud](https://www.n8n.io/)"
},
{
"url": "https://docs.n8n.io/manage-cloud/cloud-free-trial/",
"markdown": "# Cloud free trial | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/cloud-free-trial.md \"Edit this page\")\n\nWhen you create a new n8n cloud trial, you have 14 days to try all the features of the [Pro plan](https://n8n.io/pricing/), including:\n\n* Global variables\n* Insights dashboard\n* Execution search\n* 5 days workflow history to rollback\n\nThe trial gives you Pro plan features with limits of 1000 executions, 5 active workflows, and the same computing power as the [Starter plan](https://n8n.io/pricing/).\n\n## Upgrade to a paid account[#](#upgrade-to-a-paid-account \"Permanent link\")\n\nYou can upgrade to a paid n8n account at any time. To upgrade:\n\n1. Log in to your account.\n2. Click the **Upgrade** button in the upper-right corner.\n3. Select your plan and whether to pay annually or by the month.\n4. Select a payment method.\n\n## Trial expiration[#](#trial-expiration \"Permanent link\")\n\nIf you don't upgrade by the end of your trial, the trial will automatically expire and your workspace will be deleted.\n\nDownload your workflows\n\nYou can [download your workflows](https://docs.n8n.io/manage-cloud/download-workflows/) to reuse them later. You have 90 days to download your workflows after your free trial ends.\n\n### Cancelling your trial[#](#cancelling-your-trial \"Permanent link\")\n\nYou don't need to cancel your trial. Your trial will automatically expire at the end of the trial period and no charges will occur. All your data will be deleted soon after.\n\n## Enterprise trial[#](#enterprise-trial \"Permanent link\")\n\nYou can contact the sales team if you want to test the [Enterprise plan](https://n8n.io/pricing/), which includes features such as:\n\n* SSO SAML and LDAP\n* Different environments\n* External secret store integration\n* Log streaming\n* Version control using Git\n\nClick the **Contact** button on the [n8n website](https://n8n.io/pricing/)."
},
{
"url": "https://docs.n8n.io/manage-cloud/cloud-admin-dashboard/",
"markdown": "# Access the Cloud admin dashboard\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/cloud-admin-dashboard.md \"Edit this page\")\n\nInstance owners can access the admin dashboard to manage their Cloud instance. This is where you can upgrade your n8n version and set the timezone.\n\n## Access the dashboard from the app[#](#access-the-dashboard-from-the-app \"Permanent link\")\n\n1. [Log in to n8n](https://app.n8n.cloud/magic-link)\n2. Select **Admin Dashboard**. n8n opens the dashboard.\n\n## Access the dashboard if the app is offline[#](#access-the-dashboard-if-the-app-is-offline \"Permanent link\")\n\nIf your instance is down, you can still access the admin dashboard. When you log in to the app, n8n will ask you if you want a magic link to access your dashboard. Select **Send magic link**, then check your email for the link."
},
{
"url": "https://docs.n8n.io/manage-cloud/update-cloud-version/",
"markdown": "# Update your n8n Cloud version\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/update-cloud-version.md \"Edit this page\")\n\nn8n recommends regularly updating your Cloud version. Check the [Release notes](https://docs.n8n.io/release-notes/) to learn more about changes.\n\nInfo\n\nOnly instance owners can upgrade n8n Cloud versions. Contact your instance owner if you don't have permission to update n8n Cloud.\n\n1. [Log in to the n8n Cloud dashboard](https://app.n8n.cloud/manage)\n2. On your dashboard, select **Manage**.\n3. Use the **n8n version** dropdown to select your preferred release version:\n * Latest Stable: recommended for most users.\n * Latest Beta: get the newest n8n. This may be unstable.\n4. Select **Save Changes** to restart your n8n instance and perform the update.\n5. In the confirmation modal, select **Confirm**.\n\n## Best practices for updating[#](#best-practices-for-updating \"Permanent link\")\n\n* Update frequently: this avoids having to jump multiple versions at once, reducing the risk of a disruptive update. Try to update at least once a month.\n* Check the [Release notes](https://docs.n8n.io/release-notes/) for breaking changes.\n* Use [Environments](https://docs.n8n.io/source-control-environments/) to create a test version of your instance. Test the update there first.\n\n## Automatic update[#](#automatic-update \"Permanent link\")\n\nn8n automatically updates outdated Cloud instances.\n\nIf you don't update you instance for 120 days, n8n emails you to warn you to update. After a further 30 days, n8n automatically updates your instance."
},
{
"url": "https://docs.n8n.io/manage-cloud/set-cloud-timezone/",
"markdown": "# Set the timezone | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/set-cloud-timezone.md \"Edit this page\")\n\n## Set the Cloud instance timezone[#](#set-the-cloud-instance-timezone \"Permanent link\")\n\nYou can change the timezone for your n8n instance. This affects the [Schedule Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/) and [Date & Time node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.datetime/). Users can configure the timezone for individual workflows in [Workflow settings](https://docs.n8n.io/workflows/settings/).\n\n1. On your dashboard, select **Manage**.\n2. Change the **Timezone** dropdown to the timezone you want."
},
{
"url": "https://docs.n8n.io/manage-cloud/cloud-ip/",
"markdown": "# Cloud IP addresses | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/cloud-ip.md \"Edit this page\")\n\nCloud IP addresses change without warning\n\nn8n can't guarantee static source IPs, as Cloud operates in a dynamic cloud provider environment and scales its infrastructure to meet demand. You should use strong authentication and secure transport protocols when connecting into and out of n8n.\n\nOutbound traffic may appear to originate from any of:\n\n* 20.79.227.226/32\n* 20.113.47.122/32\n* 20.218.202.73/32\n* 98.67.233.91/32\n* 4.182.111.50/32\n* 4.182.129.20/32\n* 4.182.88.118/32\n* 4.182.212.136/32\n* 98.67.244.108/32\n* 72.144.128.145/32\n* 72.144.83.147/32\n* 72.144.69.38/32\n* 72.144.111.50/32\n* 4.182.128.108/32\n* 4.182.190.144/32\n* 4.182.191.184/32\n* 98.67.233.200/32\n \n* 20.52.126.0/28\n \n* 20.218.238.112/28\n* 4.182.64.64/28\n* 20.218.174.0/28\n* 4.184.78.240/28\n* 20.79.32.32/28\n* 51.116.119.64/28"
},
{
"url": "https://docs.n8n.io/manage-cloud/cloud-data-management/",
"markdown": "# Cloud data management | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/cloud-data-management.md \"Edit this page\")\n\nThere are two concerns when managing data on Cloud:\n\n* Memory usage: complex workflows processing large amounts of data can exceed n8n's memory limits. If this happens, the instance can crash and become inaccessible.\n* Data storage: depending on your execution settings and volume, your n8n database can grow in size and run out of storage.\n\nTo avoid these issues, n8n recommends that you build your workflows with memory efficiency in mind, and don't save unnecessary data\n\n## Memory limits on each Cloud plan[#](#memory-limits-on-each-cloud-plan \"Permanent link\")\n\nCurrent plans:\n\n* Trial: 320MiB RAM, 10 millicore CPU burstable\n* Starter: 320MiB RAM, 10 millicore CPU burstable\n* Pro-1 (10k executions): 640MiB RAM, 20 millicore CPU burstable\n* Pro-2 (50k executions): 1280MiB RAM, 80 millicore CPU burstable\n* Enterprise: 4096MiB RAM, 80 millicore CPU burstable\n\nLegacy plans:\n\n* Start: 320MiB RAM, 10 millicore CPU burstable\n* Power: 1280MiB RAM, 80 millicore CPU burstable\n\nn8n gives each instance up to 100GB of data storage.\n\n## How to reduce memory consumption in your workflow[#](#how-to-reduce-memory-consumption-in-your-workflow \"Permanent link\")\n\nThe way you build workflows affects how much data they consume when executed. Although these guidelines aren't applicable to all cases, they provide a baseline of best practices to avoid exceeding instance memory.\n\n* Split the data processed into smaller chunks. For example, instead of fetching 10,000 rows with each execution, process 200 rows with each execution.\n* Avoid using the Code node where possible.\n* Avoid manual executions when processing larger amounts of data.\n* Split the workflow up into sub-workflows and ensure each sub-workflow returns a limited amount of data to its parent workflow.\n\nSplitting the workflow might seem counter-intuitive at first as it usually requires adding at least two more nodes: the [Loop Over Items](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/) node to split up the items into smaller batches and the [Execute Workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) node to start the sub-workflow.\n\nHowever, as long as your sub-workflow does the heavy lifting for each batch and then returns only a small result set to the main workflow, this reduces memory consumption. This is because the sub-workflow only holds the data for the current batch in memory, after which the memory is free again.\n\nNote that n8n itself consumes memory to run. On average, the software alone uses around 180MiB RAM.\n\nInteractions with the UI also consume memory. Playing around with the workflow UI while it performs heavy executions could also push the memory capacity over the limit.\n\n## How to manage execution data on Cloud[#](#how-to-manage-execution-data-on-cloud \"Permanent link\")\n\nExecution data includes node data, parameters, variables, execution context, and binary data references. It's text-based.\n\nBinary data is non-textual data that n8n can't represent as plain text. This is files and media such as images, documents, audio files, and videos. It's much larger than textual data.\n\nIf a workflow consumes a large amounts of data and is past testing stage, it's a good option to stop saving the successful executions.\n\nThere are two ways you can control how much execution data n8n stores in the database:\n\nIn the admin dashboard:\n\n1. From your workspace or editor, navigate to **Admin Panel**.\n2. Select **Manage**.\n3. In **Executions to Save** deselect the executions you don't want to log.\n\nIn your workflow settings:\n\n1. Select the **Options**  menu.\n2. Select **Settings**. n8n opens the **Workflow settings** modal.\n3. Change **Save successful production executions** to **Do not save**.\n\n## Cloud data pruning and out of memory incident prevention[#](#cloud-data-pruning-and-out-of-memory-incident-prevention \"Permanent link\")\n\n### Automatic data pruning[#](#automatic-data-pruning \"Permanent link\")\n\nn8n automatically prunes execution logs after a certain time or once you reach the max storage limit, whichever comes first. The pruning always happens from oldest to newest and the limits depend on your Could plan:\n\n* Start and Starter plans: max 2500 executions saved and 7 days execution log retention;\n* Pro and Power plans: max 25000 executions saved and 30 days execution log retention;\n* Enterprise plan: max 50000 executions saved and unlimited execution log retention time.\n\n### Manual data pruning[#](#manual-data-pruning \"Permanent link\")\n\nHeavier executions and use cases can exceed database capacity despite the automatic pruning practices. In cases like this, n8n will manually prune data to protect instance stability.\n\n1. An alert system warns n8n if an instance is at 85% disk capacity.\n2. n8n prunes execution data. n8n does this by running a backup of the instance (workflows, users, credentials and execution data) and restoring it without execution data.\n\nDue to the human steps in this process, the alert system isn't perfect. If warnings are triggered after hours or if data consumption rates are high, there might not be time to prune the data before the remaining disk space fills up."
},
{
"url": "https://docs.n8n.io/manage-cloud/change-ownership-or-username/",
"markdown": "# Change Instance Ownership or Username\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/change-ownership-or-username.md \"Edit this page\")\n\n## Change instance ownership[#](#change-instance-ownership \"Permanent link\")\n\nYou can change the ownership of an instance by navigating to the **Settings** page in the owner's account and editing the **Email** field. After making the changes, scroll down and press **Save**. Note that for the change to be effective, the new email address can't be linked to any other n8n account.\n\nChanging emails will change the owner of the instance, the email you log in with, and the email your invoices and general communication gets sent to.\n\nIf the workspace is deactivated, there will be no **Settings** page and no possibility to change the email address or the owner info.\n\n## Change instance username[#](#change-instance-username \"Permanent link\")\n\nIt's not currently possible to change usernames.\n\nIf you want your instance to have a different name you will need to create a new account and transfer your work into it. [The import/export documentation](https://docs.n8n.io/workflows/export-import/) explains how you can transfer your work to a new n8n instance."
},
{
"url": "https://docs.n8n.io/manage-cloud/concurrency/",
"markdown": "# Concurrency | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/concurrency.md \"Edit this page\")\n\n## Cloud concurrency[#](#cloud-concurrency \"Permanent link\")\n\nToo many concurrent executions can cause performance degradation and unresponsiveness. To prevent this and improve instance stability, n8n sets concurrency limits for production executions in regular mode.\n\nAny executions beyond the limits queue for later processing. These executions remain in the queue until concurrency capacity frees up, and are then processed in FIFO order.\n\n## Concurrency limits[#](#concurrency-limits \"Permanent link\")\n\nn8n limits the number of concurrent executions for Cloud instances according to their plan:\n\n* Starter and Trial: 5\n* Pro (10k workflow executions, 15 active workflows): 20\n* Pro (50k workflow executions, 50 active workflows): 50\n* Enterprise (in regular mode): 200\n\nYou can view the number of active executions and your plan's concurrency limit at the top of a project's or workflow's executions tab.\n\n## Details[#](#details \"Permanent link\")\n\nSome other details about concurrency to keep in mind:\n\n* Concurrency control applies only to production executions: those started from a webhook or trigger node. It doesn't apply to any other kinds, such as manual executions, sub-workflow executions, or error executions.\n* [Test evaluations](https://docs.n8n.io/glossary/#evaluation-n8n) do not count towards concurrency limits. Your test evaluation concurrency limit is equal to, but separate from, your plan's regular concurrency limit.\n* You can't retry queued executions. Cancelling or deleting a queued execution also removes it from the queue.\n* On instance startup, n8n resumes queued executions up to the concurrency limit and re-enqueues the rest.\n\n## Comparison to queue mode[#](#comparison-to-queue-mode \"Permanent link\")\n\nFeature availability\n\nQueue mode is available for Cloud Enterprise plans. To enable it, [contact n8n](https://n8n-community.typeform.com/to/y9X2YuGa).\n\nConcurrency in queue mode is a separate mechanism from concurrency in regular mode. In queue mode, the concurrency settings determine how many jobs each worker can run in parallel. In regular mode, concurrency limits apply to the entire instance."
},
{
"url": "https://docs.n8n.io/manage-cloud/download-workflows/",
"markdown": "# Download workflows | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/download-workflows.md \"Edit this page\")\n\nn8n Cloud instance owners can download workflows from the most recent backup.\n\nYou can do this with the [Cloud admin dashboard](https://docs.n8n.io/manage-cloud/cloud-admin-dashboard/).\n\n## How to download workflows[#](#how-to-download-workflows \"Permanent link\")\n\n1. [Log in to n8n](https://app.n8n.cloud/magic-link).\n2. Select **Admin Dashboard** to open the dashboard.\n3. In the **Manage** section, select the **Export** tab.\n4. Select **Download Workflows**.\n\n## Accessing workflows after your free trial[#](#accessing-workflows-after-your-free-trial \"Permanent link\")\n\nYou have **90 days** to download your workflows after your free trial ends. After that, all workflows will be **permanently deleted** and are unrecoverable."
},
{
"url": "https://docs.n8n.io/manage-cloud/ai-assistant/",
"markdown": "# AI Assistant | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/manage-cloud/ai-assistant.md \"Edit this page\")\n\nThe n8n AI Assistant helps you build, debug, and optimize your workflows seamlessly. From answering questions about n8n to providing help with coding and [expressions](https://docs.n8n.io/glossary/#expression-n8n), the AI Assistant can streamline your workflow-building process and support you as you navigate n8n's capabilities.\n\n## Current capabilities[#](#current-capabilities \"Permanent link\")\n\nThe AI Assistant offers a range of tools to support you:\n\n* **Debug helper**: Identify and troubleshoot node execution issues in your workflows to keep them running without issues.\n* **Answer n8n questions**: Get instant answers to your n8n-related questions, whether they're about specific features or general functionality.\n* **Coding support**: Receive guidance on coding, including SQL and JSON, to optimize your nodes and data processing.\n* **Expression assistance**: Learn how to create and refine [expressions](https://docs.n8n.io/code/expressions/) to get the most out of your workflows.\n* **Credential setup tips**: Find out how to set up and manage node [credentials](https://docs.n8n.io/integrations/builtin/credentials/) securely and efficiently.\n\n## Tips for getting the most out of the Assistant[#](#tips-for-getting-the-most-out-of-the-assistant \"Permanent link\")\n\n1. **Engage in a conversation**: The AI Assistant can collaborate with you step-by-step. If a suggestion isn't what you need, let it know! The more context you provide, the better the recommendations will be.\n\n2. **Ask specific questions**: For the best results, ask focused questions (for example, \"How do I set up credentials for Google Sheets?\"). The assistant works best with clear queries.\n3. **Iterate on suggestions**: Don't hesitate to build on the assistant's responses. Try different approaches and keep refining based on the assistant's feedback to get closer to your ideal solution.\n4. **Things to try out**:\n * Debug any error you're seeing\n * Ask how to setup credentials\n * \"Explain what this workflow does.\"\n * \"I need your help to write code: \\[Explain your code here\\]\"\n * \"How can I build X in n8n?\"\n\n## FAQs[#](#faqs \"Permanent link\")\n\n### What context does the Assistant have?[#](#what-context-does-the-assistant-have \"Permanent link\")\n\nThe AI Assistant has access to all elements displayed on your n8n screen, excluding actual input and output data values (like customer information). To learn more about what data n8n shares with the Assistant, refer to [AI in n8n](https://docs.n8n.io/privacy-security/privacy/#ai-in-n8n).\n\n### Who can use the Assistant?[#](#who-can-use-the-assistant \"Permanent link\")\n\nAny user on a Cloud plan can use the assistant.\n\n### How does the Assistant work?[#](#how-does-the-assistant-work \"Permanent link\")\n\nThe underlying logic of the assistant is build with the advanced AI capabilities of n8n. It uses a combination of different [agents](https://docs.n8n.io/glossary/#ai-agent), specialized in different areas of n8n, RAG to gather knowledge from the docs and the community forum, and custom prompts, [memory](https://docs.n8n.io/glossary/#ai-memory) and context."
},
{
"url": "https://docs.n8n.io/source-control-environments/",
"markdown": "# Source control and environments | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/index.md \"Edit this page\")\n\nFeature availability\n\n* Available on Enterprise.\n* You must be an n8n instance owner or instance admin to enable and configure source control.\n* Instance owners and instance admins can push changes to and pull changes from the connected repository.\n* Project admins can push changes to the connected repository. They can't pull changes from the repository.\n\nn8n uses Git-based source control to support environments. Linking your n8n instances to a Git repository lets you create multiple n8n environments, backed by Git branches.\n\nIn this section:\n\n* [Understand](https://docs.n8n.io/source-control-environments/understand/):\n * [Environments in n8n](https://docs.n8n.io/source-control-environments/understand/environments/): The purpose of environments, and how they work in n8n.\n * [Git and n8n](https://docs.n8n.io/source-control-environments/understand/git/): How n8n uses Git.\n * [Branch patterns](https://docs.n8n.io/source-control-environments/understand/patterns/): The possible relationships between n8n instances and Git branches.\n* [Set up source control for environments](https://docs.n8n.io/source-control-environments/setup/): How to connect your n8n instance to Git.\n* [Using](https://docs.n8n.io/source-control-environments/using/):\n * [Push and pull](https://docs.n8n.io/source-control-environments/using/push-pull/): Send work to Git, and fetch work from Git to your instance.\n * [Copy work between environments](https://docs.n8n.io/source-control-environments/using/copy-work/): How to copy work between different n8n instances.\n* [Tutorial: Create environments with source control](https://docs.n8n.io/source-control-environments/create-environments/): An end-to-end tutorial, setting up environments using n8n's recommended configurations.\n\nRelated sections:\n\n* [Variables](https://docs.n8n.io/code/variables/): reusable values.\n* [External secrets](https://docs.n8n.io/external-secrets/): manage [credentials](https://docs.n8n.io/glossary/#credential-n8n) with an external secrets vault."
},
{
"url": "https://docs.n8n.io/source-control-environments/understand/environments/",
"markdown": "# Environments in n8n | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/understand/environments.md \"Edit this page\")\n\nn8n has built its environments feature on top of Git, a version control software. This document helps you understand:\n\n* The purpose of environments.\n* How environments work in n8n.\n\n## Environments: What and why[#](#environments-what-and-why \"Permanent link\")\n\nIn software development, the environment is all the infrastructure and tooling around the code, including the tools that run the software, and the specific configuration of those tools. For a more detailed introduction to environments in software development, refer to [Codecademy | Environments](https://www.codecademy.com/article/environments).\n\nLow-code development in n8n is similar. n8n is where you build and run your workflows. Your instance may have particular configurations: on Cloud, n8n determines the configuration. On self-hosted instances, there are extensive [configuration options](https://docs.n8n.io/hosting/configuration/configuration-methods/). You may also have made changes to the settings of your instance. This combination of n8n and your instance's specific configuration and settings is the environment your workflows run in.\n\nThere are advantages to having more than one environment. A common pattern is to have different environments for development and production:\n\n* Development: do work and make changes.\n* Production: the live environment.\n\nA setup like this helps you make changes to workflows without breaking workflows that are in use.\n\n## Environments in n8n[#](#environments-in-n8n_1 \"Permanent link\")\n\nIn n8n, an environment comprises two parts, an n8n instance and a Git branch:\n\n* The n8n instance is where you build and run workflows.\n* The Git branch stores copies of the workflows, as well as tags, and variable and credential stubs.\n\nn8n doesn't sync credentials and variable values with Git. You must set up the credentials and variable values manually when setting up a new instance. For more information, refer to [Push and pull | What gets committed](https://docs.n8n.io/source-control-environments/using/push-pull/#what-gets-committed).\n\nHow you copy work between environments depends on your branch and n8n instance configuration:\n\n* Multiple instances, one branch: you can push from one instance to the Git branch, then pull the work to another instance.\n* Multiple instances, multiple branches: you need to create a pull request and merge in your Git provider. For example, if you have development, test, and production branches, each linked to their own instance, you need to merge the development branch into test to make the work from the development instance available on the test instance. Refer to [Copy work between environments](https://docs.n8n.io/source-control-environments/using/copy-work/) for more information, including steps to partially automate the process.\n\nFor detailed guidance on pushing and pulling work, refer to [Push and pull](https://docs.n8n.io/source-control-environments/using/push-pull/).\n\nRefer to [Set up source control](https://docs.n8n.io/source-control-environments/setup/) to learn more about linking your n8n instance to Git, or follow the [Tutorial: Create environments with source control](https://docs.n8n.io/source-control-environments/create-environments/) to set up your environments using one of n8n's recommended configurations."
},
{
"url": "https://docs.n8n.io/source-control-environments/understand/",
"markdown": "# Understand source control and environments\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/understand/index.md \"Edit this page\")\n\nFeature availability\n\n* Available on Enterprise.\n* You must be an n8n instance owner or instance admin to enable and configure source control.\n* Instance owners and instance admins can push changes to and pull changes from the connected repository.\n* Project admins can push changes to the connected repository. They can't pull changes from the repository.\n\n* [Environments in n8n](https://docs.n8n.io/source-control-environments/understand/environments/): The purpose of environments, and how they work in n8n.\n* [Git in n8n](https://docs.n8n.io/source-control-environments/understand/git/): How n8n uses Git.\n* [Branch patterns](https://docs.n8n.io/source-control-environments/understand/patterns/): The possible relationships between n8n instances and Git branches."
},
{
"url": "https://docs.n8n.io/source-control-environments/understand/patterns/",
"markdown": "# Branch patterns | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/understand/patterns.md \"Edit this page\")\n\nThe relationship between n8n instances and Git branches is flexible. You can create different setups depending on your needs.\n\nRecommendation: don't push and pull to the same n8n instance\n\nYou can push work from an instance to a branch, and pull to the same instance. n8n doesn't recommend this. To reduce the risk of merge conflicts and overwriting work, try to create a process where work goes in one direction: either to Git, or from Git, but not both.\n\n## Multiple instances, multiple branches[#](#multiple-instances-multiple-branches \"Permanent link\")\n\nThis pattern involves having multiple n8n instances, each one linked to its own branch.\n\nYou can use this pattern for environments. For example, create two n8n instances, development and production. Link them to their own branches. Push work from your development instance to its branch, do a pull request to move work to the production branch, then pull to the production instance.\n\nThe advantages of this pattern are:\n\n* An added safety layer to prevent changes getting into your production environment by mistake. You have to do a pull request in GitHub to copy work between environments.\n* It supports more than two instances.\n\nThe disadvantage is more manual steps to copy work between environments.\n\n\n\n## Multiple instances, one branch[#](#multiple-instances-one-branch \"Permanent link\")\n\nUse this pattern if you want the same workflows, tags, and variables everywhere, but want to use them in different n8n instances.\n\nYou can use this pattern for environments. For example, create two n8n instances, development and production. Link them both to the same branch. Push work from development, and pull it into production.\n\nThis pattern is also useful when testing a new version of n8n: you can create a new n8n instance with the new version, connect it to the Git branch and test it, while your production instance remains on the older version until you're confident it's safe to upgrade.\n\nThe advantage of this pattern is that work is instantly available to other environments when you push from one instance.\n\nThe disadvantages are:\n\n* If you push by mistake, there is a risk the work will make it into your production instance. If you [use a GitHub Action to automate pulls](https://docs.n8n.io/source-control-environments/create-environments/#optional-use-a-github-action-to-automate-pulls) to production, you must either use the multi-instance, multi-branch pattern, or be careful to never push work that you don't want in production.\n* Pushing and pulling to the same instance can cause data loss as changes are overridden when performing these actions. You should set up processes to ensure content flows in one direction.\n\n\n\n## One instance, multiple branches[#](#one-instance-multiple-branches \"Permanent link\")\n\nThe instance owner can change which Git branch connects to the instance. The full setup in this case is likely to be a [Multiple instances, multiple branches](#multiple-instances-multiple-branches) pattern, but with one instance switching between branches.\n\nThis is useful to review work. For example, different users could work on their own instance and push to their own branch. The reviewer could work in a review instance, and switch between branches to load work from different users.\n\nNo cleanup\n\nn8n doesn't clean up the existing contents of an instance when changing branches. Switching branches in this pattern results in all the workflows from each branch being in your instance.\n\n\n\n## One instance, one branch[#](#one-instance-one-branch \"Permanent link\")\n\nThis is the simplest pattern.\n\n"
},
{
"url": "https://docs.n8n.io/source-control-environments/understand/git/",
"markdown": "# Git and n8n | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/understand/git.md \"Edit this page\")\n\nn8n uses Git to provide source control. To use this feature, it helps to have some knowledge of basic Git concepts. n8n doesn't implement all Git functionality: you shouldn't view n8n's source control as full version control.\n\nNew to Git and source control?\n\nIf you're new to Git, don't panic. You don't need to learn Git to use n8n. This document explains the concepts you need. You do need some Git knowledge to set up the source control, as this involves work in your Git provider.\n\nFamiliar with Git and source control?\n\nIf you're familiar with Git, don't rely on behaviors matching exactly. In particular, be aware that source control in n8n doesn't support a pull request-style review and merge process, unless you do this outside n8n in your Git provider.\n\nThis page introduces the Git concepts and terminology used in n8n. It doesn't cover everything you need to set up and manage a repository. The person doing the [Setup](https://docs.n8n.io/source-control-environments/setup/) should have some familiarity with Git and with their Git hosting provider.\n\nThis is a brief introduction\n\nGit is a complex topic. This section provides a brief introduction to the key terms you need when using environments in n8n. If you want to learn about Git in depth, refer to [GitHub | Git and GitHub learning resources](https://docs.github.com/en/get-started/quickstart/git-and-github-learning-resources).\n\n## Git overview[#](#git-overview \"Permanent link\")\n\n[Git](https://git-scm.com/) is a tool for managing, tracking, and collaborating on multiple versions of documents. It's the basis for widely used platforms such as [GitHub](https://github.com/) and [GitLab](https://about.gitlab.com/).\n\n## Branches: Multiple copies of a project[#](#branches-multiple-copies-of-a-project \"Permanent link\")\n\nGit uses branches to maintain multiple copies of a document alongside each other. Every branch has its own version. A common pattern is to have a main branch, and then everyone who wants to contribute to the project works on their own branch (copy). When they finish their work, their branch is merged back into the main branch.\n\n\n\n## Local and remote: Moving work between your machine and a Git provider[#](#local-and-remote-moving-work-between-your-machine-and-a-git-provider \"Permanent link\")\n\nA common pattern when using Git is to install Git on your own computer, and use a Git provider such as GitHub to work with Git in the cloud. In effect, you have a Git repository (project) on GitHub, and work with copies of it on your local machine.\n\nn8n uses this pattern for source control: you'll work with your workflows on your n8n instance, but send them to your Git provider to store them.\n\n## Push, pull, and commit[#](#push-pull-and-commit \"Permanent link\")\n\nn8n uses three key Git processes:\n\n* **Push**: send work from your instance to Git. This saves a copy of your workflows and tags, as well as credential and variable stubs, to Git. You can choose which workflows you want to save.\n* **Pull**: get the workflows, tags, and variables from Git and load it into n8n. You will need to populate any credentials or variable stubs included in the refreshed items.\n \n Pulling overwrites your work\n \n If you have made changes to a workflow in n8n, you must push the changes to Git before pulling. When you pull, it overwrites any changes you've made if they aren't stored in Git.\n \n* **Commit**: a commit in n8n is a single occurrence of pushing work to Git. In n8n, commit and push happen at the same time.\n \n\nRefer to [Push and pull](https://docs.n8n.io/source-control-environments/using/push-pull/) for detailed information about how n8n interacts with Git."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-6/",
"markdown": "# Exporting and importing workflows | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-6.md \"Edit this page\")\n\nIn this chapter, you will learn how to export and import workflows.\n\n## Exporting and importing workflows[#](#exporting-and-importing-workflows_1 \"Permanent link\")\n\nYou can save n8n workflows locally as JSON files. This is useful if you want to share your workflow with someone else or import a workflow from someone else.\n\nSharing credentials\n\nExported workflow JSON files include [credential](https://docs.n8n.io/glossary/#credential-n8n) names and IDs. While IDs aren't sensitive, the names could be, depending on how you name your credentials. HTTP Request nodes may contain authentication headers when imported from cURL. Remove or anonymize this information from the JSON file before sharing to protect your credentials.\n\n\n\n_Import & Export workflows menu_\n\nYou can export and import workflows in three ways:\n\n* From the **Editor UI** menu:\n * Export: From the top navigation bar, select the three dots in the upper right, then select **Download**. This will download your current workflow as a JSON file on your computer.\n * Import: From the top navigation bar, select the three dots in the upper right, then select **Import from URL** (to import a published workflow) or **Import from File** (to import a workflow as a JSON file).\n* From the **Editor UI** canvas:\n * Export: Select all the nodes on the canvas and use Ctrl+C to copy the workflow JSON. You can paste this into a file or share it directly with other people.\n * Import: You can paste a copied workflow JSON directly into the canvas with Ctrl+V.\n* From the command line:\n * Export: See the [full list of commands](https://docs.n8n.io/hosting/cli-commands/) for exporting workflows or credentials.\n * Import: See the [full list of commands](https://docs.n8n.io/hosting/cli-commands/#import-workflows-and-credentials) for importing workflows or credentials."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-7/",
"markdown": "# Test your knowledge | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-7.md \"Edit this page\")\n\nCongratulations, you finished the n8n Course Level 1!\n\nYou've learned a lot about workflow automation and built your first business workflow. Why not showcase your skills?\n\nYou can test your knowledge by taking a **quiz**, which consists of questions about the theoretical concepts and workflows covered in this course.\n\n* You need to have at least 80% correct answers in each part to pass the quiz.\n* You can take the quiz as many times as you want.\n* There's no time limit on answering the quiz questions.\n\n \n[Take the quiz!](https://n8n-community.typeform.com/to/JMoBXeGA)\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n* Create new workflows for your work or personal use and share them with us. Don't have any ideas? Find inspiration on our [blog](https://n8n.io/blog/), [YouTube channel](https://www.youtube.com/c/n8n-io), [community forum](https://community.n8n.io/), and [Discord server](https://discord.gg/vWwMVThRta).\n* Take the n8n [Course Level 2](https://docs.n8n.io/courses/level-two/)."
},
{
"url": "https://docs.n8n.io/courses/level-two/",
"markdown": "# Level two: Introduction | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/index.md \"Edit this page\")\n\nWelcome to the **n8n Course Level 2**!\n\n## Is this course right for me?[#](#is-this-course-right-for-me \"Permanent link\")\n\nThis course is for you if you:\n\n* Want to automate somewhat complex business processes.\n* Want to dive deeper into n8n after taking the [Level 1 course](https://docs.n8n.io/courses/level-one/).\n\n## What will I learn in this course?[#](#what-will-i-learn-in-this-course \"Permanent link\")\n\nThe focus in this course is on working with data. You will learn how to:\n\n* Use the data structure of n8n correctly.\n* Process different data types (for example, XML, HTML, date, time, and binary data).\n* Merge data from different sources (for example, a database, spreadsheet, or CRM).\n* Use functions and JavaScript code in the [Code node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/).\n* Deal with error workflows and workflow errors.\n\nYou will learn all this by completing short practical exercises after the theoretical explanations and building a business workflow following instructions.\n\n## What do I need to get started?[#](#what-do-i-need-to-get-started \"Permanent link\")\n\nTo follow along this course (at a comfortable pace) you will need the following:\n\n* **n8n set up**: You can use the [self-hosted version](https://docs.n8n.io/hosting/installation/npm/) or [n8n Cloud](https://docs.n8n.io/manage-cloud/overview/).\n* **A user ID**: [Sign up here](https://n8n-community.typeform.com/to/HQoQ7nXg) to get your unique ID and other credentials you will need in the course.\n* **Basic n8n skills**: We strongly recommend taking the [Level 1 course](https://docs.n8n.io/courses/level-one/) before this one.\n* **Basic JavaScript understanding**\n\n## How long does the course take?[#](#how-long-does-the-course-take \"Permanent link\")\n\nCompleting the course should take around **two hours**. You don't have to complete it in one go; feel free to take breaks and resume whenever you are ready.\n\n## How do I complete the course?[#](#how-do-i-complete-the-course \"Permanent link\")\n\nThere are two milestones in this course that test your knowledge of what you have learned in the lessons:\n\n* Building the [main workflow](https://docs.n8n.io/courses/level-two/chapter-5/chapter-5.0/)\n* Passing the [quiz](https://n8n-community.typeform.com/to/r9hDbytg) at the end of the course\n\nYou can always **check your progress** throughout the course by entering your unique ID [here](https://internal.users.n8n.cloud/webhook/course-level-2/verify).\n\nIf you successfully complete the milestones above, you will get [**a badge and an avatar**](https://community.n8n.io/badges/105/completed-n8n-course-level-2) in your forum profile. You can then share your profile and course verification ID to showcase your n8n skills to others.\n\n[Let's get started!](https://docs.n8n.io/courses/level-two/chapter-1/)"
},
{
"url": "https://docs.n8n.io/source-control-environments/setup/",
"markdown": "# Set up source control | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/setup.md \"Edit this page\")\n\n## Set up source control for environments[#](#set-up-source-control-for-environments \"Permanent link\")\n\nLink a Git repository to an n8n instance and configure your source control.\n\nn8n uses source control to provide environments. Refer to [Environments in n8n](https://docs.n8n.io/source-control-environments/understand/environments/) for more information.\n\n## Prerequisites[#](#prerequisites \"Permanent link\")\n\nTo use source control with n8n, you need a Git repository that allows SSH access.\n\nThis document assumes you are familiar with Git and your Git provider.\n\n## Step 1: Set up your repository and branches[#](#step-1-set-up-your-repository-and-branches \"Permanent link\")\n\nFor a new setup:\n\n1. Create a new repository for use with n8n.\n2. Create the branches you need. For example, if you plan to have different environments for test and production, set up a branch for each.\n\nTo help decide what branches you need for your use case, refer to [Branch patterns](https://docs.n8n.io/source-control-environments/understand/patterns/).\n\n## Step 2: Configure Git in n8n[#](#step-2-configure-git-in-n8n \"Permanent link\")\n\n1. Go to **Settings** > **Environments**.\n2. In **Git repository URL** enter the SSH URL for your repository.\n3. n8n supports ED25519 and RSA public key algorithms. ED25519 is the default. Select **RSA** under **SSH Key** if your git host requires RSA.\n4. Copy the SSH key.\n\n## Step 3: Set up a deploy key[#](#step-3-set-up-a-deploy-key \"Permanent link\")\n\nSet up SSH access by creating a deploy key for the repository using the SSH key from n8n. The key must have write access.\n\nThe steps depend on your Git provider. Help links for common providers:\n\n* [GitHub | Managing deploy keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys)\n* [GitLab | Deploy keys](https://docs.gitlab.com/ee/user/project/deploy_keys/)\n\n## Step 4: Connect n8n and configure your instance[#](#step-4-connect-n8n-and-configure-your-instance \"Permanent link\")\n\n1. In **Settings** > **Environments** in n8n, select **Connect**. n8n connects to your Git repository.\n2. Under **Instance settings**, choose which branch you want to use for the current n8n instance.\n3. **Optional**: select **Protected instance** to prevent users editing workflows in this instance. This is useful for protecting production instances.\n4. **Optional**: choose a custom color for the instance. This will appear in the menu next to the source control push and pull buttons. It helps users know which instance they're in.\n5. Select **Save settings**."
},
{
"url": "https://docs.n8n.io/courses/level-one/chapter-5/chapter-5.8/",
"markdown": "# Activating and examining the workflow\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-one/chapter-5/chapter-5.8.md \"Edit this page\")\n\nIn this step of the workflow, you will learn how to activate your workflow and change the default workflow settings.\n\nActivating a workflow means that it will run automatically every time a trigger node receives input or meets a condition. By default, all newly created workflows start deactivated.\n\nTo activate your workflow, set the **Inactive** toggle in the top navigation of the Editor UI to be **Activated**. Nathan's workflow will now be executed automatically every Monday at 9 AM:\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-five/l1-c5-5-8-activated-workflow.png)\n\n_Activated workflow_\n\n## Workflow Executions[#](#workflow-executions \"Permanent link\")\n\nAn execution represents a completed run of a workflow, from the first to the last node. n8n logs workflow executions, allowing you to see if the workflow succeeded or not. The execution log is useful for debugging your workflow and seeing at what stage it runs into issues.\n\nTo view the executions for a specific workflow, you can switch to the **Executions** tab when the workflow is open on the canvas. Use the **Editor** tab to swap back to the node editor.\n\nTo see the execution log for the entire n8n instance, in your Editor UI, select **Overview** and then select the **Executions** tab in the main panel.\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-five/l1-c5-5-8-execution-list.png)\n\n_Execution List_\n\nThe **Executions** window displays a table with the following information:\n\n* **Name**: The name of the workflow\n* **Started At**: The date and time when the workflow started\n* **Status**: The status of the workflow (Waiting, Running, Succeeded, Cancelled, or Failed) and the amount of time it took the workflow to execute\n* **Execution ID**: The ID of this workflow execution\n\nWorkflow execution status\n\nYou can filter the displayed **Executions** by workflow and by status (**Any Status**, **Failed**, **Cancelled**, **Running**, **Success**, or **Waiting**). The information displayed here depends on which executions you configure to save in the [**Workflow Settings**](https://docs.n8n.io/workflows/settings/).\n\n## Workflow Settings[#](#workflow-settings \"Permanent link\")\n\nYou can customize your workflows and executions, or overwrite some global default settings in [**Workflow Settings**](https://docs.n8n.io/workflows/settings/).\n\nAccess these settings by selecting the three dots in the upper right corner of the Editor UI when the workflow is open on the canvas, then select **Settings**.\n\n[](https://docs.n8n.io/_images/courses/level-one/chapter-five/l1-c5-5-8-workflow-settings.png)\n\n_Workflow Settings_\n\nIn the **Workflow Settings** window you can configure the following settings:\n\n* **Execution Order**: Choose the execution logic for multi-branch workflows. You should leave this set to `v1` if you don't have workflows that rely on the legacy execution ordering.\n* [**Error Workflow**](https://docs.n8n.io/flow-logic/error-handling/): A workflow to run if the execution of the current workflow fails.\n* **This workflow can be called by**: Workflows allowed to call this workflow using the [Execute Sub-workflow node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/).\n* **Timezone**: The timezone to use in the current workflow. If not set, the global timezone. In particular, this setting is important for the [Schedule Trigger node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/), as you want to make sure that the workflow gets executed at the right time.\n* **Save failed production executions**: If n8n should save the Execution data of the workflow when it fails. Default is to save.\n* **Save successful production executions**: If n8n should save the Execution data of the workflow when it succeeds. Default is to save.\n* **Save manual executions**: If n8n should save executions started from the Editor UI. Default is to save.\n* **Save execution progress**: If n8n should save the execution data of each node. If set to Save, you can resume the workflow from where it stopped in case of an error, though keep in mind that this might make the execution slower. Default is to not save.\n* **Timeout Workflow**: Whether to cancel a workflow execution after a specific period of time. Default is to not timeout.\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n**You 👩🔧**: That was it! Now you have a 7-node workflow that will run automatically every Monday morning. You don't have to worry about remembering to wrangle the data. Instead, you can start your week with more meaningful or exciting work.\n\n**Nathan 🙋**: This workflow is incredibly helpful, thank you! Now, what's next for you?\n\n**You 👩🔧**: I'd like to build more workflows, share them with others, and use some workflows built by other people."
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-1/",
"markdown": "# Understanding the data structure | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-1.md \"Edit this page\")\n\nIn this chapter, you will learn about the data structure of n8n and how to use the [Code node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/) to transform data and simulate node outputs.\n\n## Data structure of n8n[#](#data-structure-of-n8n \"Permanent link\")\n\nIn a basic sense, n8n nodes function as an Extract, Transform, Load (ETL) tool. The nodes allow you to access (extract) data from multiple disparate sources, modify (transform) that data in a particular way, and pass (load) it along to where it needs to be.\n\nThe data that moves along from node to node in your workflow must be in a format (structure) that can be recognized and interpreted by each node. In n8n, this required structure is an array of objects.\n\nAbout array of objects\n\nAn array is a list of values. The array can be empty or contain several elements. Each element is stored at a position (index) in the list, starting at 0, and can be referenced by the index number. For example, in the array `[\"Leonardo\", \"Michelangelo\", \"Donatello\", \"Raphael\"];` the element `Donatello` is stored at index 2.\n\nAn object stores key-value pairs, instead of values at numbered indexes as in arrays. The order of the pairs isn't important, as the values can be accessed by referencing the key name. For example, the object below contains two properties (`name` and `color`):\n\n| | |\n| --- | --- |\n| | `{ \tname: 'Michelangelo', \tcolor: 'blue', }` |\n\nAn array of objects is an array that contains one or more objects. For example, the array `turtles` below contains four objects:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | `var turtles = [ \t{ \t\tname: 'Michelangelo', \t\tcolor: 'orange', \t}, \t{ \t\tname: 'Donatello', \t\tcolor: 'purple', \t}, \t{ \t\tname: 'Raphael', \t\tcolor: 'red', \t}, \t{ \t\tname: 'Leonardo', \t\tcolor: 'blue', \t} ];` |\n\nYou can access the properties of an object using dot notation with the syntax `object.property`. For example, `turtles[1].color` gets the color of the second turtle.\n\nData sent from one node to another is sent as an array of JSON objects. The elements in this collection are called items.\n\n\n\n_Items_\n\nAn n8n node performs its action on each item of incoming data.\n\n\n\n_Items in the Customer Datastore node_\n\n## Creating data sets with the Code node[#](#creating-data-sets-with-the-code-node \"Permanent link\")\n\nNow that you are familiar with the n8n data structure, you can use it to create your own data sets or simulate node outputs. To do this, use the [Code node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code/) to write JavaScript code defining your array of objects with the following structure:\n\n| | |\n| --- | --- |\n| | `return [ \t{ \t\tjson: { \t\t\tapple: 'beets', \t\t} \t} ];` |\n\nFor example, the array of objects representing the Ninja turtles would look like this in the Code node:\n\n\n\n_Array of objects in the Code node_\n\nJSON objects\n\nNotice that this array of objects contains an extra key: `json`. n8n expects you to wrap each object in an array in another object, with the key `json`.\n\n\n\n_Illustration of data structure in n8n_\n\nIt's good practice to pass the data in the right structure used by n8n. But don't worry if you forget to add the `json` key to an item, n8n (version 0.166.0 and above) adds it automatically.\n\nYou can also have nested pairs, for example if you want to define a primary and a secondary color. In this case, you need to further wrap the key-value pairs in curly braces `{}`.\n\nn8n data structure video\n\n[This talk](https://www.youtube.com/watch?v=mQHT3Unn4tY) offers a more detailed explanation of data structure in n8n.\n\n### Exercise[#](#exercise \"Permanent link\")\n\nIn a Code node, create an array of objects named `myContacts` that contains the properties `name` and `email`, and the `email` property is further split into `personal` and `work`.\n\nShow me the solution\n\nIn the **Code node**, in the JavaScript Code field you have to write the following code:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 | `var myContacts = [ \t{ \t\tjson: { \t\t\tname: 'Alice', \t\t\temail: { \t\t\t\tpersonal: 'alice@home.com', \t\t\t\twork: 'alice@wonderland.org' \t\t\t}, \t\t} \t}, \t{ \t\tjson: { \t\t\tname: 'Bob', \t\t\temail: { \t\t\t\tpersonal: 'bob@mail.com', \t\t\t\twork: 'contact@thebuilder.com' \t\t\t\t}, \t\t} \t}, ]; return myContacts;` |\n\nWhen you execute the **Code node**, the result should look like this:\n\n\n\n_Result of Code node_\n\n## Referencing node data with the Code node[#](#referencing-node-data-with-the-code-node \"Permanent link\")\n\nJust like you can use [expressions](https://docs.n8n.io/code/expressions/) to reference data from other nodes, you can also use some [methods and variables](https://docs.n8n.io/code/builtin/overview/) in the **Code node**.\n\nPlease make sure you read these pages before continuing to the next exercise.\n\n### Exercise[#](#exercise_1 \"Permanent link\")\n\nLet's build on the previous exercise, in which you used the Code node to create a data set of two contacts with their names and emails. Now, connect a second Code node to the first one. In the new node, write code to create a new column named `workEmail` that references the work email of the first contact.\n\nShow me the solution\n\nIn the **Code node**, in the JavaScript Code field you have to write the following code:\n\n| | |\n| --- | --- |\n| | `let items = $input.all(); items[0].json.workEmail = items[0].json.email['work']; return items;` |\n\nWhen you execute the **Code node**, the result should look like this:\n\n\n\n_Code node reference_\n\n## Transforming data[#](#transforming-data \"Permanent link\")\n\nThe incoming data from some nodes may have a different data structure than the one used in n8n. In this case, you need to [transform the data](https://docs.n8n.io/data/transforming-data/), so that each item can be processed individually.\n\nThe two most common operations for data transformation are:\n\n* Creating multiple items from one item\n* Creating a single item from multiple items\n\nThere are several ways to transform data for the purposes mentioned above:\n\n* Use n8n's [data transformation nodes](https://docs.n8n.io/data/#data-transformation-nodes). Use these nodes to modify the structure of incoming data that contain lists (arrays) without needing to use JavaScript code in the **Code node**:\n * Use the [**Split Out node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitout/) to separate a single data item containing a list into multiple items.\n * Use the [**Aggregate node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.aggregate/) to take separate items, or portions of them, and group them together into individual items.\n* Use the **Code node** to write JavaScript functions to modify the data structure of incoming data using the **Run Once for All Items** mode:\n * To create multiple items from a single item, you can use JavaScript code like this. This example assumes that the item has a key named `data` set to an array of items in the form of: `[{ \"data\": [{}, {}, ...] }]`:\n \n | | |\n | --- | --- |\n | | `return $input.first().json.data.map(item => { return { json: item } });` |\n \n * To create a single item from multiple items, you can use this JavaScript code:\n \n | | |\n | --- | --- |\n | | `return [ \t{ \tjson: { \t\tdata_object: $input.all().map(item => item.json) \t} } ];` |\n \n\nThese JavaScript examples assume your entire input is what you want to transform. As in the exercise above, you can also execute either operation on a specific field by identifying that in the items list, for example, if our workEmail example had multiple emails in a single field, we could run some code like this:\n\n| | |\n| --- | --- |\n| | `let items = $input.all(); return items[0].json.workEmail.map(item => { \treturn { \t\tjson: item \t} });` |\n\n### Exercise[#](#exercise_2 \"Permanent link\")\n\n1. Use the **HTTP Request node** to make a GET request to the PokéAPI `https://pokeapi.co/api/v2/pokemon`. (This API requires no authentication).\n2. Transform the data in the `results` field with the **Split Out node**.\n3. Transform the data in the `results` field with the **Code node**.\n\nShow me the solution\n\n1. To get the pokemon from the PokéAPI, execute the **HTTP Request node** with the following parameters:\n * **Authentication**: None\n * **Request Method**: GET\n * **URL**: https://pokeapi.co/api/v2/pokemon\n2. To transform the data with the **Split Out node**, connect this node to the **HTTP Request node** and set the following parameters:\n * **Field To Split Out**: results\n * **Include**: No Other Fields\n3. To transform the data with the **Code node**, connect this node to the **HTTP Request node** and write the following code in the JavaScript Code field:\n \n | | |\n | --- | --- |\n | | `let items = $input.all(); return items[0].json.results.map(item => { \treturn { \t\tjson: item \t} });` |"
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-4/",
"markdown": "# Dealing with errors in workflows\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-4.md \"Edit this page\")\n\nSometimes you build a nice workflow, but it fails when you try to execute it. Workflow executions may fail for a variety of reasons, ranging from straightforward problems with incorrectly configuring a node or a failure in a third-party service to more mysterious errors.\n\nBut don't panic. In this lesson, you'll learn how you can troubleshoot errors so you can get your workflow up and running as soon as possible.\n\n## Checking failed workflows[#](#checking-failed-workflows \"Permanent link\")\n\nn8n tracks executions of your workflows.\n\nWhen one of your workflows fails, you can check the Executions log to see what went wrong. The Executions log shows you a list of the latest execution time, status, mode, and running time of your saved workflows.\n\nOpen the Executions log by selecting [**Executions**](https://docs.n8n.io/workflows/executions/#execution-modes) in the left-side panel.\n\nTo investigate a specific failed execution from the list, select the name or the **View** button that appears when you hover over the row of the respective execution.\n\n\n\n_Executions log_\n\nThis will open the workflow in read-only mode, where you can see the execution of each node. This representation can help you identify at what point the workflow ran into issues.\n\nTo toggle between viewing the execution and the editor, select the **Editor | Executions** button at the top of the page.\n\n\n\n_Workflow execution view_\n\n## Catching erroring workflows[#](#catching-erroring-workflows \"Permanent link\")\n\nTo catch failed workflows, create a separate [**Error Workflow**](https://docs.n8n.io/flow-logic/error-handling/) with the [**Error Trigger node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger/). This workflow will only execute if the main workflow execution fails.\n\nUse additional nodes in your **Error Workflow** that make sense, like sending notifications about the failed workflow and its errors using email or Slack.\n\nTo receive error messages for a failed workflow, set the **Error Workflow** in the [Workflow Settings](https://docs.n8n.io/workflows/settings/) to an Error Workflow that uses an **Error Trigger node**.\n\nThe only difference between a regular workflow and an Error Workflow is that the latter contains an **Error Trigger node**. Make sure to create this node before you set this as another workflow's designated Error Workflow.\n\nError workflows\n\n* If a workflow uses the Error Trigger node, you don't have to activate the workflow.\n* If a workflow contains the Error Trigger node, by default, the workflow uses itself as the error workflow.\n* You can't test error workflows when running workflows manually. The Error trigger only runs when an automatic workflow errors.\n* You can set the same Error Workflow for multiple workflows.\n\n### Exercise[#](#exercise \"Permanent link\")\n\nIn the previous chapters, you've built several small workflows. Now, pick one of them that you want to monitor and create an Error Workflow for it:\n\n1. Create a new Error Workflow.\n2. Add the **Error Trigger node**.\n3. Connect a node for the communication platform of your choice to the Error Trigger node, like [Slack](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.slack/), [Discord](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.discord/), [Telegram](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.telegram/), or even [Gmail](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) or a more generic [Send Email](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.sendemail/).\n4. In the workflow you want to monitor, open the [Workflow Settings](https://docs.n8n.io/workflows/settings/) and select the new Error Workflow you just created. Note that this workflow needs to run automatically to trigger the error workflow.\n\nShow me the solution\n\nThe workflow for this exercise looks like this:\n\n\n\n_Error workflow_\n\nTo check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48 | `{ \t\"nodes\": [ \t\t{ \t\t\t\"parameters\": {}, \t\t\t\"name\": \"Error Trigger\", \t\t\t\"type\": \"n8n-nodes-base.errorTrigger\", \t\t\t\"typeVersion\": 1, \t\t\t\"position\": [ \t\t\t\t720, \t\t\t\t-380 \t\t\t] \t\t}, \t\t{ \t\t\t\"parameters\": { \t\t\t\t\"channel\": \"channelname\", \t\t\t\t\"text\": \"=This workflow {{$node[\\\"Error Trigger\\\"].json[\\\"workflow\\\"][\\\"name\\\"]}}failed.\\nHave a look at it here: {{$node[\\\"Error Trigger\\\"].json[\\\"execution\\\"][\\\"url\\\"]}}\", \t\t\t\t\"attachments\": [], \t\t\t\t\"otherOptions\": {} \t\t\t}, \t\t\t\"name\": \"Slack\", \t\t\t\"type\": \"n8n-nodes-base.slack\", \t\t\t\"position\": [ \t\t\t\t900, \t\t\t\t-380 \t\t\t], \t\t\t\"typeVersion\": 1, \t\t\t\"credentials\": { \t\t\t\t\"slackApi\": { \t\t\t\t\t\"id\": \"17\", \t\t\t\t\t\"name\": \"slack_credentials\" \t\t\t\t} \t\t\t} \t\t} \t], \t\"connections\": { \t\t\"Error Trigger\": { \t\t\t\"main\": [ \t\t\t\t[ \t\t\t\t\t{ \t\t\t\t\t\t\"node\": \"Slack\", \t\t\t\t\t\t\"type\": \"main\", \t\t\t\t\t\t\"index\": 0 \t\t\t\t\t} \t\t\t\t] \t\t\t] \t\t} \t} }` |\n\n## Throwing exceptions in workflows[#](#throwing-exceptions-in-workflows \"Permanent link\")\n\nAnother way of troubleshooting workflows is to include a [**Stop and Error node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror/) in your workflow. This node throws an error. You can specify the error type:\n\n* **Error Message**: returns a custom message about the error\n* **Error Object**: returns the type of error\n\nYou can only use the **Stop and Error node** as the last node in a workflow.\n\nWhen to throw errors\n\nThrowing exceptions with the **Stop and Error node** is useful for verifying the data (or assumptions about the data) from a node and returning custom error messages.\n\nIf you are working with data from a third-party service, you may come across problems such as:\n\n* Wrongly formatted JSON output\n* Data with the wrong type (for example, numeric data that has a non-numeric value)\n* Missing values\n* Errors from remote servers\n\nThough this kind of invalid data might not cause the workflow to fail right away, it could cause problems later on, and then it can become difficult to track the source error. This is why it's better to throw an error at the time you know there might be a problem.\n\n\n\n_Stop and Error node with error message_"
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-3/",
"markdown": "# Merging and splitting data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-3.md \"Edit this page\")\n\nIn this chapter, you will learn how to merge and split data, and in what cases it might be useful to perform these operations.\n\n## Merging data[#](#merging-data \"Permanent link\")\n\nIn some cases, you might need to merge (combine) and process data from different sources.\n\nMerging data can involve:\n\n* Creating one data set from multiple sources.\n* Synchronizing data between multiple systems. This could include removing duplicate data or updating data in one system when it changes in another.\n\nOne-way vs. two-way sync\n\nIn a one-way sync, data is synchronized in one direction. One system serves as the single source of truth. When information changes in that main system, it automatically changes in the secondary system; but if information changes in the secondary system, the changes aren't reflected in the main system.\n\nIn a two-way sync, data is synchronized in both directions (between both systems). When information changes in either of the two systems, it automatically changes in the other one as well.\n\n[This blog tutorial](https://blog.n8n.io/how-to-sync-data-between-two-systems/) explains how to sync data one-way and two-way between two CRMs.\n\nIn n8n, you can merge data from two different nodes using the [Merge node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/), which provides several merging options:\n\n* [Append](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#append)\n* [Combine](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#combine)\n * [Merge by Fields](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#combine-by-matching-fields): requires input fields to match on\n * [Merge by Position](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#combine-by-position)\n * [Combine all possible combinations](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#combine-by-all-possible-combinations)\n* [Choose Branch](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/#choose-branch)\n\nNotice that Combine > Merge by Fields requires you enter input fields to match on. These fields should contain identical values between the data sources so n8n can properly match data together. In the **Merge node**, they're called `Input 1 Field` and `Input 2 Field`.\n\n\n\n_Property Input fields in the Merge node_\n\nProperty Input in dot notation\n\nIf you want to reference nested values in the **Merge node** parameters `Input 1 Field` and `Input 2 Field`, you need to enter the property key in dot-notation format (as text, not as an expression).\n\nNote\n\nYou can also find the **Merge node** under the alias Join. This might be more intuitive if you're familiar with SQL joins.\n\n### Merge Exercise[#](#merge-exercise \"Permanent link\")\n\nBuild a workflow that merges data from the Customer Datastore node and Code node.\n\n1. Add a **Merge node** that takes `Input 1` from a **Customer Datastore node** and `Input 2` from a **Code node**.\n2. In the **Customer Datastore node**, run the operation **Get All People**.\n3. In the **Code node**, create an array of two objects with three properties: `name`, `language`, and `country`, where the property `country` has two sub-properties `code` and `name`.\n * Fill out the values of these properties with the information of two characters from the Customer Database.\n * For example, Jay Gatsby's language is English and country name is United States.\n4. In the **Merge node**, try out different merge options.\n\nShow me the solution\n\nThe workflow for this exercise looks like this:\n\n\n\n_Workflow exercise for merging data_\n\nIf you merge data with the option **Keep Matches** using the name as the input fields to match, the result should look like this (note this example only contains Jay Gatsby; yours might look different depending on which characters you selected):\n\n\n\n_Output of Merge node with option to keep matches_\n\nTo check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108 | `{ \"meta\": { \t\"templateCredsSetupCompleted\": true, \t\"instanceId\": \"cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7\" }, \"nodes\": [ \t{ \t\"parameters\": { \t\t\"mode\": \"combine\", \t\t\"mergeByFields\": { \t\t\"values\": [ \t\t\t{ \t\t\t\"field1\": \"name\", \t\t\t\"field2\": \"name\" \t\t\t} \t\t] \t\t}, \t\t\"options\": {} \t}, \t\"id\": \"578365f3-26dd-4fa6-9858-f0a5fdfc413b\", \t\"name\": \"Merge\", \t\"type\": \"n8n-nodes-base.merge\", \t\"typeVersion\": 2.1, \t\"position\": [ \t\t720, \t\t580 \t] \t}, \t{ \t\"parameters\": {}, \t\"id\": \"71aa5aad-afdf-4f8a-bca0-34450eee8acc\", \t\"name\": \"When clicking \\\"Execute workflow\\\"\", \t\"type\": \"n8n-nodes-base.manualTrigger\", \t\"typeVersion\": 1, \t\"position\": [ \t\t260, \t\t560 \t] \t}, \t{ \t\"parameters\": { \t\t\"operation\": \"getAllPeople\" \t}, \t\"id\": \"497174fe-3cab-4160-8103-78b44efd038d\", \t\"name\": \"Customer Datastore (n8n training)\", \t\"type\": \"n8n-nodes-base.n8nTrainingCustomerDatastore\", \t\"typeVersion\": 1, \t\"position\": [ \t\t500, \t\t460 \t] \t}, \t{ \t\"parameters\": { \t\t\"jsCode\": \"return [\\n {\\n 'name': 'Jay Gatsby',\\n 'language': 'English',\\n 'country': {\\n 'code': 'US',\\n 'name': 'United States'\\n }\\n \\n }\\n \\n];\" \t}, \t\"id\": \"387e8a1e-e796-4f05-8e75-7ce25c786c5f\", \t\"name\": \"Code\", \t\"type\": \"n8n-nodes-base.code\", \t\"typeVersion\": 2, \t\"position\": [ \t\t500, \t\t720 \t] \t} ], \"connections\": { \t\"When clicking \\\"Execute workflow\\\"\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Customer Datastore (n8n training)\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t}, \t\t{ \t\t\t\"node\": \"Code\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Customer Datastore (n8n training)\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Merge\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Code\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Merge\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 1 \t\t} \t\t] \t] \t} }, \"pinData\": {} }` |\n\n## Looping[#](#looping \"Permanent link\")\n\nIn some cases, you might need to perform the same operation on each element of an array or each data item (for example sending a message to every contact in your address book). In technical terms, you need to iterate through the data (with loops).\n\nn8n generally handles this repetitive processing automatically, as the nodes run once for each item, so you don't need to build loops into your workflows.\n\nHowever, there are some [exceptions of nodes and operations](https://docs.n8n.io/flow-logic/looping/#node-exceptions) that will require you to build a loop into your workflow.\n\nTo [create a loop in an n8n workflow](https://docs.n8n.io/flow-logic/looping/#using-loops-in-n8n), you need to connect the output of one node to the input of a previous node, and add an **If node** to check when to stop the loop.\n\n## Splitting data in batches[#](#splitting-data-in-batches \"Permanent link\")\n\nIf you need to process large volumes of incoming data, execute the **Code node** multiple times, or avoid API rate limits, it's best to split the data into batches (groups) and process these batches.\n\nFor these processes, use the [**Loop Over Items node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/). This node splits input data into a specified batch size and, with each iteration, returns a predefined amount of data.\n\nExecution of Loop Over Items node\n\nThe **Loop Over Items node** stops executing after all the incoming items get divided into batches and passed on to the next node in the workflow, so it's not necessary to add an **If node** to stop the loop.\n\n### Loop/Batch Exercise[#](#loopbatch-exercise \"Permanent link\")\n\nBuild a workflow that reads the RSS feed from Medium and dev.to. The workflow should consist of three nodes:\n\n1. A **Code node** that returns the URLs of the RSS feeds of Medium (`https://medium.com/feed/n8n-io`) and dev.to (`https://dev.to/feed/n8n`).\n2. A **Loop Over Items node** with `Batch Size: 1`, that takes in the inputs from the **Code node** and **RSS Read node** and iterates over the items.\n3. An **RSS Read node** that gets the URL of the Medium RSS feed, passed as an expression: `{{ $json.url }}`.\n * The **RSS Read node** is one of the [exception nodes](https://docs.n8n.io/flow-logic/looping/#node-exceptions) which processes only the first item it receives, so the **Loop Over Items node** is necessary for iterating over multiple items.\n\nShow me the solution\n\n1. Add a **Code Node**. You can format the code in several ways, one way is:\n * Set **Mode** to `Run Once for All Items`.\n * Set **Language** to `JavaScript`.\n * Copy the code below and paste it into the JavaScript Code editor:\n \n | | |\n | --- | --- |\n | 1
2
3
4
5
6
7
8
9
10
11
12
13 | `let urls = [ \t{ \t\tjson: { \t\turl: 'https://medium.com/feed/n8n-io' \t\t} \t}, \t{ \tjson: { \t\turl: 'https://dev.to/feed/n8n' \t\t} \t} ] return urls;` |\n \n2. Add a **Loop Over Items node** connected to the **Code node**.\n * Set **Batch Size** to `1`.\n3. The **Loop Over Items node** automatically adds a node called \"Replace Me\". Replace that node with an **RSS Read node**.\n * Set the **URL** to use the url from the Code Node: `{{ $json.url }}`.\n\nThe workflow for this exercise looks like this:\n\n\n\n_Workflow for getting RSS feeds from two blogs_\n\nTo check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107 | `{ \"meta\": { \t\"templateCredsSetupCompleted\": true, \t\"instanceId\": \"cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7\" }, \"nodes\": [ \t{ \t\"parameters\": {}, \t\"id\": \"ed8dc090-ae8c-4db6-a93b-0fa873015c25\", \t\"name\": \"When clicking \\\"Execute workflow\\\"\", \t\"type\": \"n8n-nodes-base.manualTrigger\", \t\"typeVersion\": 1, \t\"position\": [ \t\t460, \t\t460 \t] \t}, \t{ \t\"parameters\": { \t\t\"jsCode\": \"let urls = [\\n {\\n json: {\\n url: 'https://medium.com/feed/n8n-io'\\n }\\n },\\n {\\n json: {\\n url: 'https://dev.to/feed/n8n'\\n } \\n }\\n]\\n\\nreturn urls;\" \t}, \t\"id\": \"1df2a9bf-f970-4e04-b906-92dbbc9e8d3a\", \t\"name\": \"Code\", \t\"type\": \"n8n-nodes-base.code\", \t\"typeVersion\": 2, \t\"position\": [ \t\t680, \t\t460 \t] \t}, \t{ \t\"parameters\": { \t\t\"options\": {} \t}, \t\"id\": \"3cce249a-0eab-42e2-90e3-dbdf3684e012\", \t\"name\": \"Loop Over Items\", \t\"type\": \"n8n-nodes-base.splitInBatches\", \t\"typeVersion\": 3, \t\"position\": [ \t\t900, \t\t460 \t] \t}, \t{ \t\"parameters\": { \t\t\"url\": \"={{ $json.url }}\", \t\t\"options\": {} \t}, \t\"id\": \"50e1c1dc-9a5d-42d3-b7c0-accc31636aa6\", \t\"name\": \"RSS Read\", \t\"type\": \"n8n-nodes-base.rssFeedRead\", \t\"typeVersion\": 1, \t\"position\": [ \t\t1120, \t\t460 \t] \t} ], \"connections\": { \t\"When clicking \\\"Execute workflow\\\"\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Code\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Code\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Loop Over Items\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Loop Over Items\": { \t\"main\": [ \t\tnull, \t\t[ \t\t{ \t\t\t\"node\": \"RSS Read\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"RSS Read\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Loop Over Items\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t} }, \"pinData\": {} }` |"
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-5/chapter-5.0/",
"markdown": "# Use case | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-5/chapter-5.0.md \"Edit this page\")\n\n## Automating a business workflow[#](#automating-a-business-workflow \"Permanent link\")\n\nRemember [our friend Nathan](https://docs.n8n.io/courses/level-one/chapter-3/)?\n\n**Nathan 🙋:** Hello, it's me again. My manager was so impressed with my first workflow automation solution that she entrusted me with more responsibility. \n**You 👩🔧:** More work and responsibility. Congratulations, I guess. What do you need to do now? \n**Nathan 🙋:** I got access to all our sales data and I'm now responsible for creating two reports: one for regional sales and one for orders prices. They're based on data from different sources and come in different formats. \n**You 👩🔧:** Sounds like a lot of manual work, but the kind that can be automated. Let's do it!\n\n## Workflow design[#](#workflow-design \"Permanent link\")\n\nNow that we know what Nathan wants to automate, let's list the steps he needs to take to achieve this:\n\n1. Get and combine data from all necessary sources.\n2. Sort the data and format the dates.\n3. Write binary files.\n4. Send notifications using email and Discord.\n\nn8n provides [core nodes](https://docs.n8n.io/integrations/builtin/node-types/#core-nodes) for all these steps. This use case is somewhat complex. We should build it from three separate workflows:\n\n1. A workflow that merges the company data with external information.\n2. A workflow that generates the reports.\n3. A workflow that monitors errors in the second workflow.\n\n## Workflow prerequisites[#](#workflow-prerequisites \"Permanent link\")\n\nTo build the workflows, you will need the following:\n\n* An [Airtable](https://airtable.com/) account and [credentials](https://docs.n8n.io/integrations/builtin/credentials/airtable/).\n* A [Google](https://www.google.com/account/about/) account and [credentials](https://docs.n8n.io/integrations/builtin/credentials/google/) to access Gmail.\n* A [Discord](https://discord.com/) account and webhook URL (you receive this using email when you sign up for this course).\n\nNext, you will build these three workflows with step-by-step instructions."
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-2/",
"markdown": "# Processing different data types | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-2.md \"Edit this page\")\n\nIn this chapter, you will learn how to process different types of data using [n8n core nodes](https://docs.n8n.io/workflows/components/nodes/).\n\n## HTML and XML data[#](#html-and-xml-data \"Permanent link\")\n\nYou're most likely familiar with HTML and XML.\n\nHTML vs. XML\n\nHTML is a markup language used to describe the structure and semantics of a web page. XML looks similar to HTML, but the tag names are different, as they describe the kind of data they hold.\n\nIf you need to process HTML or XML data in your n8n workflows, use the [**HTML node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.html/) or the [**XML node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.xml/).\n\nUse the **HTML node** to extract HTML content of a webpage by referencing CSS selectors. This is useful if you want to collect structured information from a website (web-scraping).\n\n### HTML Exercise[#](#html-exercise \"Permanent link\")\n\nLet's get the title of the latest n8n blog post:\n\n1. Use the **HTTP Request node** to make a GET request to the URL `https://blog.n8n.io/` (this endpoint requires no authentication).\n2. Connect an **HTML node** and configure it to extract the title of the first blog post on the page.\n * Hint: If you're not familiar with CSS selectors or reading HTML, the CSS selector `.post .item-title a` should help!\n\nShow me the solution\n\n1. Configure the HTTP Request node with the following parameters:\n * **Authentication**: None\n * **Request Method**: GET\n * **URL**: https://blog.n8n.io/ The result should look like this:\n\n\n\n_Result of HTTP Request node_\n\n2. Connect an **HTML node** to the **HTTP Request node** and configure the former's parameters:\n * **Operation**: Extract HTML Content\n * **Source Data**: JSON\n * **JSON Property**: data\n * **Extraction Values**:\n * **Key**: title\n * **CSS Selector**: `.post .item-title a`\n * **Return Value**: HTML\n\nYou can add more values to extract more data.\n\nThe result should look like this:\n\n\n\n_Result of HTML Extract node_\n\nUse the **XML node** to convert XML to JSON and JSON to XML. This operation is useful if you work with different web services that use either XML or JSON and need to get and submit data between them in the two formats.\n\n### XML Exercise[#](#xml-exercise \"Permanent link\")\n\nIn the [final exercise of Chapter 1](https://docs.n8n.io/courses/level-two/chapter-1/#exercise_2), you used an **HTTP Request node** to make a request to the PokéAPI. In this exercise, we'll return to that same API but we'll convert the output to XML:\n\n1. Add an **HTTP Request node** that makes the same request to the PokéAPI at `https://pokeapi.co/api/v2/pokemon`.\n2. Use the XML node to convert the JSON output to XML.\n\nShow me the solution\n\n1. To get the pokemon from the PokéAPI, execute the **HTTP Request node** with the following parameters:\n * **Authentication**: None\n * **Request Method**: GET\n * **URL**: https://pokeapi.co/api/v2/pokemon\n2. Connect an **XML node** to it with the following parameters:\n * **Mode**: JSON to XML\n * **Property name**: data\n\nThe result should look like this:\n\n\n\n_XML node (JSON to XML) – Table View_\n\nTo transform data the other way around, select the mode **XML to JSON**.\n\n## Date, time, and interval data[#](#date-time-and-interval-data \"Permanent link\")\n\nDate and time data types include `DATE`, `TIME`, `DATETIME`, `TIMESTAMP`, and `YEAR`. The dates and times can be passed in different formats, for example:\n\n* `DATE`: March 29 2022, 29-03-2022, 2022/03/29\n* `TIME`: 08:30:00, 8:30, 20:30\n* `DATETIME`: 2022/03/29 08:30:00\n* `TIMESTAMP`: 1616108400 (Unix timestamp), 1616108400000 (Unix ms timestamp)\n* `YEAR`: 2022, 22\n\nThere are a few ways you can work with dates and times:\n\n* Use the [**Date & Time node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.datetime/) to convert date and time data to different formats and calculate dates.\n* Use [**Schedule Trigger node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/) to schedule workflows to run at a specific time, interval, or duration.\n\nSometimes, you might need to pause the workflow execution. This might be necessary if you know that a service doesn't process the data instantly or it's slow to return all the results. In these cases, you don't want n8n to pass incomplete data to the next node.\n\nIf you run into situations like this, use the [**Wait node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.wait/) after the node that you want to delay. The **Wait node** pauses the workflow execution and will resume execution:\n\n* At a specific time.\n* After a specified time interval.\n* On a webhook call.\n\n### Date Exercise[#](#date-exercise \"Permanent link\")\n\nBuild a workflow that adds five days to an input date from the Customer Datastore node that you used before. Then, if the calculated date occurred after 1959, the workflow waits 1 minute before [setting](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) the calculated date as a value. The workflow should be triggered every 30 minutes.\n\nTo begin:\n\n1. Add the **Customer Datastore (n8n training) node** with the **Get All People** action selected. Return All.\n2. Add the **Date & Time node** to Round Up the created Date from the datastore to End of Month. Output this to field new-date. Include all input fields.\n3. Add the **If node** to check if that new rounded date is after `1960-01-01 00:00:00`.\n4. Add the **Wait node** to the True output of that node and set it to wait for one minute.\n5. Add the **Edit Fields (Set) node** to set a new field called outputValue to a String containing new-date. Include all input fields.\n6. Add the **Schedule Trigger node** at the beginning of the workflow to trigger it every 30 minutes. (You can keep the [Manual Trigger node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger/) for testing!)\n\nShow me the solution\n\n1. Add the **Customer Datastore (n8n training) node** with the **Get All People** action selected.\n * Select the option to **Return All**.\n2. Add a **Date & Time node** connected to the Customer Datastore node. Select the option to **Round a Date**.\n * Add the `created` date as the **Date** to round.\n * Select `Round Up` as the **Mode** and `End of Month` as the **To**.\n * Set the **Output Field Name** as `new-date`.\n * In **Options**, select **Add Option** and use the control to **Include Input Fields**\n3. Add an **If node** connected to the **Date & Time node**.\n * Add the new-date field as the first part of the condition.\n * Set the comparison to **Date &Time > is after**\n * Add `1960-01-01 00:00:00` as the second part of the expression. (This should produce 3 items in the True Branch and 2 items in the False Branch)\n4. Add a **Wait node** to the True output of the **If node**.\n * Set **Resume** to `After Time interval`.\n * Set **Wait Amount** to `1.00`.\n * Set **Wait Unit** to `Minutes`.\n5. Add an **Edit Fields (Set) node** to the **Wait node**.\n * Use either JSON or Manual Mapping **Mode**.\n * Set a new field called `outputValue` to be the value of the new-date field.\n * Select the option to **Include Other Input Fields** and include **All** fields.\n6. Add a **Schedule Trigger node** at the beginning of the workflow.\n * Set the **Trigger Interval** to use `Minutes`.\n * Set the **Minutes Between Triggers** to 30.\n * To test your schedule, be sure to activate the workflow.\n * Be sure to connect this node to the **Customer Datastore (n8n training) node** you began with!\n\nThe workflow should look like this:\n\n\n\n_Workflow for transforming dates_\n\nTo check the configuration of each node, you can copy the JSON code of this workflow and either paste it into the Editor UI or save it as a file and import from file into a new workflow. See [Export and import workflows](https://docs.n8n.io/workflows/export-import/) for more information.\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209 | `{ \"name\": \"Course 2, Ch 2, Date exercise\", \"nodes\": [ \t{ \t\"parameters\": {}, \t\"id\": \"6bf64d5c-4b00-43cf-8439-3cbf5e5f203b\", \t\"name\": \"When clicking \\\"Execute workflow\\\"\", \t\"type\": \"n8n-nodes-base.manualTrigger\", \t\"typeVersion\": 1, \t\"position\": [ \t\t620, \t\t280 \t] \t}, \t{ \t\"parameters\": { \t\t\"operation\": \"getAllPeople\", \t\t\"returnAll\": true \t}, \t\"id\": \"a08a8157-99ee-4d50-8fe4-b6d7e16e858e\", \t\"name\": \"Customer Datastore (n8n training)\", \t\"type\": \"n8n-nodes-base.n8nTrainingCustomerDatastore\", \t\"typeVersion\": 1, \t\"position\": [ \t\t840, \t\t360 \t] \t}, \t{ \t\"parameters\": { \t\t\"operation\": \"roundDate\", \t\t\"date\": \"={{ $json.created }}\", \t\t\"mode\": \"roundUp\", \t\t\"outputFieldName\": \"new-date\", \t\t\"options\": { \t\t\"includeInputFields\": true \t\t} \t}, \t\"id\": \"f66a4356-2584-44b6-a4e9-1e3b5de53e71\", \t\"name\": \"Date & Time\", \t\"type\": \"n8n-nodes-base.dateTime\", \t\"typeVersion\": 2, \t\"position\": [ \t\t1080, \t\t360 \t] \t}, \t{ \t\"parameters\": { \t\t\"conditions\": { \t\t\"options\": { \t\t\t\"caseSensitive\": true, \t\t\t\"leftValue\": \"\", \t\t\t\"typeValidation\": \"strict\" \t\t}, \t\t\"conditions\": [ \t\t\t{ \t\t\t\"id\": \"7c82823a-e603-4166-8866-493f643ba354\", \t\t\t\"leftValue\": \"={{ $json['new-date'] }}\", \t\t\t\"rightValue\": \"1960-01-01T00:00:00\", \t\t\t\"operator\": { \t\t\t\t\"type\": \"dateTime\", \t\t\t\t\"operation\": \"after\" \t\t\t} \t\t\t} \t\t], \t\t\"combinator\": \"and\" \t\t}, \t\t\"options\": {} \t}, \t\"id\": \"cea39877-6183-4ea0-9400-e80523636912\", \t\"name\": \"If\", \t\"type\": \"n8n-nodes-base.if\", \t\"typeVersion\": 2, \t\"position\": [ \t\t1280, \t\t360 \t] \t}, \t{ \t\"parameters\": { \t\t\"amount\": 1, \t\t\"unit\": \"minutes\" \t}, \t\"id\": \"5aa860b7-c73c-4df0-ad63-215850166f13\", \t\"name\": \"Wait\", \t\"type\": \"n8n-nodes-base.wait\", \t\"typeVersion\": 1.1, \t\"position\": [ \t\t1480, \t\t260 \t], \t\"webhookId\": \"be78732e-787d-463e-9210-2c7e8239761e\" \t}, \t{ \t\"parameters\": { \t\t\"assignments\": { \t\t\"assignments\": [ \t\t\t{ \t\t\t\"id\": \"e058832a-2461-4c6d-b584-043ecc036427\", \t\t\t\"name\": \"outputValue\", \t\t\t\"value\": \"={{ $json['new-date'] }}\", \t\t\t\"type\": \"string\" \t\t\t} \t\t] \t\t}, \t\t\"includeOtherFields\": true, \t\t\"options\": {} \t}, \t\"id\": \"be034e9e-3cf1-4264-9d15-b6760ce28f91\", \t\"name\": \"Edit Fields\", \t\"type\": \"n8n-nodes-base.set\", \t\"typeVersion\": 3.3, \t\"position\": [ \t\t1700, \t\t260 \t] \t}, \t{ \t\"parameters\": { \t\t\"rule\": { \t\t\"interval\": [ \t\t\t{ \t\t\t\"field\": \"minutes\", \t\t\t\"minutesInterval\": 30 \t\t\t} \t\t] \t\t} \t}, \t\"id\": \"6e8e4308-d0e0-4d0d-bc29-5131b57cf061\", \t\"name\": \"Schedule Trigger\", \t\"type\": \"n8n-nodes-base.scheduleTrigger\", \t\"typeVersion\": 1.1, \t\"position\": [ \t\t620, \t\t480 \t] \t} ], \"pinData\": {}, \"connections\": { \t\"When clicking \\\"Execute workflow\\\"\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Customer Datastore (n8n training)\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Customer Datastore (n8n training)\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Date & Time\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Date & Time\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"If\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"If\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Wait\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Wait\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Edit Fields\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t}, \t\"Schedule Trigger\": { \t\"main\": [ \t\t[ \t\t{ \t\t\t\"node\": \"Customer Datastore (n8n training)\", \t\t\t\"type\": \"main\", \t\t\t\"index\": 0 \t\t} \t\t] \t] \t} } }` |\n\n## Binary data[#](#binary-data \"Permanent link\")\n\nUp to now, you have mainly worked with text data. But what if you want to process data that's not text, like images or PDF files? These types of files are represented in the binary numeral system, so they're considered binary data. In this form, binary data doesn't offer you useful information, so you'll need to convert it into a readable form.\n\nIn n8n, you can process binary data with the following nodes:\n\n* [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to request and send files from/to web resources and APIs.\n* [Read/Write Files from Disk](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile/) to read and write files from/to the machine where n8n is running.\n* [Convert to File](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.converttofile/) to take input data and output it as a file.\n* [Extract From File](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/) to get data from a binary format and convert it to JSON.\n\nReading and writing files is only available on self-hosted n8n\n\nReading and writing files to disk isn't available on n8n Cloud. You'll read and write to the machine where you installed n8n. If you run n8n in Docker, your command runs in the n8n container and not the Docker host. The Read/Write Files From Disk node looks for files relative to the n8n install path. n8n recommends using absolute file paths to prevent any errors.\n\nTo read or write a binary file, you need to write the path (location) of the file in the node's `File(s) Selector` parameter (for the Read operation) or in the node's `File Path and Name` parameter (for the Write operation).\n\nNaming the right path\n\nThe file path looks slightly different depending on how you are running n8n:\n\n* npm: `~/my_file.json`\n* n8n cloud / Docker: `/tmp/my_file.json`\n\n### Binary Exercise 1[#](#binary-exercise-1 \"Permanent link\")\n\nFor our first binary exercise, let's convert a PDF file to JSON:\n\n1. Make an HTTP request to get this PDF file: `https://media.kaspersky.com/pdf/Kaspersky_Lab_Whitepaper_Anti_blocker.pdf.`\n2. Use the **Extract From File node** to convert the file from binary to JSON.\n\nShow me the solution\n\nIn the **HTTP Request node**, you should see the PDF file, like this:\n\n\n\n_HTTP Request node to get PDF_\n\nWhen you convert the PDF from binary to JSON using the **Extract From File node**, the result should look like this:\n\n\n\n_Extract From File node_\n\nTo check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69 | `{ \t\"name\": \"Binary to JSON\", \t\"nodes\": [ \t\t{ \t\t\"parameters\": {}, \t\t\"id\": \"78639a25-b69a-4b9c-84e0-69e045bed1a3\", \t\t\"name\": \"When clicking \\\"Execute Workflow\\\"\", \t\t\"type\": \"n8n-nodes-base.manualTrigger\", \t\t\"typeVersion\": 1, \t\t\"position\": [ \t\t\t480, \t\t\t520 \t\t] \t\t}, \t\t{ \t\t\"parameters\": { \t\t\t\"url\": \"https://media.kaspersky.com/pdf/Kaspersky_Lab_Whitepaper_Anti_blocker.pdf\", \t\t\t\"options\": {} \t\t}, \t\t\"id\": \"a11310df-1287-4e9a-b993-baa6bd4265a6\", \t\t\"name\": \"HTTP Request\", \t\t\"type\": \"n8n-nodes-base.httpRequest\", \t\t\"typeVersion\": 4.1, \t\t\"position\": [ \t\t\t700, \t\t\t520 \t\t] \t\t}, \t\t{ \t\t\"parameters\": { \t\t\t\"operation\": \"pdf\", \t\t\t\"options\": {} \t\t}, \t\t\"id\": \"88697b6b-fb02-4c3d-a715-750d60413e9f\", \t\t\"name\": \"Extract From File\", \t\t\"type\": \"n8n-nodes-base.extractFromFile\", \t\t\"typeVersion\": 1, \t\t\"position\": [ \t\t\t920, \t\t\t520 \t\t] \t\t} \t], \t\"pinData\": {}, \t\"connections\": { \t\t\"When clicking \\\"Execute Workflow\\\"\": { \t\t\"main\": [ \t\t\t[ \t\t\t{ \t\t\t\t\"node\": \"HTTP Request\", \t\t\t\t\"type\": \"main\", \t\t\t\t\"index\": 0 \t\t\t} \t\t\t] \t\t] \t\t}, \t\t\"HTTP Request\": { \t\t\"main\": [ \t\t\t[ \t\t\t{ \t\t\t\t\"node\": \"Extract From File\", \t\t\t\t\"type\": \"main\", \t\t\t\t\"index\": 0 \t\t\t} \t\t\t] \t\t] \t\t} \t} }` |\n\n### Binary Exercise 2[#](#binary-exercise-2 \"Permanent link\")\n\nFor our second binary exercise, let's convert some JSON data to binary:\n\n1. Make an HTTP request to the Poetry DB API `https://poetrydb.org/random/1`.\n2. Convert the returned data from JSON to binary using the **Convert to File node**.\n3. Write the new binary file data to the machine where n8n is running using the **Read/Write Files From Disk node**.\n4. To check that it worked out, use the **Read/Write Files From Disk node** to read the generated binary file.\n\nShow me the solution\n\nThe workflow for this exercise looks like this:\n\n\n\n_Workflow for moving JSON to binary data_\n\nTo check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120 | `{ \t\"name\": \"JSON to file and Read-Write\", \t\"nodes\": [ \t\t{ \t\t\"parameters\": {}, \t\t\"id\": \"78639a25-b69a-4b9c-84e0-69e045bed1a3\", \t\t\"name\": \"When clicking \\\"Execute Workflow\\\"\", \t\t\"type\": \"n8n-nodes-base.manualTrigger\", \t\t\"typeVersion\": 1, \t\t\"position\": [ \t\t\t480, \t\t\t520 \t\t] \t\t}, \t\t{ \t\t\"parameters\": { \t\t\t\"url\": \"https://poetrydb.org/random/1\", \t\t\t\"options\": {} \t\t}, \t\t\"id\": \"a11310df-1287-4e9a-b993-baa6bd4265a6\", \t\t\"name\": \"HTTP Request\", \t\t\"type\": \"n8n-nodes-base.httpRequest\", \t\t\"typeVersion\": 4.1, \t\t\"position\": [ \t\t\t680, \t\t\t520 \t\t] \t\t}, \t\t{ \t\t\"parameters\": { \t\t\t\"operation\": \"toJson\", \t\t\t\"options\": {} \t\t}, \t\t\"id\": \"06be18f6-f193-48e2-a8d9-35f4779d8324\", \t\t\"name\": \"Convert to File\", \t\t\"type\": \"n8n-nodes-base.convertToFile\", \t\t\"typeVersion\": 1, \t\t\"position\": [ \t\t\t880, \t\t\t520 \t\t] \t\t}, \t\t{ \t\t\"parameters\": { \t\t\t\"operation\": \"write\", \t\t\t\"fileName\": \"/tmp/poetrydb.json\", \t\t\t\"options\": {} \t\t}, \t\t\"id\": \"f2048e5d-fa8f-4708-b15a-d07de359f2e5\", \t\t\"name\": \"Read/Write Files from Disk\", \t\t\"type\": \"n8n-nodes-base.readWriteFile\", \t\t\"typeVersion\": 1, \t\t\"position\": [ \t\t\t1080, \t\t\t520 \t\t] \t\t}, \t\t{ \t\t\"parameters\": { \t\t\t\"fileSelector\": \"={{ $json.fileName }}\", \t\t\t\"options\": {} \t\t}, \t\t\"id\": \"d630906c-09d4-49f4-ba14-416c0f4de1c8\", \t\t\"name\": \"Read/Write Files from Disk1\", \t\t\"type\": \"n8n-nodes-base.readWriteFile\", \t\t\"typeVersion\": 1, \t\t\"position\": [ \t\t\t1280, \t\t\t520 \t\t] \t\t} \t], \t\"pinData\": {}, \t\"connections\": { \t\t\"When clicking \\\"Execute Workflow\\\"\": { \t\t\"main\": [ \t\t\t[ \t\t\t{ \t\t\t\t\"node\": \"HTTP Request\", \t\t\t\t\"type\": \"main\", \t\t\t\t\"index\": 0 \t\t\t} \t\t\t] \t\t] \t\t}, \t\t\"HTTP Request\": { \t\t\"main\": [ \t\t\t[ \t\t\t{ \t\t\t\t\"node\": \"Convert to File\", \t\t\t\t\"type\": \"main\", \t\t\t\t\"index\": 0 \t\t\t} \t\t\t] \t\t] \t\t}, \t\t\"Convert to File\": { \t\t\"main\": [ \t\t\t[ \t\t\t{ \t\t\t\t\"node\": \"Read/Write Files from Disk\", \t\t\t\t\"type\": \"main\", \t\t\t\t\"index\": 0 \t\t\t} \t\t\t] \t\t] \t\t}, \t\t\"Read/Write Files from Disk\": { \t\t\"main\": [ \t\t\t[ \t\t\t{ \t\t\t\t\"node\": \"Read/Write Files from Disk1\", \t\t\t\t\"type\": \"main\", \t\t\t\t\"index\": 0 \t\t\t} \t\t\t] \t\t] \t\t} \t} }` |"
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-5/chapter-5.1/",
"markdown": "# Workflow 1 | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-5/chapter-5.1.md \"Edit this page\")\n\n## Workflow 1: Merging data[#](#workflow-1-merging-data \"Permanent link\")\n\nNathan's company stores its customer data in Airtable. This data contains information about the customers' ID, country, email, and join date, but lacks data about their respective region and subregion. You need to fill in these last two fields in order to create the reports for regional sales.\n\nTo accomplish this task, you first need to make a copy of this table in your Airtable account:\n\nNext, build a small workflow that merges data from Airtable and a REST Countries API:\n\n1. Use the [**Airtable node**](https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.airtable/) to list the data in the Airtable table named `customers`.\n2. Use the [**HTTP Request node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to get data from the REST Countries API: `https://restcountries.com/v3.1/all`, and send the query parameter name `fields` with the value `name,region,subregion`. This will return data about world countries, split out into separate items.\n3. Use the [**Merge node**](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.merge/) to merge data from Airtable and the Countries API by country name, represented as `customerCountry` in Airtable and `name.common` in the Countries API, respectively.\n4. Use another Airtable node to update the fields `region` and `subregion` in Airtable with the data from the Countries API.\n\nThe workflow should look like this:\n\n\n\n_Workflow 1 for merging data from Airtable and the Countries API_\n\nQuiz questions\n\n* How many items does the **HTTP Request node** return?\n* How many items does the **Merge node** return?\n* How many unique regions are assigned in the customers table?\n* What's the subregion assigned to the customerID 10?"
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-5/chapter-5.3/",
"markdown": "# Workflow 3 | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-5/chapter-5.3.md \"Edit this page\")\n\n## Workflow 3: Monitoring workflow errors[#](#workflow-3-monitoring-workflow-errors \"Permanent link\")\n\nLast but not least, let's help Nathan know if there are any errors running the workflow.\n\nTo accomplish this task, create an Error workflow that monitors the main workflow:\n\n1. Create a new workflow.\n2. Add an **Error Trigger node** (and execute it as a test).\n3. Connect a **Discord node** to the **Error Trigger node** and configure these fields: \n \n * **Webhook URL**: The Discord URL that you received in the email from n8n when you signed up for this course.\n * **Text**: \"The workflow `{workflow name}` failed, with the error message: `{execution error message}`. Last node executed: `{name of the last executed node}`. Check this workflow execution here: `{execution URL}` My Unique ID: \" followed by the unique ID emailed to you when you registered for this course.\n \n Note that you need to replace the text in curly brackets `{}` with expressions that take the respective information from the Error Trigger node. \n \n4. Execute the Discord node.\n \n5. Set the newly created workflow as the **Error Workflow** for the main workflow you created in the previous lesson.\n\nThe workflow should look like this:\n\n\n\n_Workflow 3 for monitoring workflow errors_\n\nQuiz questions\n\n* What fields does the **Error Trigger node** return?\n* What information about the execution does the **Error Trigger node** return?\n* What information about the workflow does the **Error Trigger node** return?\n* What's the expression to reference the workflow name?"
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-6/",
"markdown": "# Test your knowledge | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/courses/level-two/chapter-6.md \"Edit this page\")\n\nCongratulations, you finished the n8n Course Level 2!\n\nYou've learned a lot about workflow automation and built quite a complex business workflow. Why not showcase your skills?\n\nYou can test your knowledge by taking a **quiz**, which consists of questions about the theoretical concepts and workflows covered in this course.\n\n* You need to have at least 80% correct answers to pass the quiz.\n* You can take the quiz as many times as you want.\n* There's no time limit on answering the quiz questions.\n\n \n[Take the quiz!](https://n8n-community.typeform.com/to/r9hDbytg)\n\n## What's next?[#](#whats-next \"Permanent link\")\n\n* Create new workflows for your work or personal use and share them with us. Don't have any ideas? Find inspiration on the [workflows page](https://n8n.io/workflows) and on our [blog](https://n8n.io/blog/).\n* Dive deeper into n8n's features by reading the [docs](https://docs.n8n.io/)."
},
{
"url": "https://docs.n8n.io/courses/level-two/chapter-5/chapter-5.2/",
"markdown": "# Workflow 2 | n8n Docs\n\nTo check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492 | `{ \"meta\": { \"templateCredsSetupCompleted\": true, \"instanceId\": \"cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7\" }, \"nodes\": [ { \"parameters\": { \"sendTo\": \"bart@n8n.io\", \"subject\": \"Your TPS Reports\", \"emailType\": \"text\", \"message\": \"Please find your TPS report attached.\", \"options\": { \"attachmentsUi\": { \"attachmentsBinary\": [ {} ] } } }, \"id\": \"d889eb42-8b34-4718-b961-38c8e7839ea6\", \"name\": \"Gmail\", \"type\": \"n8n-nodes-base.gmail\", \"typeVersion\": 2.1, \"position\": [ 2100, 500 ], \"credentials\": { \"gmailOAuth2\": { \"id\": \"HFesCcFcn1NW81yu\", \"name\": \"Gmail account 7\" } } }, { \"parameters\": {}, \"id\": \"c0236456-40be-4f8f-a730-e56cb62b7b5c\", \"name\": \"When clicking \\\"Execute workflow\\\"\", \"type\": \"n8n-nodes-base.manualTrigger\", \"typeVersion\": 1, \"position\": [ 780, 600 ] }, { \"parameters\": { \"url\": \"https://internal.users.n8n.cloud/webhook/level2-erp\", \"authentication\": \"genericCredentialType\", \"genericAuthType\": \"httpHeaderAuth\", \"sendHeaders\": true, \"headerParameters\": { \"parameters\": [ { \"name\": \"unique_id\", \"value\": \"recFIcD6UlSyxaVMQ\" } ] }, \"options\": {} }, \"id\": \"cc106fa0-6630-4c84-aea4-a4c7a3c149e9\", \"name\": \"HTTP Request\", \"type\": \"n8n-nodes-base.httpRequest\", \"typeVersion\": 4.1, \"position\": [ 1000, 500 ], \"credentials\": { \"httpHeaderAuth\": { \"id\": \"qeHdJdqqqaTC69cm\", \"name\": \"Course L2 Credentials\" } } }, { \"parameters\": { \"operation\": \"search\", \"base\": { \"__rl\": true, \"value\": \"apprtKkVasbQDbFa1\", \"mode\": \"list\", \"cachedResultName\": \"All your base\", \"cachedResultUrl\": \"https://airtable.com/apprtKkVasbQDbFa1\" }, \"table\": { \"__rl\": true, \"value\": \"tblInZ7jeNdlUOvxZ\", \"mode\": \"list\", \"cachedResultName\": \"Course L2, Workflow 1\", \"cachedResultUrl\": \"https://airtable.com/apprtKkVasbQDbFa1/tblInZ7jeNdlUOvxZ\" }, \"options\": {} }, \"id\": \"e5ae1927-b531-401c-9cb2-ecf1f2836ba6\", \"name\": \"Airtable\", \"type\": \"n8n-nodes-base.airtable\", \"typeVersion\": 2, \"position\": [ 1000, 700 ], \"credentials\": { \"airtableTokenApi\": { \"id\": \"MIplo6lY3AEsdf7L\", \"name\": \"Airtable Personal Access Token account 4\" } } }, { \"parameters\": { \"mode\": \"combine\", \"mergeByFields\": { \"values\": [ { \"field1\": \"customerID\", \"field2\": \"customerID\" } ] }, \"options\": {} }, \"id\": \"1cddc984-7fca-45e0-83b8-0c502cb4c78c\", \"name\": \"Merge\", \"type\": \"n8n-nodes-base.merge\", \"typeVersion\": 2.1, \"position\": [ 1220, 600 ] }, { \"parameters\": { \"sortFieldsUi\": { \"sortField\": [ { \"fieldName\": \"orderPrice\", \"order\": \"descending\" } ] }, \"options\": {} }, \"id\": \"2f55af2e-f69b-4f61-a9e5-c7eefaad93ba\", \"name\": \"Sort\", \"type\": \"n8n-nodes-base.sort\", \"typeVersion\": 1, \"position\": [ 1440, 600 ] }, { \"parameters\": { \"conditions\": { \"options\": { \"caseSensitive\": true, \"leftValue\": \"\", \"typeValidation\": \"strict\" }, \"conditions\": [ { \"id\": \"d3afe65c-7c80-4caa-9d1c-33c62fbc2197\", \"leftValue\": \"={{ $json.region }}\", \"rightValue\": \"Americas\", \"operator\": { \"type\": \"string\", \"operation\": \"equals\", \"name\": \"filter.operator.equals\" } } ], \"combinator\": \"and\" }, \"options\": {} }, \"id\": \"2ed874a9-5bcf-4cc9-9b52-ea503a562892\", \"name\": \"If\", \"type\": \"n8n-nodes-base.if\", \"typeVersion\": 2, \"position\": [ 1660, 500 ] }, { \"parameters\": { \"operation\": \"toJson\", \"mode\": \"each\", \"options\": { \"fileName\": \"=report_orderID_{{ $('If').item.json.orderID }}.json\" } }, \"id\": \"d93b4429-2200-4a84-8505-16266fedfccd\", \"name\": \"Convert to File\", \"type\": \"n8n-nodes-base.convertToFile\", \"typeVersion\": 1.1, \"position\": [ 1880, 500 ] }, { \"parameters\": { \"authentication\": \"webhook\", \"content\": \"I sent the file using email with the label ID and wrote the binary file {file name}. My ID: 123\", \"options\": {} }, \"id\": \"26f43f2c-1422-40de-9f40-dd2d80926b1c\", \"name\": \"Discord\", \"type\": \"n8n-nodes-base.discord\", \"typeVersion\": 2, \"position\": [ 2320, 500 ], \"credentials\": { \"discordWebhookApi\": { \"id\": \"WEBrtPdoLrhlDYKr\", \"name\": \"L2 Course Discord Webhook account\" } } }, { \"parameters\": { \"batchSize\": 5, \"options\": {} }, \"id\": \"0fa1fbf6-fe77-4044-a445-c49a1db37dec\", \"name\": \"Loop Over Items\", \"type\": \"n8n-nodes-base.splitInBatches\", \"typeVersion\": 3, \"position\": [ 1660, 700 ] }, { \"parameters\": { \"assignments\": { \"assignments\": [ { \"id\": \"ce839b80-c50d-48f5-9a24-bb2df6fdd2ff\", \"name\": \"customerEmail\", \"value\": \"={{ $json.customerEmail }}\", \"type\": \"string\" }, { \"id\": \"0c613366-3808-45a2-89cc-b34c7b9f3fb7\", \"name\": \"region\", \"value\": \"={{ $json.region }}\", \"type\": \"string\" }, { \"id\": \"0f19a88c-deb0-4119-8965-06ed62a840b2\", \"name\": \"customerSince\", \"value\": \"={{ $json.customerSince }}\", \"type\": \"string\" }, { \"id\": \"a7e890d6-86af-4839-b5df-d2a4efe923f7\", \"name\": \"orderPrice\", \"value\": \"={{ $json.orderPrice }}\", \"type\": \"number\" } ] }, \"options\": {} }, \"id\": \"09b8584c-4ead-4007-a6cd-edaa4669a757\", \"name\": \"Edit Fields\", \"type\": \"n8n-nodes-base.set\", \"typeVersion\": 3.3, \"position\": [ 1880, 700 ] }, { \"parameters\": { \"operation\": \"formatDate\", \"date\": \"={{ $json.customerSince }}\", \"options\": { \"includeInputFields\": true } }, \"id\": \"c96fae90-e080-48dd-9bff-3e4506aafb86\", \"name\": \"Date & Time\", \"type\": \"n8n-nodes-base.dateTime\", \"typeVersion\": 2, \"position\": [ 2100, 700 ] }, { \"parameters\": { \"options\": { \"fileName\": \"={{$runIndex > 0 ? 'file_low_orders':'file_high_orders'}}\" } }, \"id\": \"43dc8634-2f16-442b-a754-89f47c51c591\", \"name\": \"Convert to File1\", \"type\": \"n8n-nodes-base.convertToFile\", \"typeVersion\": 1.1, \"position\": [ 2320, 700 ] }, { \"parameters\": { \"authentication\": \"webhook\", \"content\": \"I created the spreadsheet {file name}. My ID: 123\", \"options\": {} }, \"id\": \"05da1c22-d1f6-4ea6-9102-f74f9ae2e9d3\", \"name\": \"Discord1\", \"type\": \"n8n-nodes-base.discord\", \"typeVersion\": 2, \"position\": [ 2540, 700 ], \"credentials\": { \"discordWebhookApi\": { \"id\": \"WEBrtPdoLrhlDYKr\", \"name\": \"L2 Course Discord Webhook account\" } } } ], \"connections\": { \"Gmail\": { \"main\": [ [ { \"node\": \"Discord\", \"type\": \"main\", \"index\": 0 } ] ] }, \"When clicking \\\"Execute workflow\\\"\": { \"main\": [ [ { \"node\": \"HTTP Request\", \"type\": \"main\", \"index\": 0 }, { \"node\": \"Airtable\", \"type\": \"main\", \"index\": 0 } ] ] }, \"HTTP Request\": { \"main\": [ [ { \"node\": \"Merge\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Airtable\": { \"main\": [ [ { \"node\": \"Merge\", \"type\": \"main\", \"index\": 1 } ] ] }, \"Merge\": { \"main\": [ [ { \"node\": \"Sort\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Sort\": { \"main\": [ [ { \"node\": \"Loop Over Items\", \"type\": \"main\", \"index\": 0 }, { \"node\": \"If\", \"type\": \"main\", \"index\": 0 } ] ] }, \"If\": { \"main\": [ [ { \"node\": \"Convert to File\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Convert to File\": { \"main\": [ [ { \"node\": \"Gmail\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Loop Over Items\": { \"main\": [ null, [ { \"node\": \"Edit Fields\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Edit Fields\": { \"main\": [ [ { \"node\": \"Date & Time\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Date & Time\": { \"main\": [ [ { \"node\": \"Convert to File1\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Convert to File1\": { \"main\": [ [ { \"node\": \"Discord1\", \"type\": \"main\", \"index\": 0 } ] ] }, \"Discord1\": { \"main\": [ [ { \"node\": \"Loop Over Items\", \"type\": \"main\", \"index\": 0 } ] ] } }, \"pinData\": {} }` |"
},
{
"url": "https://docs.n8n.io/workflows/components/",
"markdown": "# Workflow components | n8n Docs\n\n[Skip to content](#workflow-components)\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/components/index.md \"Edit this page\")\n\nThis section contains:\n\n* [Nodes](https://docs.n8n.io/workflows/components/nodes/): integrations and operations.\n* [Connections](https://docs.n8n.io/workflows/components/connections/): node connectors.\n* [Sticky notes](https://docs.n8n.io/workflows/components/sticky-notes/): document your workflows."
},
{
"url": "https://docs.n8n.io/workflows/components/nodes/",
"markdown": "# Nodes | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/components/nodes.md \"Edit this page\")\n\n[Nodes](https://docs.n8n.io/glossary/#node-n8n) are the key building blocks of a [workflow](https://docs.n8n.io/glossary/#workflow-n8n). They perform a range of actions, including:\n\n* Starting the workflow.\n* Fetching and sending data.\n* Processing and manipulating data.\n\nn8n provides a collection of built-in nodes, as well as the ability to create your own nodes. Refer to:\n\n* [Built-in integrations](https://docs.n8n.io/integrations/builtin/node-types/) to browse the node library.\n* [Community nodes](https://docs.n8n.io/integrations/community-nodes/installation/) for guidance on finding and installing community-created nodes.\n* [Creating nodes](https://docs.n8n.io/integrations/creating-nodes/overview/) to start building your own nodes.\n\n## Add a node to your workflow[#](#add-a-node-to-your-workflow \"Permanent link\")\n\n### Add a node to an empty workflow[#](#add-a-node-to-an-empty-workflow \"Permanent link\")\n\n1. Select **Add first step**. n8n opens the nodes panel, where you can search or browse [trigger nodes](https://docs.n8n.io/glossary/#trigger-node-n8n).\n2. Select the trigger you want to use.\n \n Choose the correct app event\n \n If you select **On App Event**, n8n shows a list of all the supported services. Use this list to browse n8n's integrations and trigger a workflow in response to an event in your chosen service. Not all integrations have triggers. To see which ones you can use as a trigger, select the node. If a trigger is available, you'll see it at the top of the available operations list.\n \n For example, this is the trigger for Asana:\n \n \n \n\n### Add a node to an existing workflow[#](#add-a-node-to-an-existing-workflow \"Permanent link\")\n\nSelect the **Add node**  connector. n8n opens the nodes panel, where you can search or browse all nodes.\n\n## Node operations: Triggers and Actions[#](#node-operations-triggers-and-actions \"Permanent link\")\n\nWhen you add a node to a workflow, n8n displays a list of available operations. An operation is something a node does, such as getting or sending data.\n\nThere are two types of operation:\n\n* Triggers start a workflow in response to specific events or conditions in your services. When you select a Trigger, n8n adds a trigger node to your workflow, with the Trigger operation you chose pre-selected. When you search for a node in n8n, Trigger operations have a bolt icon .\n* Actions are operations that represent specific tasks within a workflow, which you can use to manipulate data, perform operations on external systems, and trigger events in other systems as part of your workflows. When you select an Action, n8n adds a node to your workflow, with the Action operation you chose pre-selected.\n\n## Node controls[#](#node-controls \"Permanent link\")\n\nTo view node controls, hover over the node on the canvas:\n\n## Node settings[#](#node-settings \"Permanent link\")\n\nThe node settings under the **Settings** tab allow you to control node behaviors and add node notes.\n\nWhen active or set, they do the following:\n\n* **Request Options**: Select **Add Option** to view and select these options.\n * **Batching**: Control how to batch large numbers of input items.\n * **Ignore SSL Issues**: Download the response even if SSL validation isn't possible.\n * **Proxy**: Use this if you need to specify an HTTP proxy.\n * **Timeout**: Set a timeout for the request in ms.\n* **Always Output Data**: The node returns an empty item even if the node returns no data during execution. Be careful setting this on IF nodes, as it could cause an infinite loop.\n* **Execute Once**: The node executes once, with data from the first item it receives. It doesn't process any extra items.\n* **Retry On Fail**: When an execution fails, the node reruns until it succeeds.\n* **On Error**:\n * **Stop Workflow**: Halts the entire workflow when an error occurs, preventing further node execution.\n * **Continue**: Proceeds to the next node despite the error, using the last valid data.\n * **Continue (using error output)**: Continues workflow execution, passing error information to the next node for potential handling.\n\nYou can document your workflow using node notes:\n\n* **Notes**: Note to save with the node.\n* **Display note in flow**: If active, n8n displays the note in the workflow as a subtitle."
},
{
"url": "https://docs.n8n.io/workflows/",
"markdown": "# Workflows | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/index.md \"Edit this page\")\n\nA [workflow](https://docs.n8n.io/glossary/#workflow-n8n) is a collection of nodes connected together to automate a process.\n\n* [Create](https://docs.n8n.io/workflows/create/) a workflow.\n* Use [Workflow templates](https://docs.n8n.io/workflows/templates/) to help you get started.\n* Learn about the key [components](https://docs.n8n.io/workflows/components/) of an automation in n8n.\n* Debug using the [Executions](https://docs.n8n.io/workflows/executions/) list.\n* [Share](https://docs.n8n.io/workflows/sharing/) workflows between users.\n\nIf it's your first time building a workflow, you may want to use the [quickstart guides](https://docs.n8n.io/try-it-out/) to quickly try out n8n features."
},
{
"url": "https://docs.n8n.io/workflows/components/connections/",
"markdown": "# Connections | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/components/connections.md \"Edit this page\")\n\nA connection establishes a link between nodes to route data through the workflow. A connection between two nodes passes data from one node's output to another node's input.\n\n\n\n## Create a connection[#](#create-a-connection \"Permanent link\")\n\nTo create a connection between two nodes, select the grey dot or **Add node**  on the right side of a node and slide the arrow to the grey rectangle on the left side of the following node.\n\n## Delete a connection[#](#delete-a-connection \"Permanent link\")\n\nHover over the connection, then select **Delete** ."
},
{
"url": "https://docs.n8n.io/workflows/components/sticky-notes/",
"markdown": "# Sticky Notes | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/components/sticky-notes.md \"Edit this page\")\n\nSticky Notes allow you to annotate and comment on your workflows.\n\nn8n recommends using Sticky Notes heavily, especially on [template workflows](https://docs.n8n.io/glossary/#template-n8n), to help other users understand your workflow.\n\n\n\n## Create a Sticky Note[#](#create-a-sticky-note \"Permanent link\")\n\nSticky Notes are a core node. To add a new Sticky Note:\n\n1. Open the nodes panel.\n2. Search for `note`.\n3. Click the **Sticky Note** node. n8n adds a new Sticky Note to the canvas.\n\n## Edit a Sticky Note[#](#edit-a-sticky-note \"Permanent link\")\n\n1. Double click the Sticky Note you want to edit.\n2. Write your note. [This guide](https://commonmark.org/help/) explains how to format your text with Markdown. n8n uses [markdown-it](https://github.com/markdown-it/markdown-it), which implements the CommonMark specification.\n3. Click away from the note, or press `Esc`, to stop editing.\n\n## Change the color[#](#change-the-color \"Permanent link\")\n\nTo change the Sticky Note color:\n\n1. Hover over the Sticky Note\n2. Select **Change color** \n\n## Sticky Note positioning[#](#sticky-note-positioning \"Permanent link\")\n\nYou can:\n\n* Drag a Sticky Note anywhere on the canvas.\n* Drag Sticky Notes behind nodes. You can use this to visually group nodes.\n* Resize Sticky Notes by hovering over the edge of the note and dragging to resize.\n* Change the color: select **Options**  to open the color selector.\n\n## Writing in Markdown[#](#writing-in-markdown \"Permanent link\")\n\nSticky Notes support Markdown formatting. This section describes some common options.\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 | `The text in double asterisks will be **bold** The text in single asterisks will be *italic* Use # to indicate headings: # This is a top-level heading ## This is a sub-heading ### This is a smaller sub-heading You can add links: [Example](https://example.com/) Create lists with asterisks: * Item one * Item two Or created ordered lists with numbers: 1. Item one 2. Item two` |\n\nFor a more detailed guide, refer to [CommonMark's help](https://commonmark.org/help/). n8n uses [markdown-it](https://github.com/markdown-it/markdown-it), which implements the CommonMark specification.\n\n## Make images full width[#](#make-images-full-width \"Permanent link\")\n\nYou can force images to be 100% width of the sticky note by appending `#full-width` to the filename:\n\n| | |\n| --- | --- |\n| | `` |\n\n## Embed a YouTube video[#](#embed-a-youtube-video \"Permanent link\")\n\nTo display a YouTube video in a note, use the `@[youtube]()` directive with the video's ID. For this to work, the video's creator must allow embedding.\n\nFor example:\n\nTo embed your own video, copy the above syntax, replacing `ZCuL2e4zC_4` with your video ID. The YouTube video ID is the string that follows `v=` in the YouTube URL."
},
{
"url": "https://docs.n8n.io/workflows/create/",
"markdown": "# Create and run | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/create.md \"Edit this page\")\n\n## Create a workflow[#](#create-a-workflow \"Permanent link\")\n\nA [workflow](https://docs.n8n.io/glossary/#workflow-n8n) is a collection of nodes connected together to automate a process. You build workflows on the [workflow canvas](https://docs.n8n.io/glossary/#canvas-n8n).\n\n## Create a workflow[#](#create-a-workflow_1 \"Permanent link\")\n\n1. Select the  **button** in the upper-left corner of the side menu. Select workflow.\n2. If your n8n instance supports projects, you'll also need to choose whether to create the workflow inside your **personal space** or a specific **project** you have access to. If you're using the community version, you'll always create workflows inside your personal space.\n3. Get started by adding a trigger node: select **Add first step...**\n\nOr:\n\n1. Select the  **create** button in the upper-right corner from either the **Overview** page or a specific **project**. Select workflow.\n2. If you're doing this from the **Overview** page, you'll create the workflow inside your personal space. If you're doing this from inside a project, you'll create the workflow inside that specific project.\n3. Get started by adding a trigger node: select **Add first step...**\n\nIf it's your first time building a workflow, you may want to use the [quickstart guides](https://docs.n8n.io/try-it-out/) to quickly try out n8n features.\n\n## Run workflows manually[#](#run-workflows-manually \"Permanent link\")\n\nYou may need to run your workflow manually when building and testing, or if your workflow doesn't have a trigger node.\n\nTo run manually, select **Execute Workflow**.\n\n## Run workflows automatically[#](#run-workflows-automatically \"Permanent link\")\n\nAll new workflows are inactive by default.\n\nYou need to activate workflows that start with a trigger node or Webhook node so that they can run automatically. When a workflow is inactive, you must run it manually.\n\nTo activate or deactivate your workflow, open your workflow and toggle **Inactive** / **Active**.\n\nOnce a workflow is active, it runs whenever its trigger conditions are met."
},
{
"url": "https://docs.n8n.io/workflows/executions/manual-partial-and-production-executions/",
"markdown": "# Manual, partial, and production executions\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/manual-partial-and-production-executions.md \"Edit this page\")\n\nThere are some important differences in how n8n executes workflows manually (by clicking the **Execute Workflow** button) and automatically (when the workflow is **Active** and triggered by an event or schedule).\n\n## Manual executions[#](#manual-executions \"Permanent link\")\n\nManual executions allow you to run workflows directly from the [canvas](https://docs.n8n.io/glossary/#canvas-n8n) to test your workflow logic. These executions are \"ad-hoc\": they run only when you manually select the **Execute workflow** button.\n\nManual executions make building workflows easier by allowing you to iteratively test as you go, following the flow logic and seeing data transformations. You can test conditional branching, data formatting changes, and loop behavior by providing different input items and modifying node options.\n\nPinning execution data\n\nWhen performing manual executions, you can use [data pinning](https://docs.n8n.io/data/data-pinning/) to \"pin\" or \"freeze\" the output data of a node. You can optionally [edit the pinned data](https://docs.n8n.io/data/data-editing/) as well.\n\nOn future runs, instead of executing the pinned node, n8n will substitute the pinned data and continue following the flow logic. This allows you to iterate without operating on variable data or repeating queries to external services. Production executions ignore all pinned data.\n\n## Partial executions[#](#partial-executions \"Permanent link\")\n\nClicking the **Execute workflow** button at the bottom of the workflow in the **Editor** tab manually runs the entire workflow. You can also perform partial executions to run specific steps in your workflow. Partial executions are manual executions that only run a subset of your workflow nodes.\n\nTo perform a partial execution, select a node, open its detail view, and select **Execute step**. This executes the specific node and any preceding nodes required to fill in its input data. You can also temporarily disable specific nodes in the workflow chain to avoid interacting with those services while building.\n\nIn particular, partial executions are useful when updating the logic of a specific node since they allow you to re-execute the node with the same input data.\n\n### Troubleshooting partial executions[#](#troubleshooting-partial-executions \"Permanent link\")\n\nSome common issues you might come across when running partial executions include the following:\n\n> The destination node is not connected to any trigger. Partial executions need a trigger.\n\nThis error message appears when you try to perform a partial execution without connecting the workflow to a trigger. Manual executions, including partial executions, attempt to mimic production executions when possible. Part of this includes requiring a trigger node to describe when the workflow logic should execute.\n\nTo work around this, connect a trigger node to the workflow with the node you're trying to execute. Most often, a [manual trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger/) is the simplest option.\n\n> Please execute the whole workflow, rather than just the node. (Existing execution data is too large.)\n\nThis error can appear when performing partial executions on workflows with large numbers of branches. Partial executions involve sending data and workflow logic to the n8n backend in a way that isn't required for full executions. This error occurs when your workflow exceeds the maximum size allowed for these messages.\n\nTo work around this, consider using the [limit node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.limit/) to limit node output while running partial executions. Once the workflow is running as intended, you can disable or delete the limit node before enabling production execution.\n\n## Production executions[#](#production-executions \"Permanent link\")\n\nProduction executions occur when a triggering event or schedule automatically runs a workflow.\n\nTo configure production executions, you must attach a [trigger node](https://docs.n8n.io/glossary/#trigger-node-n8n) (any trigger other than the [manual trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger/) works) and switch workflow's toggle to **Active**. Once activated, the workflow automatically executes whenever the trigger condition occurs.\n\nThe execution flow for production executions doesn't display in the Editor tab of the workflow as with manual executions. Instead, you can see executions in the workflow's **Executions** tab according to your [workflow settings](https://docs.n8n.io/workflows/settings/). From there, you can explore and troubleshoot problems using the [debug in editor feature](https://docs.n8n.io/workflows/executions/debug/)."
},
{
"url": "https://docs.n8n.io/source-control-environments/using/",
"markdown": "# Using source control and environments\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/using/index.md \"Edit this page\")\n\nFeature availability\n\n* Available on Enterprise.\n* You must be an n8n instance owner or instance admin to enable and configure source control.\n* Instance owners and instance admins can push changes to and pull changes from the connected repository.\n* Project admins can push changes to the connected repository. They can't pull changes from the repository.\n\n* [Push and pull](https://docs.n8n.io/source-control-environments/using/push-pull/): Send work to Git, and fetch work from Git to your instance. Understand what gets committed, and how n8n handles merge conflicts.\n* [Copy work between environments](https://docs.n8n.io/source-control-environments/using/copy-work/): How to copy work between different n8n instances."
},
{
"url": "https://docs.n8n.io/source-control-environments/using/push-pull/",
"markdown": "# Push and pull | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/source-control-environments/using/push-pull.md \"Edit this page\")\n\nIf your n8n instance connects to a Git repository, you need to keep your work in sync with Git.\n\nThis document assumes some familiarity with Git concepts and terminology. Refer to [Git and n8n](https://docs.n8n.io/source-control-environments/understand/git/) for an introduction to how n8n works with Git.\n\nRecommendation: don't push and pull to the same n8n instance\n\nYou can push work from an instance to a branch, and pull to the same instance. n8n doesn't recommend this. To reduce the risk of merge conflicts and overwriting work, try to create a process where work goes in one direction: either to Git, or from Git, but not both.\n\n## Fetch other people's work[#](#fetch-other-peoples-work \"Permanent link\")\n\nn8n roles control which users can pull (fetch) changes\n\nYou must be an instance owner or instance admin to pull changes from git.\n\nTo pull work from Git, select **Pull**  in the main menu.\n\nView screenshot\n\n\n\nPull and push buttons when menu is closed\n\n\n\nPull and push buttons when menu is open\n\nn8n may display a warning about overriding local changes. Select **Pull and override** to override your local work with the content in Git.\n\nWhen the changes include new variable or credential stubs, n8n notifies you that you need to populate the values for the items before using them.\n\nHow deleted resources are handled\n\nWhen workflows, credentials, variables, and tags are deleted from the repository, your local versions of these resources aren't deleted automatically. Instead, when you pull repository changes, n8n notifies you about any outdated resources and asks if you'd like to delete them.\n\n### Workflow and credential owner may change on pull[#](#workflow-and-credential-owner-may-change-on-pull \"Permanent link\")\n\nWhen you pull from Git to an n8n instance, n8n tries to assign workflows and credentials to a matching user or project.\n\nIf the original owner is a user:\n\nIf the same owner is available on both instances (matching email), the owner remains the same. If the original owner isn't on the new instance, n8n sets the user performing the pull as the workflow owner.\n\nIf the original owner is a [project](https://docs.n8n.io/user-management/rbac/):\n\nn8n tries to match the original project name to a project name on the new instance. If no matching project exists, n8n creates a new project with the name, assigns the current user as project owner, and imports the workflows and credentials to the project.\n\n### Pulling may cause brief service interruption[#](#pulling-may-cause-brief-service-interruption \"Permanent link\")\n\nIf you pull changes to an active workflow, n8n sets the workflow to inactive while pulling, then reactivates it. This may result in a few seconds of downtime for the workflow.\n\n## Send your work to Git[#](#send-your-work-to-git \"Permanent link\")\n\nn8n roles control which users can push changes\n\nYou must be an instance owner, instance admin, or project admin to push changes to git.\n\nTo push work to Git:\n\n1. Select **Push**  in the main menu.\n \n View screenshot\n \n \n \n Pull and push buttons when menu is closed\n \n \n \n Pull and push buttons when menu is open\n \n2. In the **Commit and push changes** modal, select which workflows you want to push. You can filter by status (new, modified, deleted) and search for workflows. n8n automatically pushes tags, and variable and credential stubs.\n \n3. Enter a commit message. This should be a one sentence description of the changes you're making.\n4. Select **Commit and Push**. n8n sends the work to Git, and displays a success message on completion.\n\n## What gets committed[#](#what-gets-committed \"Permanent link\")\n\nn8n commits the following to Git:\n\n* Workflows, including their tags and the email address of the workflow owner. You can choose which workflows to push.\n* Credential stubs (ID, name, type)\n* Variable stubs (ID and name)\n* Projects\n* Folders\n\n## Merge behaviors and conflicts[#](#merge-behaviors-and-conflicts \"Permanent link\")\n\nn8n's implementation of source control is opinionated. It resolves merge conflicts for credentials and variables automatically. n8n can't detect conflicts on workflows.\n\n### Workflows[#](#workflows \"Permanent link\")\n\nYou have to explicitly tell n8n what to do about workflows when pushing or pulling. The Git repository acts as the source of truth.\n\nWhen pulling, you might get warned that your local copy of a workflow differs from Git, and if you accept, your local copy would be overridden. Be careful not to lose relevant changes when pulling.\n\nWhen you push, your local workflow will override what's in Git, so make sure that you have the most up to date version or you risk overriding recent changes.\n\nTo prevent the issue described above, you should immediately push your changes to a workflow once you finish working on it. Then it's safe to pull.\n\nTo avoid losing data:\n\n* Design your source control setup so that workflows flow in one direction. For example, make edits on a development instance, push to Git, then pull to production. Don't make edits on the production instance and push them.\n* Don't push all workflows. Select the ones you need.\n* Be cautious about manually editing files in the Git repository.\n\n### Credentials, variables and workflow tags[#](#credentials-variables-and-workflow-tags \"Permanent link\")\n\nCredentials and variables can't have merge issues, as n8n chooses the version to keep.\n\nOn pull:\n\n* If the tag, variable or credential doesn't exist, n8n creates it.\n* If the tag, variable or credential already exists, n8n doesn't update it, unless:\n * You set the value of a variable using the API or externally. The new value overwrites any existing value.\n * The credential name has changed. n8n uses the version in Git.\n * The name of a tag has changed. n8n updates the tag name. Be careful when renaming tags as tag names are unique and this could cause database issues when it comes to uniqueness during the pull process.\n\nOn push:\n\n* n8n overwrites the entire variables and tags files.\n* If a credential already exists, n8n overwrites it with the changes, but doesn't apply these changes to existing credentials on pull.\n\nManage credentials with an external secrets vault\n\nIf you need different credentials on different n8n environments, use [external secrets](https://docs.n8n.io/external-secrets/)."
},
{
"url": "https://docs.n8n.io/workflows/executions/dirty-nodes/",
"markdown": "# Dirty nodes | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/dirty-nodes.md \"Edit this page\")\n\nA **dirty node** is a node that executed successfully in the past, but whose output n8n now considers stale or unreliable. They're labeled like this to indicate that if the node executes again, the output may be different. It may also be the point where a [partial execution](https://docs.n8n.io/workflows/executions/manual-partial-and-production-executions/#partial-executions) starts from.\n\n## How to recognize dirty node data[#](#how-to-recognize-dirty-node-data \"Permanent link\")\n\nIn the canvas of the workflow editor, you can identify dirty notes by their different-colored border and a yellow triangle in place of the previous green tick symbol. For example:\n\n\n\nIn the node editor view, the output panel also displays a yellow triangle on the output panel. If you hover over the triangle, a tooltip appears with more information about why n8n considers the data stale:\n\n\n\n## Why n8n marks nodes dirty[#](#why-n8n-marks-nodes-dirty \"Permanent link\")\n\nThere are several reasons why n8n might flag execution data as stale. For example:\n\n* Inserting or deleting a node: labels the first node that follows the inserted node dirty.\n* Modifying node parameters: labels the modified node dirty.\n* Adding a connector: labels the destination node of the new connector dirty.\n* Deactivating a node: labels the first node that follows the deactivated node dirty.\n\nOther reasons n8n marks nodes dirty\n\n* Unpinning a node: labels the unpinned node dirty.\n* Modifying pinned data: labels the node that comes after the pinned data dirty.\n* If any of the above actions occur inside a loop, also labels the first node of the loop dirty.\n\nFor sub-nodes, also labels any executed parent nodes (up to and including the root) when:\n\n* Editing an executed sub-node\n* Adding a new sub-node\n* Disconnecting or deleting a sub-node\n* Deactivating a sub-node\n* Activating a sub-node\n\n* When deleting a connected node in a workflow:\n \n \n \n* The next node in the sequence becomes dirty:\n \n \n \n\nWhen using loops (with the [Loop over Items](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/) node), when any node within the loop is dirty, the initial node of the loop is also considered dirty:\n\n\n\n## Resolving dirty nodes[#](#resolving-dirty-nodes \"Permanent link\")\n\nExecuting a node again clears its dirty status. You can do this manually by triggering the whole workflow, or by running a [partial execution](https://docs.n8n.io/workflows/executions/manual-partial-and-production-executions/#partial-executions) with **Execute step** on the individual node or any node which follows it."
},
{
"url": "https://docs.n8n.io/workflows/executions/single-workflow-executions/",
"markdown": "# Workflow-level executions | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/single-workflow-executions.md \"Edit this page\")\n\nThe **Executions** list in a workflow shows all executions for that workflow.\n\nDeleted workflows\n\nWhen you delete a workflow, n8n deletes its execution history as well. This means you can't view executions for deleted workflows.\n\nExecution history and workflow history\n\nDon't confuse the execution list with [Workflow history](https://docs.n8n.io/workflows/history/).\n\nExecutions are workflow runs. With the executions list, you can see previous runs of the current version of the workflow. You can copy previous executions into the editor to [Debug and re-run past executions](https://docs.n8n.io/workflows/executions/debug/) in your current workflow.\n\nWorkflow history is previous versions of the workflow: for example, a version with a different node, or different parameters set.\n\n## View executions for a single workflow[#](#view-executions-for-a-single-workflow \"Permanent link\")\n\nIn the workflow, select the **Executions** tab in the top menu. You can preview all executions of that workflow.\n\n## Filter executions[#](#filter-executions \"Permanent link\")\n\nYou can filter the executions list.\n\n1. In your workflow, select **Executions**.\n2. Select **Filters**.\n3. Enter your filters. You can filter by:\n * **Status**: choose from **Failed**, **Running**, **Success**, or **Waiting**.\n * **Execution start**: see executions that started in the given time.\n * **Saved custom data**: this is data you create within the workflow using the Code node. Enter the key and value to filter. Refer to [Custom executions data](https://docs.n8n.io/workflows/executions/custom-executions-data/) for information on adding custom data.\n \n Feature availability\n \n Custom executions data is available on:\n \n * Cloud: Pro, Enterprise\n * Self-Hosted: Enterprise, registered Community\n \n\n## Retry failed workflows[#](#retry-failed-workflows \"Permanent link\")\n\nIf your workflow execution fails, you can retry the execution. To retry a failed workflow:\n\n1. Open the **Executions** list.\n2. For the workflow execution you want to retry, select **Refresh** .\n3. Select either of the following options to retry the execution:\n * **Retry with currently saved workflow**: Once you make changes to your workflow, you can select this option to execute the workflow with the previous execution data.\n * **Retry with original workflow**: If you want to retry the execution without making changes to your workflow, you can select this option to retry the execution with the previous execution data."
},
{
"url": "https://docs.n8n.io/workflows/executions/all-executions/",
"markdown": "# All executions | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/all-executions.md \"Edit this page\")\n\nTo view **all executions** from an n8n instance, navigate to the **Overview** page and then click into the Executions tab. This will show you all executions from the workflows you have access to.\n\nIf your n8n instance supports **projects**, you'll also be able to view the executions tab within projects you have access to. This will show you executions only from the workflows within the specified project.\n\nDeleted workflows\n\nWhen you delete a workflow, n8n deletes its execution history as well. This means you can't view executions for deleted workflows.\n\n## Filter executions[#](#filter-executions \"Permanent link\")\n\nYou can filter the executions list:\n\n1. Select the **Executions** tab either from within the **Overview** page or a specific **project** to open the list.\n2. Select **Filters**.\n3. Enter your filters. You can filter by:\n * **Workflows**: choose all workflows, or a specific workflow name.\n * **Status**: choose from **Failed**, **Running**, **Success**, or **Waiting**.\n * **Execution start**: see executions that started in the given time.\n * **Saved custom data**: this is data you create within the workflow using the Code node. Enter the key and value to filter. Refer to [Custom executions data](https://docs.n8n.io/workflows/executions/custom-executions-data/) for information on adding custom data.\n\nFeature availability\n\nCustom executions data is available on:\n\n* Cloud: Pro, Enterprise\n* Self-Hosted: Enterprise, registered Community\n\n## Retry failed workflows[#](#retry-failed-workflows \"Permanent link\")\n\nIf your workflow execution fails, you can retry the execution. To retry a failed workflow:\n\n1. Select the **Executions** tab from within either the **Overview** page or a specific **project** to open the list.\n2. On the execution you want to retry, select **Retry execution** .\n3. Select either of the following options to retry the execution:\n * **Retry with currently saved workflow**: Once you make changes to your workflow, you can select this option to execute the workflow with the previous execution data.\n * **Retry with original workflow**: If you want to retry the execution without making changes to your workflow, you can select this option to retry the execution with the previous execution data.\n\n## Load data from previous executions into your current workflow[#](#load-data-from-previous-executions-into-your-current-workflow \"Permanent link\")\n\nYou can load data from a previous workflow back into the canvas. Refer to [Debug executions](https://docs.n8n.io/workflows/executions/debug/) for more information."
},
{
"url": "https://docs.n8n.io/workflows/executions/",
"markdown": "# Executions | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/index.md \"Edit this page\")\n\nAn execution is a single run of a workflow.\n\n## Execution modes[#](#execution-modes \"Permanent link\")\n\nThere are two execution modes:\n\n* Manual: run workflows manually when testing. Select **Execute Workflow** to start a manual execution. You can do manual executions of active workflows, but n8n recommends keeping your workflow set to **Inactive** while developing and testing.\n* Production: a production workflow is one that runs automatically. To enable this, set the workflow to **Active**.\n\n## Execution lists[#](#execution-lists \"Permanent link\")\n\nn8n provides two execution lists:\n\n* [Workflow-level executions](https://docs.n8n.io/workflows/executions/single-workflow-executions/): this execution list shows the executions for a single workflow.\n* [All executions](https://docs.n8n.io/workflows/executions/all-executions/): this list shows all executions for all your workflows.\n\nn8n supports [adding custom data to executions](https://docs.n8n.io/workflows/executions/custom-executions-data/)."
},
{
"url": "https://docs.n8n.io/workflows/executions/custom-executions-data/",
"markdown": "# Custom executions data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/workflows/executions/custom-executions-data.md \"Edit this page\")\n\nYou can set custom data on your workflow using the Code node or the [Execution Data node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executiondata/). n8n records this with each execution. You can then use this data when filtering the executions list, or fetch it in your workflows using the Code node.\n\nFeature availability\n\nCustom executions data is available on:\n\n* Cloud: Pro, Enterprise\n* Self-Hosted: Enterprise, registered Community\n\n## Set and access custom data using the Code node[#](#set-and-access-custom-data-using-the-code-node \"Permanent link\")\n\nThis section describes how to set and access data using the Code node. Refer to [Execution Data node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executiondata/) for information on using the Execution Data node to set data. You can't retrieve custom data using the Execution Data node.\n\n### Set custom executions data[#](#set-custom-executions-data \"Permanent link\")\n\nSet a single piece of extra data:\n\nJavaScriptPython\n\n| | |\n| --- | --- |\n| | `$execution.customData.set(\"key\", \"value\");` |\n\n| | |\n| --- | --- |\n| | `_execution.customData.set(\"key\", \"value\");` |\n\nSet all extra data. This overwrites the whole custom data object for this execution:\n\nJavaScriptPython\n\n| | |\n| --- | --- |\n| | `$execution.customData.setAll({\"key1\": \"value1\", \"key2\": \"value2\"})` |\n\n| | |\n| --- | --- |\n| | `_execution.customData.setAll({\"key1\": \"value1\", \"key2\": \"value2\"})` |\n\nThere are limitations:\n\n* They must be strings\n* `key` has a maximum length of 50 characters\n* `value` has a maximum length of 255 characters\n* n8n supports a maximum of 10 items of custom data\n\n### Access the custom data object during execution[#](#access-the-custom-data-object-during-execution \"Permanent link\")\n\nYou can retrieve the custom data object, or a specific value in it, during an execution:\n\nJavaScriptPython\n\n| | |\n| --- | --- |\n| | `// Access the current state of the object during the execution const customData = $execution.customData.getAll(); // Access a specific value set during this execution const customData = $execution.customData.get(\"key\");` |\n\n| | |\n| --- | --- |\n| | `# Access the current state of the object during the execution customData = _execution.customData.getAll(); # Access a specific value set during this execution customData = _execution.customData.get(\"key\");` |"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.compression/",
"markdown": "# Compression | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.compression.md \"Edit this page\")\n\nUse the Compression node to compress and decompress files. Supports Zip and Gzip formats.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nThis node can be used as an AI tool\n\nThis node can be used to enhance the capabilities of an AI agent. When used in this way, many parameters can be set automatically, or with information directed by AI - find out more in the [AI tool parameters documentation](https://docs.n8n.io/advanced-ai/examples/using-the-fromai-function/).\n\nThe node parameters depend on which **Operation** you select. Choose to:\n\n* **Compress**: Create a compressed file from your input data.\n* **Decompress**: Decompress an existing compressed file.\n\nRefer to the sections below for parameters specific to each **Operation**.\n\n### Compress[#](#compress \"Permanent link\")\n\n* **Input Binary Field(s)**: Enter the name of the fields in the input data that contain the binary files you want to compress. To compress more than one file, use a comma-separated list.\n* **Output Format**: Choose whether to format the compressed output as **Zip** or **Gzip**.\n* **File Name**: Enter the name of the zip file the node creates.\n* **Put Output File in Field**: Enter the name of the field in the output data to contain the file.\n\n### Decompress[#](#decompress \"Permanent link\")\n\n* **Put Output File in Field**: Enter the name of the fields in the input data that contain the binary files you want to decompress. To decompress more than one file, use a comma-separated list.\n* **Output Prefix**: Enter a prefix to add to the output file name.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/",
"markdown": "# Chat Trigger node documentation | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md \"Edit this page\")\n\nUse the Chat Trigger node when building AI workflows for chatbots and other chat interfaces. You can configure how users access the chat, using one of n8n's provided interfaces, or your own. You can add authentication.\n\nYou must connect either an agent or chain [root node](https://docs.n8n.io/integrations/builtin/cluster-nodes/root-nodes/).\n\nWorkflow execution usage\n\nEvery message to the Chat Trigger executes your workflow. This means that one conversation where a user sends 10 messages uses 10 executions from your execution allowance. Check your payment plan for details of your allowance.\n\nManual Chat trigger\n\nThis node replaces the Manual Chat Trigger node from version 1.24.0.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\n### Make Chat Publicly Available[#](#make-chat-publicly-available \"Permanent link\")\n\nSet whether the chat should be publicly available (turned on) or only available through the manual chat interface (turned off).\n\nLeave this turned off while you're building the workflow. Turn it on when you're ready to activate the workflow and allow users to access the chat.\n\n### Mode[#](#mode \"Permanent link\")\n\nChoose how users access the chat. Select from:\n\n* **Hosted Chat**: Use n8n's hosted chat interface. Recommended for most users because you can configure the interface using the [node options](#node-options) and don't have to do any other setup.\n* **Embedded Chat**: This option requires you to create your own chat interface. You can use n8n's [chat widget](https://www.npmjs.com/package/@n8n/chat) or build your own. Your chat interface must call the webhook URL shown in **Chat URL** in the node.\n\n### Authentication[#](#authentication \"Permanent link\")\n\nChoose whether and how to restrict access to the chat. Select from:\n\n* **None**: The chat doesn't use authentication. Anyone can use the chat.\n* **Basic Auth**: The chat uses basic authentication.\n * Select or create a **Credential for Basic Auth** with a username and password. All users must use the same username and password.\n* **n8n User Auth**: Only users logged in to an n8n account can use the chat.\n\n### Initial Message(s)[#](#initial-messages \"Permanent link\")\n\nThis parameter's only available if you're using **Hosted Chat**. Use it to configure the message the n8n chat interface displays when the user arrives on the page.\n\n## Node options[#](#node-options \"Permanent link\")\n\nAvailable options depend on the chat mode.\n\n### Hosted chat options[#](#hosted-chat-options \"Permanent link\")\n\n#### Allowed Origin (CORS)[#](#allowed-origin-cors \"Permanent link\")\n\nSet the origins that can access the chat URL. Enter a comma-separated list of URLs allowed for cross-origin non-preflight requests.\n\nUse `*` (default) to allow all origins.\n\n#### Input Placeholder, Title, and Subtitle[#](#input-placeholder-title-and-subtitle \"Permanent link\")\n\nEnter the text for these elements in the chat interface.\n\nView screenshot\n\n\n\n#### Load Previous Session[#](#load-previous-session \"Permanent link\")\n\nSelect whether to load chat messages from a previous chat session.\n\nIf you select any option other than **Off**, you must connect the Chat trigger and the Agent you're using to a memory sub-node. The memory connector on the Chat trigger appears when you set **Load Previous Session** to **From Memory**. n8n recommends connecting both the Chat trigger and Agent to the same memory sub-node, as this ensures a single source of truth for both nodes.\n\nView screenshot\n\n\n\n#### Response Mode[#](#response-mode \"Permanent link\")\n\nUse this option when building a workflow with steps after the agent or chain that's handling the chat. Choose from:\n\n* **When Last Node Finishes**: The Chat Trigger node returns the response code and the data output from the last node executed in the workflow.\n* **Using Response Nodes**: The Chat Trigger node responds as defined in a [Respond to Chat](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.respondtochat/) node or [Respond to Webhook](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.respondtowebhook/) node. In this response mode, the Chat Trigger will solely show messages as defined in these nodes and not output the data from the last node executed in the workflow.\n\nUsing Response Nodes\n\nThis mode replaces the 'Using Respond to Webhook Node' mode from version 1.2 of the Chat Trigger node.\n\n#### Require Button Click to Start Chat[#](#require-button-click-to-start-chat \"Permanent link\")\n\nSet whether to display a **New Conversation** button on the chat interface (turned on) or not (turned off).\n\nView screenshot\n\n\n\n### Embedded chat options[#](#embedded-chat-options \"Permanent link\")\n\n#### Allowed Origin (CORS)[#](#allowed-origin-cors_1 \"Permanent link\")\n\nSet the origins that can access the chat URL. Enter a comma-separated list of URLs allowed for cross-origin non-preflight requests.\n\nUse `*` (default) to allow all origins.\n\n#### Load Previous Session[#](#load-previous-session_1 \"Permanent link\")\n\nSelect whether to load chat messages from a previous chat session.\n\nIf you select any option other than **Off**, you must connect the Chat trigger and the Agent you're using to a memory sub-node. The memory connector on the Chat trigger appears when you set **Load Previous Session** to **From Memory**. n8n recommends connecting both the Chat trigger and Agent to the same memory sub-node, as this ensures a single source of truth for both nodes.\n\nView screenshot\n\n\n\n#### Response Mode[#](#response-mode_1 \"Permanent link\")\n\nUse this option when building a workflow with steps after the agent or chain that's handling the chat. Choose from:\n\n* **When Last Node Finishes**: The Chat Trigger node returns the response code and the data output from the last node executed in the workflow.\n* **Using Response Nodes**: The Chat Trigger node responds as defined in a [Respond to Chat](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.respondtochat/) node or [Respond to Webhook](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.respondtowebhook/) node. In this response mode, the Chat Trigger will solely show messages as defined in these nodes and not output the data from the last node executed in the workflow.\n\nUsing Response Nodes\n\nThis mode replaces the 'Using Respond to Webhook Node' mode from version 1.2 of the Chat Trigger node.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n[Browse Chat Trigger integration templates](https://n8n.io/integrations/chat-trigger/), or [search all templates](https://n8n.io/workflows/)\n\nView n8n's [Advanced AI](https://docs.n8n.io/advanced-ai/) documentation.\n\n## Set the chat response manually[#](#set-the-chat-response-manually \"Permanent link\")\n\nYou need to manually set the chat response when you don't want to directly send the output of an Agent or Chain node to the user. Instead, you want to take the output of an Agent or Chain node and modify it or do something else with it before sending it back to the user.\n\nIn a basic workflow, the Agent and Chain nodes output a parameter named either `output` or `text`, and the Chat trigger sends the value of this parameter to the user as the chat response.\n\nIf you need to manually create the response sent to the user, you must create a parameter named either `text` or `output`. If you use a different parameter name, the Chat trigger sends the entire object as its response, not just the value.\n\nRespond to Chat node\n\nWhen you are using a [Respond to Chat](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.respondtochat/) node to manually create the response sent to the user, you must set the Chat Trigger response mode to 'Using Response Nodes'.\n\n## Common issues[#](#common-issues \"Permanent link\")\n\nFor common questions or issues and suggested solutions, refer to [Common Issues](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues/)."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.converttofile/",
"markdown": "# Convert to File | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md \"Edit this page\")\n\nUse the Convert to File node to take input data and output it as a file. This converts the input JSON data into a binary format.\n\nExtract From File\n\nTo extract data from a file and convert it to JSON, use the [Extract from File](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/) node.\n\n## Operations[#](#operations \"Permanent link\")\n\n* [**Convert to CSV**](#convert-to-csv)\n* [**Convert to HTML**](#convert-to-html)\n* [**Convert to ICS**](#convert-to-ics)\n* [**Convert to JSON**](#convert-to-json)\n* [**Convert to ODS**](#convert-to-ods)\n* [**Convert to RTF**](#convert-to-rtf)\n* [**Convert to Text File**](#convert-to-text-file)\n* [**Convert to XLS**](#convert-to-xls)\n* [**Convert to XLSX**](#convert-to-xlsx)\n* [**Move Base64 String to File**](#move-base64-string-to-file)\n\nNode parameters and options depend on the operation you select.\n\n### Convert to CSV[#](#convert-to-csv \"Permanent link\")\n\nConfigure the node for this operation with the **Put Output File in Field** parameter. Enter the name of the field in the output data to contain the file.\n\n#### Convert to CSV options[#](#convert-to-csv-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* If the first row of the file contains header names, turn on the **Header Row** option.\n\n### Convert to HTML[#](#convert-to-html \"Permanent link\")\n\nConfigure the node for this operation with the **Put Output File in Field** parameter. Enter the name of the field in the output data to contain the file.\n\n#### Convert to HTML options[#](#convert-to-html-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* If the first row of the file contains header names, turn on the **Header Row** option.\n\n### Convert to ICS[#](#convert-to-ics \"Permanent link\")\n\n* **Put Output File in Field**. Enter the name of the field in the output data to contain the file.\n* **Event Title**: Enter the title for the event.\n* **Start**: Enter the date and time the event will start. All-day events ignore the time.\n* **End**: Enter the date and time the event will end. All-day events ignore the time. If unset, the node uses the start date.\n* **All Day**: Select whether the event is an all day event (turned on) or not (turned off).\n\n#### Convert to ICS options[#](#convert-to-ics-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **Attendees**: Use this option to add attendees to the event. For each attendee, add:\n * **Name**\n * **Email**\n * **RSVP**: Select whether the attendee needs to confirm attendance (turned on) or doesn't (turned off).\n* **Busy Status**: Use this option to set the busy status for Microsoft applications like Outlook. Choose from:\n * **Busy**\n * **Tentative**\n* **Calendar Name**: For Apple and Microsoft calendars, enter the [calendar name](https://learn.microsoft.com/en-us/openspecs/exchange_server_protocols/ms-oxcical/1da58449-b97e-46bd-b018-a1ce576f3e6d) for the event.\n* **Description**: Enter an event description.\n* **Geolocation**: Enter the **Latitude** and **Longitude** for the event's location.\n* **Location**: Enter the event's intended venue/location.\n* **Recurrence Rule**: Enter a rule to define the repeat pattern of the event (RRULE). Generate rules using the [iCalendar.org RRULE Tool](https://icalendar.org/rrule-tool.html).\n* **Organizer**: Enter the organizer's **Name** and **Email**.\n* **Sequence**: If you're sending an update for an event with the same universally unique ID (UID), enter the revision sequence number.\n* **Status**: Set the status of the event. Choose from:\n * **Confirmed**\n * **Cancelled**\n * **Tentative**\n* **UID**: Enter a universally unique ID (UID) for the event. The UID should be globally unique. The node automatically generates a UID if you don't enter one.\n* **URL**: Enter a URL associated with the event.\n* **Use Workflow Timezone**: Whether to use UTC time zone (turned off) or the workflow's timezone (turned on). Set the workflow's timezone in the [Workflow Settings](https://docs.n8n.io/workflows/settings/).\n\n### Convert to JSON[#](#convert-to-json \"Permanent link\")\n\nChoose the best output **Mode** for your needs from these options:\n\n* **All Items to One File**: Send all input items to a single file.\n* **Each Item to Separate File**: Create a file for every input item.\n\n#### Convert to JSON options[#](#convert-to-json-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **Format**: Choose whether to format the JSON for easier reading (turned on) or not (turned off).\n* **Encoding**: Choose the character set to use to encode the data. The default is **utf8**.\n\n### Convert to ODS[#](#convert-to-ods \"Permanent link\")\n\nConfigure the node for this operation with the **Put Output File in Field** parameter. Enter the name of the field in the output data to contain the file.\n\n#### Convert to ODS options[#](#convert-to-ods-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **Compression**: Choose whether to compress and reduce the file's output size.\n* **Header Row**: Turn on if the first row of the file contains header names.\n* **Sheet Name**: Enter the Sheet Name to create in the spreadsheet.\n\n### Convert to RTF[#](#convert-to-rtf \"Permanent link\")\n\nConfigure the node for this operation with the **Put Output File in Field** parameter. Enter the name of the field in the output data to contain the file.\n\n#### Convert to RFT options[#](#convert-to-rft-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* If the first row of the file contains header names, turn on the **Header Row** option.\n\n### Convert to Text File[#](#convert-to-text-file \"Permanent link\")\n\nEnter the name of the **Text Input Field** that contains a string to convert to a file. Use dot-notation for deep fields, for example `level1.level2.currentKey`.\n\n#### Convert to Text File options[#](#convert-to-text-file-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **Encoding**: Choose the character set to use to encode the data. The default is **utf8**.\n\n### Convert to XLS[#](#convert-to-xls \"Permanent link\")\n\nConfigure the node for this operation with the **Put Output File in Field** parameter. Enter the name of the field in the output data to contain the file.\n\n#### Convert to XLS options[#](#convert-to-xls-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **Header Row**: Turn on if the first row of the file contains header names.\n* **Sheet Name**: Enter the Sheet Name to create in the spreadsheet.\n\n### Convert to XLSX[#](#convert-to-xlsx \"Permanent link\")\n\nConfigure the node for this operation with the **Put Output File in Field** parameter. Enter the name of the field in the output data to contain the file.\n\n#### Convert to XLSX options[#](#convert-to-xlsx-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **Compression**: Choose whether to compress and reduce the file's output size.\n* **Header Row**: Turn on if the first row of the file contains header names.\n* **Sheet Name**: Enter the Sheet Name to create in the spreadsheet.\n\n### Move Base64 String to File[#](#move-base64-string-to-file \"Permanent link\")\n\nEnter the name of the **Base64 Input Field** that contains the Base64 string to convert to a file. Use dot-notation for deep fields, for example `level1.level2.currentKey`.\n\n#### Move Base64 String to File options[#](#move-base64-string-to-file-options \"Permanent link\")\n\nYou can also configure this operation with these **Options**:\n\n* **File Name**: Enter the file name for the generated output file.\n* **MIME Type**: Enter the MIME type of the output file. Refer to [Common MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types) for a list of common MIME types and the file extensions they relate to.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.crypto/",
"markdown": "# Crypto | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md \"Edit this page\")\n\nUse the Crypto node to encrypt data in workflows.\n\n## Actions[#](#actions \"Permanent link\")\n\n* [**Generate** a random string](#generate-parameters)\n* [**Hash** a text or file](#hash-parameters) in a specified format\n* [**Hmac** a text or file](#hmac-parameters) in a specified format\n* [**Sign** a string](#sign-parameters) using a private key\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nThis node can be used as an AI tool\n\nThis node can be used to enhance the capabilities of an AI agent. When used in this way, many parameters can be set automatically, or with information directed by AI - find out more in the [AI tool parameters documentation](https://docs.n8n.io/advanced-ai/examples/using-the-fromai-function/).\n\nNode parameters depend on the action you select.\n\n### Generate parameters[#](#generate-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the property to write the random string to.\n* **Type**: Select the encoding type to use to generate the string. Choose from:\n * **ASCII**\n * **BASE64**\n * **HEX**\n * **UUID**\n\n### Hash parameters[#](#hash-parameters \"Permanent link\")\n\n* **Type**: Select the hash type to use. Choose from:\n * **MD5**\n * **SHA256**\n * **SHA3-256**\n * **SHA3-384**\n * **SHA3-512**\n * **SHA385**\n * **SHA512**\n* **Binary File**: Turn this parameter on if the data you want to hash is from a binary file.\n * **Value**: If you turn off **Binary File**, enter the value you want to hash.\n * **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to hash.\n* **Property Name**: Enter the name of the property you want to write the hash to.\n* **Encoding**: Select the encoding type to use. Choose from:\n * **BASE64**\n * **HEX**\n\n### Hmac parameters[#](#hmac-parameters \"Permanent link\")\n\n* **Binary File**: Turn this parameter on if the data you want to encrypt is from a binary file.\n * **Value**: If you turn off **Binary File**, enter the value you want to encrypt.\n * **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to encrypt.\n* **Type**: Select the encryption type to use. Choose from:\n * **MD5**\n * **SHA256**\n * **SHA3-256**\n * **SHA3-384**\n * **SHA3-512**\n * **SHA385**\n * **SHA512**\n* **Property Name**: Enter the name of the property you want to write the hash to.\n* **Secret**: Enter the secret or secret key used for decoding.\n* **Encoding**: Select the encoding type to use. Choose from:\n * **BASE64**\n * **HEX**\n\n### Sign parameters[#](#sign-parameters \"Permanent link\")\n\n* **Value**: Enter the value you want to sign.\n* **Property Name**: Enter the name of the property you want to write the signed value to.\n* **Algorithm Name or ID**: Choose an algorithm name from the list or specify an ID using an [expression](https://docs.n8n.io/code/expressions/).\n* **Encoding**: Select the encoding type to use. Choose from:\n * **BASE64**\n * **HEX**\n* **Private Key**: Enter a private key to use when signing the string.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues/",
"markdown": "# Chat Trigger node common issues\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/common-issues.md \"Edit this page\")\n\nHere are some common errors and issues with the [Chat Trigger node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/) and steps to resolve or troubleshoot them.\n\n## Pass data from a website to an embedded Chat Trigger node[#](#pass-data-from-a-website-to-an-embedded-chat-trigger-node \"Permanent link\")\n\nWhen [embedding](https://www.npmjs.com/package/@n8n/chat) the Chat Trigger node in a website, you might want to pass extra information to the Chat Trigger. For example, passing a user ID stored in a site cookie.\n\nTo do this, use the `metadata` field in the JSON object you pass to the `createChat` function in your embedded chat window:\n\n| | |\n| --- | --- |\n| | `createChat({ \twebhookUrl: 'YOUR_PRODUCTION_WEBHOOK_URL', \tmetadata: { \t\t'YOUR_KEY': 'YOUR_DATA' \t}; });` |\n\nThe `metadata` field can contain arbitrary data that will appear in the Chat Trigger output alongside other output data. From there, you can query and process the data from downstream nodes as usual using n8n's [data processing features](https://docs.n8n.io/data/).\n\n## Chat Trigger node doesn't fetch previous messages[#](#chat-trigger-node-doesnt-fetch-previous-messages \"Permanent link\")\n\nWhen you configure a Chat Trigger node, you might experience problems fetching previous messages if you aren't careful about how you configure session loading. This often manifests as a `workflow could not be started!` error.\n\nIn Chat Triggers, the **Load Previous Session** option retrieves previous chat messages for a session using the `sessionID`. When you set the **Load Previous Session** option to **From memory**, it's almost always best to [connect the same memory node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/#load-previous-session) to both the Chat Trigger and the Agent in your workflow:\n\n1. In your **Chat Trigger** node, set the **Load Previous Session** option to **From Memory**. This is only visible if you've made the chat publicly available.\n2. Attach a **Simple Memory** node to the **Memory** connector.\n3. Attach the same **Simple Memory** node to **Memory** connector of your **Agent**.\n4. In the **Simple Memory** node, set **Session ID** to **Connected Chat Trigger Node**.\n\nOne instance where you may want to attach separate memory nodes to your Chat Trigger and the Agent is if you want to set the **Session ID** in your memory node to **Define below**.\n\nIf you're retrieving the session ID from an expression, the same expression must work for each of the nodes attached to it. If the expression isn't compatible with each of the nodes that need memory, you might need to use separate memory nodes so you can customize the expression for the session ID on a per-node basis."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.datetime/",
"markdown": "# Date & Time | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md \"Edit this page\")\n\nThe Date & Time node manipulates date and time data and convert it to different formats.\n\nTimezone settings\n\nThe node relies on the timezone setting. n8n uses either:\n\n1. The workflow timezone, if set. Refer to [Workflow settings](https://docs.n8n.io/workflows/settings/) for more information.\n2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](https://docs.n8n.io/hosting/configuration/environment-variables/timezone-localization/). Cloud admins can change the instance timezone in the [Admin dashboard](https://docs.n8n.io/manage-cloud/set-cloud-timezone/).\n\nDate and time in other nodes\n\nYou can work with data and time in the Code node, and in expressions in any node. n8n supports Luxon to help work with date and time in JavaScript. Refer to [Date and time with Luxon](https://docs.n8n.io/code/cookbook/luxon/) for more information.\n\n## Operations[#](#operations \"Permanent link\")\n\n* **Add to a Date**: Add a specified amount of time to a date.\n* **Extract Part of a Date**: Extract part of a date, such as the year, month, or day.\n* **Format a Date**: Transform a date's format to a new format using preset options or a custom expression.\n* **Get Current Date**: Get the current date and choose whether to include the current time or not. Useful for triggering other flows and conditional logic.\n* **Get Time Between Dates**: Calculate the amount of time in specific units between two dates.\n* **Round a Date**: Round a date up or down to the nearest unit of your choice, such as month, day, or hour.\n* **Subtract From a Date**: Subtract a specified amount of time from a date.\n\nRefer to the sections below for parameters and options specific to each operation.\n\n## Add to a Date[#](#add-to-a-date \"Permanent link\")\n\nConfigure the node for this operation using these parameters:\n\n* **Date to Add To**: Enter the date you want to change.\n* **Time Unit to Add**: Select the time unit for the **Duration** parameter.\n* **Duration**: Enter the number of time units to add to the date.\n* **Output Field Name**: Enter the name of the field to output the new date to.\n\n### Add to a Date options[#](#add-to-a-date-options \"Permanent link\")\n\nThis operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.\n\nConfigure the node for this operation using these parameters:\n\n* **Date**: Enter the date you want to round or extract part of.\n* **Part**: Select the part of the date you want to extract. Choose from:\n * **Year**\n * **Month**\n * **Week**\n * **Day**\n * **Hour**\n * **Minute**\n * **Second**\n* **Output Field Name**: Enter the name of the field to output the extracted date part to.\n\nThis operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.\n\n## Format a Date[#](#format-a-date \"Permanent link\")\n\nConfigure the node for this operation using these parameters:\n\n* **Date**: Enter the date you want to format.\n* **Format**: Select the format you want to change the date to. Choose from:\n * **Custom Format**: Enter your own custom format using Luxon's [special tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens). Tokens are case-sensitive.\n * **MM/DD/YYYY**: For `4 September 1986`, this formats the date as `09/04/1986`.\n * **YYYY/MM/DD**: For `4 September 1986`, this formats the date as `1986/09/04`.\n * **MMMM DD YYYY**: For `4 September 1986`, this formats the date as `September 04 1986`.\n * **MM-DD-YYYY**: For `4 September 1986`, this formats the date as `09-04-1986`.\n * **YYYY-MM-DD**: For `4 September 1986`, this formats the date as `1986-09-04`.\n* **Output Field Name**: Enter the name of the field to output the formatted date to.\n\n### Format a Date options[#](#format-a-date-options \"Permanent link\")\n\nThis operation includes these options:\n\n* **Include Input Fields**: If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.\n* **From Date Format**: If the node isn't recognizing the **Date** format correctly, enter the format for that **Date** here so the node can process it properly. Use Luxon's [special tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) to enter the format. Tokens are case-sensitive\n* **Use Workflow Timezone**: Whether to use the input's time zone (turned off) or the workflow's timezone (turned on).\n\n## Get Current Date[#](#get-current-date \"Permanent link\")\n\nConfigure the node for this operation using these parameters:\n\n* **Include Current Time**: Choose whether to include the current time (turned on) or to set the time to midnight (turned off).\n* **Output Field Name**: Enter the name of the field to output the current date to.\n\n### Get Current Date options[#](#get-current-date-options \"Permanent link\")\n\nThis operation includes these options:\n\n* **Include Input Fields**: If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.\n* **Timezone**: Set the timezone to use. If left blank, the node uses the n8n instance's timezone.\n\n+00:00 timezone\n\nUse `GMT` for +00:00 timezone.\n\n## Get Time Between Dates[#](#get-time-between-dates \"Permanent link\")\n\nConfigure the node for this operation using these parameters:\n\n* **Start Date**: Enter the earlier date you want to compare.\n* **End Date**: Enter the later date you want to compare.\n* **Units**: Select the units you want to calculate the time between. You can include multiple units. Choose from:\n * **Year**\n * **Month**\n * **Week**\n * **Day**\n * **Hour**\n * **Minute**\n * **Second**\n * **Millisecond**\n* **Output Field Name**: Enter the name of the field to output the calculated time between to.\n\n### Get Time Between Dates options[#](#get-time-between-dates-options \"Permanent link\")\n\nThe Get Time Between Dates operation includes the **Include Input Fields** option as well as an **Output as ISO String** option. If you leave this option off, each unit you selected will return its own time difference calculation, for example:\n\n| | |\n| --- | --- |\n| | `timeDifference years : 1 months : 3 days : 13` |\n\nIf you turn on the **Output as ISO String** option, the node formats the output as a single ISO duration string, for example: `P1Y3M13D`.\n\nISO duration format displays a format as `PYMDTHMS`. `` is the number for the unit after it.\n\n* P = period (duration). It begins all ISO duration strings.\n* Y = years\n* M = months\n* W = weeks\n* D = days\n* T = delineator between dates and times, used to avoid confusion between months and minutes\n* H = hours\n* M = minutes\n* S = seconds\n\nMilliseconds don't get their own unit, but instead are decimal seconds. For example, 2.1 milliseconds is `0.0021S`.\n\n## Round a Date[#](#round-a-date \"Permanent link\")\n\nConfigure the node for this operation using these parameters:\n\n* **Date**: Enter the date you'd like to round.\n* **Mode**: Choose whether to **Round Down** or **Round Up**.\n* **To Nearest**: Select the unit you'd like to round to. Choose from:\n * **Year**\n * **Month**\n * **Week**\n * **Day**\n * **Hour**\n * **Minute**\n * **Second**\n* **Output Field Name**: Enter the name of the field to output the rounded date to.\n\n### Round a Date options[#](#round-a-date-options \"Permanent link\")\n\nThis operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.\n\n## Subtract From a Date[#](#subtract-from-a-date \"Permanent link\")\n\nConfigure the node for this operation using these parameters:\n\n* **Date to Subtract From**: Enter the date you'd like to subtract from.\n* **Time Unit to Subtract**: Select the unit for the **Duration** amount you want to subtract.\n* **Duration**: Enter the amount of the time units you want to subtract from the **Date to Subtract From**.\n* **Output Field Name**: Enter the name of the field to output the rounded date to.\n\n### Subtract From a Date options[#](#subtract-from-a-date-options \"Permanent link\")\n\nThis operation has one option: **Include Input Fields**. If you'd like to include all of the input fields in the output, turn this option on. If turned off, only the **Output Field Name** and its contents are output.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\nThe Date & Time node uses [Luxon](https://moment.github.io/luxon). You can also use Luxon in the [Code](https://docs.n8n.io/code/code-node/) node and [expressions](https://docs.n8n.io/code/expressions/). Refer to [Date and time with Luxon](https://docs.n8n.io/code/cookbook/luxon/) for more information.\n\n### Supported date formats[#](#supported-date-formats \"Permanent link\")\n\nn8n supports all date formats [supported by Luxon](https://moment.github.io/luxon/#/formatting?id=table-of-tokens). Tokens are case-sensitive."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.debughelper/",
"markdown": "# Debug Helper | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.debughelper.md \"Edit this page\")\n\nUse the Debug Helper node to trigger different error types or generate random datasets to help test n8n workflows.\n\n## Operations[#](#operations \"Permanent link\")\n\nDefine the operation by selecting the **Category**:\n\n* **Do Nothing**: Don't do anything.\n* [**Throw Error**](#throw-error): Throw an error with the specified type and message.\n* [**Out Of Memory**](#out-of-memory): Generate a specific memory size to simulate being out of memory.\n* [**Generate Random Data**](#generate-random-data): Generate some random data in a selected format.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nThe node parameters depend on the **Category** selected. The **Do Nothing** Category has no other parameters.\n\n### Throw Error[#](#throw-error \"Permanent link\")\n\n* **Error Type**: Select the type of error to throw. Choose from:\n * **NodeApiError**\n * **NodeOperationError**\n * **Error**\n* **Error Message**: Enter the error message to throw.\n\n### Out Of Memory[#](#out-of-memory \"Permanent link\")\n\nThe Out of Memory Category adds one parameter, the **Memory Size to Generate**. Enter the approximate amount of memory to generate.\n\n### Generate Random Data[#](#generate-random-data \"Permanent link\")\n\n* **Data Type**: Choose the type of random data you'd like to generate. Options include:\n * **Address**\n * **Coordinates**\n * **Credit Card**\n * **Email**\n * **IPv4**\n * **IPv6**\n * **MAC**\n * **Nanoids**: If you select this data type, you'll also need to enter:\n * **Nanoid Alphabet**: The alphabet the generator will use to generate the nanoids.\n * **Nanoid Length**: The length of each nanoid.\n * **URL**\n * **User Data**\n * **UUID**\n * **Version**\n* **Seed**: If you'd like to generate the data using a specific seed, enter it here. This ensures the data gets generated consistently. If you'd rather use random data generation, leave this field empty.\n* **Number of Items to Generate**: Enter the number of random items you'd like to generate.\n* **Output as Single Array**: Whether to generate the data as a single array (turned on) or multiple items (turned off).\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/",
"markdown": "# Edit Fields (Set) | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.set.md \"Edit this page\")\n\nUse the Edit Fields node to set workflow data. This node can set new data as well as overwrite data that already exists. This node is crucial in workflows which expect incoming data from previous nodes, such as when inserting values to Google Sheets or databases.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nThese are the settings and options available in the Edit Fields node.\n\n### Mode[#](#mode \"Permanent link\")\n\nYou can either use **Manual Mapping** to edit fields using the GUI or **JSON Output** to write JSON that n8n adds to the input data.\n\n### Fields to Set[#](#fields-to-set \"Permanent link\")\n\nIf you select **Mode** > **Manual Mapping**, you can configure the fields by dragging and dropping values from **INPUT**.\n\nThe default behavior when you drag a value is:\n\n* n8n sets the value's name as the field name.\n* The field value contains an expression which accesses the value.\n\nIf you don't want to use expressions:\n\n1. Hover over a field. n8n displays the **Fixed | Expressions** toggle.\n2. Select **Fixed**.\n\nYou can do this for both the name and value of the field.\n\n\n\n### Keep Only Set Fields[#](#keep-only-set-fields \"Permanent link\")\n\nEnable this to discard any input data that you don't use in **Fields to Set**.\n\n### Include in Output[#](#include-in-output \"Permanent link\")\n\nChoose which input data to include in the node's output data.\n\n## Node options[#](#node-options \"Permanent link\")\n\nUse these options to customize the behavior of the node.\n\n### Include Binary Data[#](#include-binary-data \"Permanent link\")\n\nIf the input data includes binary data, choose whether to include it in the Edit Fields node's output data.\n\n### Ignore Type Conversion Errors[#](#ignore-type-conversion-errors \"Permanent link\")\n\nManual Mapping only.\n\nEnabling this allows n8n to ignore some data type errors when mapping fields.\n\n### Support Dot Notation[#](#support-dot-notation \"Permanent link\")\n\nBy default, n8n supports dot notation.\n\nFor example, when using manual mapping, the node follows the dot notation for the **Name** field. That means if you set the name in the **Name** field as `number.one` and the value in the **Value** field as `20`, the resulting JSON is:\n\n| | |\n| --- | --- |\n| | `{ \"number\": { \"one\": 20} }` |\n\nYou can prevent this behavior by selecting **Add Option** > **Support Dot Notation**, and setting the **Dot Notion** field to off. Now the resulting JSON is:\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n## Arrays and expressions in JSON Output mode[#](#arrays-and-expressions-in-json-output-mode \"Permanent link\")\n\nYou can use arrays and expressions when creating your JSON Output.\n\nFor example, given this input data generated by the Customer Datastore node:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42 | `[ { \"id\": \"23423532\", \"name\": \"Jay Gatsby\", \"email\": \"gatsby@west-egg.com\", \"notes\": \"Keeps asking about a green light??\", \"country\": \"US\", \"created\": \"1925-04-10\" }, { \"id\": \"23423533\", \"name\": \"José Arcadio Buendía\", \"email\": \"jab@macondo.co\", \"notes\": \"Lots of people named after him. Very confusing\", \"country\": \"CO\", \"created\": \"1967-05-05\" }, { \"id\": \"23423534\", \"name\": \"Max Sendak\", \"email\": \"info@in-and-out-of-weeks.org\", \"notes\": \"Keeps rolling his terrible eyes\", \"country\": \"US\", \"created\": \"1963-04-09\" }, { \"id\": \"23423535\", \"name\": \"Zaphod Beeblebrox\", \"email\": \"captain@heartofgold.com\", \"notes\": \"Felt like I was talking to more than one person\", \"country\": null, \"created\": \"1979-10-12\" }, { \"id\": \"23423536\", \"name\": \"Edmund Pevensie\", \"email\": \"edmund@narnia.gov\", \"notes\": \"Passionate sailor\", \"country\": \"UK\", \"created\": \"1950-10-16\" } ]` |\n\nAdd the following JSON in the **JSON Output** field, with **Include in Output** set to **All Input Fields**:\n\n| | |\n| --- | --- |\n| | `{ \"newKey\": \"new value\", \"array\": [{{ $json.id }},\"{{ $json.name }}\"], \"object\": { \"innerKey1\": \"new value\", \"innerKey2\": \"{{ $json.id }}\", \"innerKey3\": \"{{ $json.name }}\", } }` |\n\nYou get this output:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92 | `[ { \"id\": \"23423532\", \"name\": \"Jay Gatsby\", \"email\": \"gatsby@west-egg.com\", \"notes\": \"Keeps asking about a green light??\", \"country\": \"US\", \"created\": \"1925-04-10\", \"newKey\": \"new value\", \"array\": [ 23423532, \"Jay Gatsby\" ], \"object\": { \"innerKey1\": \"new value\", \"innerKey2\": \"23423532\", \"innerKey3\": \"Jay Gatsby\" } }, { \"id\": \"23423533\", \"name\": \"José Arcadio Buendía\", \"email\": \"jab@macondo.co\", \"notes\": \"Lots of people named after him. Very confusing\", \"country\": \"CO\", \"created\": \"1967-05-05\", \"newKey\": \"new value\", \"array\": [ 23423533, \"José Arcadio Buendía\" ], \"object\": { \"innerKey1\": \"new value\", \"innerKey2\": \"23423533\", \"innerKey3\": \"José Arcadio Buendía\" } }, { \"id\": \"23423534\", \"name\": \"Max Sendak\", \"email\": \"info@in-and-out-of-weeks.org\", \"notes\": \"Keeps rolling his terrible eyes\", \"country\": \"US\", \"created\": \"1963-04-09\", \"newKey\": \"new value\", \"array\": [ 23423534, \"Max Sendak\" ], \"object\": { \"innerKey1\": \"new value\", \"innerKey2\": \"23423534\", \"innerKey3\": \"Max Sendak\" } }, { \"id\": \"23423535\", \"name\": \"Zaphod Beeblebrox\", \"email\": \"captain@heartofgold.com\", \"notes\": \"Felt like I was talking to more than one person\", \"country\": null, \"created\": \"1979-10-12\", \"newKey\": \"new value\", \"array\": [ 23423535, \"Zaphod Beeblebrox\" ], \"object\": { \"innerKey1\": \"new value\", \"innerKey2\": \"23423535\", \"innerKey3\": \"Zaphod Beeblebrox\" } }, { \"id\": \"23423536\", \"name\": \"Edmund Pevensie\", \"email\": \"edmund@narnia.gov\", \"notes\": \"Passionate sailor\", \"country\": \"UK\", \"created\": \"1950-10-16\", \"newKey\": \"new value\", \"array\": [ 23423536, \"Edmund Pevensie\" ], \"object\": { \"innerKey1\": \"new value\", \"innerKey2\": \"23423536\", \"innerKey3\": \"Edmund Pevensie\" } } ]` |"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.editimage/",
"markdown": "# Edit Image | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.editimage.md \"Edit this page\")\n\nUse the Edit Image node to manipulate and edit images.\n\nDependencies\n\n1. If you aren't running n8n on Docker, you need to install [GraphicsMagick](http://www.graphicsmagick.org/README.html).\n2. You need to use a node such as the [Read/Write Files from Disk](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile/) node or the [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node to pass the image file as a data property to the Edit Image node.\n\n## Operations[#](#operations \"Permanent link\")\n\n* Add a **Blur** to the image to reduce sharpness\n* Add a **Border** to the image\n* **Composite** an image on top of another image\n* **Create** a new image\n* **Crop** the image\n* **Draw** on an image\n* **Get Information** about the image\n* **Multi Step** perform multiple operations on the image\n* **Resize**: Change the size of the image\n* **Rotate** the image\n* **Shear** image along the X or Y axis\n* Add **Text** to the image\n* Make a color in image **Transparent**\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nThe parameters for this node depend on the operation you select.\n\n### Blur parameters[#](#blur-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Blur**: Enter a number to set how strong the blur should be, between 0 and 1000. Higher numbers create blurrier images.\n* **Sigma**: Enter a number to set the stigma for the blur, between 0 and 1000. Higher numbers create blurrier images.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Border parameters[#](#border-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Border Width**: Enter the width of the border.\n* **Border Height**: Enter the height of the border.\n* **Border Color**: Set the color for the border. You can either enter a hex or select the color swatch to open a color picker.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Composite parameters[#](#composite-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data. This image is your base image.\n* **Composite Image Property**: Enter the name of the binary property that stores image to composite on top of the **Property Name** image.\n* **Operator**: Select composite operator, which determines how the composite works. Options include:\n * **Add**\n * **Atop**\n * **Bumpmap**\n * **Copy**\n * **Copy Black**\n * **Copy Blue**\n * **Copy Cyan**\n * **Copy Green**\n * **Copy Magenta**\n * **Copy Opacity**\n * **Copy Red**\n * **Copy Yellow**\n * **Difference**\n * **Divide**\n * **In**\n * **Minus**\n * **Multiply**\n * **Out**\n * **Over**\n * **Plus**\n * **Subtract**\n * **Xor**\n* **Position X**: Enter the x axis position (horizontal) of the composite image.\n* **Position Y**: Enter the y axis position (vertical) of the composite image.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Create parameters[#](#create-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Background Color**: Set the background color for the image. You can either enter a hex or select the color swatch to open a color picker.\n* **Image Width**: Enter the width of the image.\n* **Image Height**: Enter the height of the image.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Crop parameters[#](#crop-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Width**: Enter the width you'd like to crop to.\n* **Height**: Enter the height you'd like to crop to.\n* **Position X**: Enter the x axis position (horizontal) to start the crop from.\n* **Position Y**: Enter the y axis position (vertical) to start the crop from.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Draw parameters[#](#draw-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Primitive**: Select the primitive shape to draw. Choose from:\n * **Circle**\n * **Line**\n * **Rectangle**\n* **Color**: Set the color for the primitive. You can either enter a hex or select the color swatch to open a color picker.\n* **Start Position X**: Enter the x axis position (horizontal) to start drawing from.\n* **Start Position Y**: Enter the y axis position (vertical) to start drawing from.\n* **End Position X**: Enter the x axis position (horizontal) to stop drawing at.\n* **End Position Y**: Enter the y axis position (vertical) to start drawing at.\n* **Corner Radius**: Enter a number to set the corner radius. Adding a corner radius will round the corners of the drawn primitive.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Get Information parameters[#](#get-information-parameters \"Permanent link\")\n\nFor this operation, you only need to add the **Property Name** of the binary property that stores the image data.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Multi Step parameters[#](#multi-step-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Operations**: Add the operations you want the multi step operation to perform. You can use any of the other operations.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Resize parameters[#](#resize-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Width**: Enter the new width you'd like for the image.\n* **Height**: Enter the new height you'd like for the image.\n* **Option**: Select how you'd like to resize the image. Choose from:\n * **Ignore Aspect Ratio**: Ignore the aspect ratio and resize to the exact height and width you've entered.\n * **Maximum Area**: The height and width you've entered is the maximum area/size for the image. The image maintains its aspect ratio and won't be larger than the height and/or width you've entered.\n * **Minimum Area**: The height and width you've entered is the minimum area/size for the image. The image maintains its aspect ratio and won't be smaller than the height and/or width you've entered.\n * **Only if Larger**: Resize the image only if it's larger than the width and height you entered. The image maintains its aspect ratio.\n * **Only if Smaller**: Resize the image only if it's smaller than the width and height you entered. The image maintains its aspect ratio.\n * **Percent**: Resize the image using the width and height as percentages of the original image.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Rotate parameters[#](#rotate-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Rotate**: Enter the number of degrees to rotate the image, from --360 to 360.\n* **Background Color**: Set the background color for the image. You can either enter a hex or select the color swatch to open a color picker. This color is used to fill in the empty background whenever the image is rotated by multiples of 90 degrees. If multipled of 90 degrees are used for the **Rotate** field, the background color isn't used.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Shear parameters[#](#shear-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Degrees X**: Enter the number of degrees to shear from the x axis.\n* **Degrees Y**: Enter the number of degrees to shear from the y axis.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Text parameters[#](#text-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Text**: Enter the text you'd like to write on the image.\n* **Font Size**: Select the font size for the text.\n* **Font Color**: Set the font color. You can either enter a hex or select the color swatch to open a color picker.\n* **Position X**: Enter the x axis position (horizontal) to begin the text at.\n* **Position Y**: Enter the y axis position (vertical) to begin the text at.\n* **Max Line Length**: Enter the maximum amount of characters in a line before adding a line break.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n### Transparent parameters[#](#transparent-parameters \"Permanent link\")\n\n* **Property Name**: Enter the name of the binary property that stores the image data.\n* **Color**: Set the color to make transparent. You can either enter a hex or select the color swatch to open a color picker.\n\nRefer to [Node options](#node-options) for optional configuration options.\n\n## Node options[#](#node-options \"Permanent link\")\n\n* **File Name**: Enter the filename of the output file.\n* **Format**: Enter the image format of the output file. Choose from:\n * **bmp**\n * **gif**\n * **jpeg**\n * **png**\n * **tiff**\n * **WebP**\n\nThe **Text** operation also includes the option for **Font Name or ID**. Select the text font from the dropdown or specify an ID using an [expression](https://docs.n8n.io/code/expressions/).\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.emailimap/",
"markdown": "# Email Trigger (IMAP) node documentation\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.emailimap.md \"Edit this page\")\n\nUse the IMAP Email node to receive emails using an IMAP email server. This node is a trigger node.\n\nCredential\n\nYou can find authentication information for this node [here](https://docs.n8n.io/integrations/builtin/credentials/imap/).\n\n## Operations[#](#operations \"Permanent link\")\n\n* Receive an email\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nConfigure the node using the following parameters.\n\n### Credential to connect with[#](#credential-to-connect-with \"Permanent link\")\n\nSelect or create an [IMAP credential](https://docs.n8n.io/integrations/builtin/credentials/imap/) to connect to the server with.\n\n### Mailbox Name[#](#mailbox-name \"Permanent link\")\n\nEnter the mailbox from which you want to receive emails.\n\n### Action[#](#action \"Permanent link\")\n\nChoose whether you want an email marked as read when n8n receives it. **None** will leave it marked unread. **Mark as Read** will mark it as read.\n\n### Download Attachments[#](#download-attachments \"Permanent link\")\n\nThis toggle controls whether to download email attachments (turned on) or not (turned off). Only set this if necessary, since it increases processing.\n\n### Format[#](#format \"Permanent link\")\n\nChoose the format to return the message in from these options:\n\n* **RAW**: This format returns the full email message data with body content in the raw field as a base64url encoded string. It doesn't use the payload field.\n* **Resolved**: This format returns the full email with all data resolved and attachments saved as binary data.\n* **Simple**: This format returns the full email. Don't use it if you want to gather inline attachments.\n\n## Node options[#](#node-options \"Permanent link\")\n\nYou can further configure the node using these **Options**.\n\n### Custom Email Rules[#](#custom-email-rules \"Permanent link\")\n\nEnter custom email fetching rules to determine which emails the node fetches.\n\nRefer to [node-imap's search function criteria](https://github.com/mscdex/node-imap) for more information.\n\n### Force Reconnect Every Minutes[#](#force-reconnect-every-minutes \"Permanent link\")\n\nSet an interval in minutes to force reconnection.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger/",
"markdown": "# Error Trigger node documentation | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger.md \"Edit this page\")\n\nYou can use the Error Trigger node to create error workflows. When another linked workflow fails, this node gets details about the failed workflow and the errors, and runs the error workflow.\n\n## Usage[#](#usage \"Permanent link\")\n\n1. Create a new workflow, with the Error Trigger as the first node.\n2. Give the workflow a name, for example `Error Handler`.\n3. Select **Save**.\n4. In the workflow where you want to use this error workflow:\n 1. Select **Options**  > **Settings**.\n 2. In **Error workflow**, select the workflow you just created. For example, if you used the name Error Handler, select **Error handler**.\n 3. Select **Save**. Now, when this workflow errors, the related error workflow runs.\n\nNote the following:\n\n* If a workflow uses the Error Trigger node, you don't have to activate the workflow.\n* If a workflow contains the Error Trigger node, by default, the workflow uses itself as the error workflow.\n* You can't test error workflows when running workflows manually. The Error Trigger only runs when an automatic workflow errors.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n[Browse Error Trigger integration templates](https://n8n.io/integrations/error-trigger/), or [search all templates](https://n8n.io/workflows/)\n\nYou can use the [Stop And Error](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror/) node to send custom messages to the Error Trigger.\n\nRead more about [Error workflows](https://docs.n8n.io/flow-logic/error-handling/) in n8n workflows.\n\n## Error data[#](#error-data \"Permanent link\")\n\nThe default error data received by the Error Trigger is:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 | `[ \t{ \t\t\"execution\": { \t\t\t\"id\": \"231\", \t\t\t\"url\": \"https://n8n.example.com/execution/231\", \t\t\t\"retryOf\": \"34\", \t\t\t\"error\": { \t\t\t\t\"message\": \"Example Error Message\", \t\t\t\t\"stack\": \"Stacktrace\" \t\t\t}, \t\t\t\"lastNodeExecuted\": \"Node With Error\", \t\t\t\"mode\": \"manual\" \t\t}, \t\t\"workflow\": { \t\t\t\"id\": \"1\", \t\t\t\"name\": \"Example Workflow\" \t\t} \t} ]` |\n\nAll information is always present, except:\n\n* `execution.id`: requires the execution to be saved in the database. Not present if the error is in the trigger node of the main workflow, as the workflow doesn't execute.\n* `execution.url`: requires the execution to be saved in the database. Not present if the error is in the trigger node of the main workflow, as the workflow doesn't execute.\n* `execution.retryOf`: only present when the execution is a retry of a failed execution.\n\nIf the error is caused by the trigger node of the main workflow, rather than a later stage, the data sent to the error workflow is different. There's less information in `execution{}` and more in `trigger{}`:\n\n| | |\n| --- | --- |\n| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 | `{ \"trigger\": { \"error\": { \"context\": {}, \"name\": \"WorkflowActivationError\", \"cause\": { \"message\": \"\", \"stack\": \"\" }, \"timestamp\": 1654609328787, \"message\": \"\", \"node\": { . . . } }, \"mode\": \"trigger\" }, \"workflow\": { \"id\": \"\", \"name\": \"\" } }` |"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluation/",
"markdown": "# Evaluation node documentation | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.evaluation.md \"Edit this page\")\n\nThe Evaluation node performs various operations related to [evaluations](https://docs.n8n.io/advanced-ai/evaluations/overview/) to validate your AI workflow reliability. You can use the Evaluation node to conditionally execute logic based on whether the workflow is under evaluation, to write evaluation outcomes back to a Google Sheet dataset, or to log scoring metrics for your evaluation performance to n8n's evaluations tab.\n\nCredentials\n\nThe Evaluation node's **Set Outputs** operation uses Google Sheets to record evaluation outcomes. To use that operation, you must configure a [Google Sheets credential](https://docs.n8n.io/integrations/builtin/credentials/google/).\n\n## Operations[#](#operations \"Permanent link\")\n\nThe Evaluation node offers the following operations:\n\n* [**Set Outputs**](#set-outputs): Write the results of an evaluation back to a Google Sheet dataset.\n* [**Set Metrics**](#set-metrics): Record metrics scoring the evaluation performance to n8n's **Evaluations** tab.\n* [**Check If Evaluating**](#check-if-evaluating): Branches the workflow execution logic depending on whether the current execution is an evaluation.\n\nThe parameters and options available depend on the operation you select.\n\n### Set Outputs[#](#set-outputs \"Permanent link\")\n\nThe **Set Outputs** operation has the following parameters:\n\n* **Credential to connect with**: Create or select an existing [Google Sheets credentials](https://docs.n8n.io/integrations/builtin/credentials/google/).\n* **Document Containing Dataset**: Choose the spreadsheet document you want to write the evaluation results to. Usually this is the same document you select in the [Evaluation Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluationtrigger/) node.\n * Select **From list** to choose the spreadsheet title from the dropdown list, **By URL** to enter the url of the spreadsheet, or **By ID** to enter the `spreadsheetId`.\n * You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`.\n* **Sheet Containing Dataset**: Choose the sheet you want to write the evaluation results to. Usually this is the same sheet you select in the [Evaluation Trigger](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluationtrigger/) node.\n * Select **From list** to choose the sheet title from the dropdown list, **By URL** to enter the url of the sheet, **By ID** to enter the `sheetId`, or **By Name** to enter the sheet title.\n * You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`.\n\nYou define the items to write to the Google Sheet in the **Outputs** section. For each output, you set the following:\n\n* **Name**: The Google Sheet column name to write the evaluation results to.\n* **Value**: The value to write to the Google Sheet.\n\n### Set Metrics[#](#set-metrics \"Permanent link\")\n\nThe **Set Metrics** operation includes a **Metrics to Return** section where you define the metrics to record and track for your evaluations. You can see the metric results in your workflow's **Evaluations** tab.\n\nFor each metric you wish to record, you set the following details:\n\n* **Name**: The name to use for the metric.\n* **Value**: The numeric value to record. Once you run your evaluation, you can drag and drop values from previous nodes here. Metric values must be numeric.\n\n### Check If Evaluating[#](#check-if-evaluating \"Permanent link\")\n\nThe **Check If Evaluating** operation does not have any parameters. This operation provides branching output connectors so that you can conditionally execute logic depending on whether the current execution is an evaluation or not.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\nTo learn more about n8n evaluations, check out the [evaluations documentation](https://docs.n8n.io/advanced-ai/evaluations/overview/)\n\nn8n provides a trigger node for evaluations. You can find the node docs [here](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluationtrigger/).\n\nFor common questions or issues and suggested solutions, refer to the evaluations [tips and common issues](https://docs.n8n.io/advanced-ai/evaluations/tips-and-common-issues/) page."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluationtrigger/",
"markdown": "# Evaluation Trigger node documentation | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.evaluationtrigger.md \"Edit this page\")\n\nUse the Evaluation Trigger node when setting up [evaluations](https://docs.n8n.io/advanced-ai/evaluations/overview/) to validate your AI workflow reliability. During evaluation, the Evaluation Trigger node reads your evaluation dataset from Google Sheets, sending the items through the workflow one at a time, in sequence.\n\nOn this page, you'll find the Evaluation Trigger node parameters and\n\nRequires Google Sheets\n\nThe Evaluation Trigger node uses Google Sheets to store the test dataset. To use evaluations, you must configure a [Google Sheets credential](https://docs.n8n.io/integrations/builtin/credentials/google/).\n\n## Parameters[#](#parameters \"Permanent link\")\n\n* **Credential to connect with**: Create or select an existing [Google Sheets credentials](https://docs.n8n.io/integrations/builtin/credentials/google/).\n* **Document Containing Dataset**: Choose the spreadsheet document with the sheet containing your test dataset.\n * Select **From list** to choose the spreadsheet title from the dropdown list, **By URL** to enter the url of the spreadsheet, or **By ID** to enter the `spreadsheetId`.\n * You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`.\n* **Sheet Containing Dataset**: Choose the sheet containing your test dataset.\n * Select **From list** to choose the sheet title from the dropdown list, **By URL** to enter the url of the sheet, **By ID** to enter the `sheetId`, or **By Name** to enter the sheet title.\n * You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`.\n* **Limit Rows**: Whether to limit the number of rows in the sheet to process.\n * **Max Rows to Process**: When **Limit Rows** is enabled, the maximum number of rows to read and process during the evaluation.\n\n## Filters[#](#filters \"Permanent link\")\n\nOptionally filter the evaluation dataset based on column values.\n\n* **Column**: Choose a sheet column you want to filter by. Select **From list** to choose the column name from the dropdown list, or **By ID** to specify an ID using an [expression](https://docs.n8n.io/code/expressions/).\n* **Value**: The column value you want to filter by. The evaluation will only process rows with the given value for the selected column.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\nTo learn more about n8n evaluations, check out the [evaluations documentation](https://docs.n8n.io/advanced-ai/evaluations/overview/)\n\nn8n provides an app node for evaluations. You can find the node docs [here](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.evaluation/).\n\nFor common questions or issues and suggested solutions, refer to the evaluations [tips and common issues](https://docs.n8n.io/advanced-ai/evaluations/tips-and-common-issues/) page."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/",
"markdown": "# Execute Command | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/index.md \"Edit this page\")\n\nThe Execute Command node runs shell commands on the host machine that runs n8n.\n\nWhich shell runs the command?\n\nThis node executes the command in the default shell of the host machine. For example, `cmd` on Windows and `zsh` on macOS.\n\nIf you run n8n with Docker, your command will run in the n8n container and not the Docker host.\n\nNot available on Cloud\n\nThis node isn't available on n8n Cloud.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nConfigure the node using the following parameters.\n\n### Execute Once[#](#execute-once \"Permanent link\")\n\nChoose whether you want the node to execute only once (turned on) or once for every item it receives as input (turned off).\n\n### Command[#](#command \"Permanent link\")\n\nEnter the command to execute on the host machine. Refer to sections below for examples of running [multiple commands](#run-multiple-commands) and [cURL commands](#run-curl-command).\n\n#### Run multiple commands[#](#run-multiple-commands \"Permanent link\")\n\nUse one of two methods to run multiple commands in one Execute Command node:\n\n* Enter each command on one line separated by `&&`. For example, you can combine the change directory (cd) command with the list (ls) command using `&&`.\n \n* Enter each command on a separate line. For example, you can write the list (ls) command on a new line after the change directory (cd) command.\n \n\n#### Run cURL command[#](#run-curl-command \"Permanent link\")\n\nYou can also use the [HTTP Request](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) node to make a cURL request.\n\nIf you want to run the curl command in the Execute Command node, you will have to build a Docker image based on the existing n8n image. The default n8n Docker image uses Alpine Linux. You will have to install the curl package.\n\n1. Create a file named `Dockerfile`.\n2. Add the below code snippet to the Dockerfile.\n \n | | |\n | --- | --- |\n | | `FROM docker.n8n.io/n8nio/n8n USER root RUN apk --update add curl USER node` |\n \n3. In the same folder, execute the command below to build the Docker image.\n \n4. Replace the Docker image you used before. For example, replace `docker.n8n.io/n8nio/n8n` with `n8n-curl`.\n \n5. Run the newly created Docker image. You'll now be able to execute ssh using the Execute Command Node.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n## Common issues[#](#common-issues \"Permanent link\")\n\nFor common questions or issues and suggested solutions, refer to [Common Issues](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/common-issues/)."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/common-issues/",
"markdown": "# Execute Command node common issues\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/common-issues.md \"Edit this page\")\n\nHere are some common errors and issues with the [Execute Command node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/) and steps to resolve or troubleshoot them.\n\n## Command failed: /bin/sh: : not found[#](#command-failed-command-binsh-command-not-found \"Permanent link\")\n\nThis error occurs when the shell environment can't find one of the commands in the **Command** parameter.\n\nTo fix this error, review the following:\n\n* Check that the command and its arguments don't have typos in the **Command** parameter.\n* Check that the command is in the `PATH` of the user running n8n.\n* If you are running n8n with Docker, check if the command is available within the container by trying to run it manually. If your command isn't included in the container, you might have to extend the official n8n image with a [custom image](https://docs.docker.com/build/building/base-images/) that includes your command.\n * If n8n is already running:\n \n | | |\n | --- | --- |\n | | `# Find n8n's container ID, it will be the first column docker ps \\| grep n8n # Try to execute the command within the running container docker container exec ` |\n \n * If n8n isn't running:\n \n | | |\n | --- | --- |\n | | `# Start up a new container that runs the command instead of n8n # Use the same image and tag that you use to run n8n normally docker run -it --rm --entrypoint /bin/sh docker.n8n.io/n8nio/n8n -c ` |\n \n\n## Error: stdout maxBuffer length exceeded[#](#error-stdout-maxbuffer-length-exceeded \"Permanent link\")\n\nThis error happens when your command returns more output than the Execute Command node is able to process at one time.\n\nTo avoid this error, reduce output your command produces. Check your command's manual page or documentation to see if there are flags to limit or filter output. If not, you may need to pipe the output to another command to remove unneeded info."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/",
"markdown": "# Execute Sub-workflow | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md \"Edit this page\")\n\nUse the Execute Sub-workflow node to run a different workflow on the host machine that runs n8n.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\n### Source[#](#source \"Permanent link\")\n\nSelect where the node should get the sub-workflow's information from:\n\n* **Database**: Select this option to load the workflow from the database by ID. You must also enter either:\n * **From list**: Select the workflow from a list of workflows available to your account.\n * **Workflow ID**: Enter the ID for the workflow. The URL of the workflow contains the ID after `/workflow/`. For example, if the URL of a workflow is `https://my-n8n-acct.app.n8n.cloud/workflow/abCDE1f6gHiJKL7`, the **Workflow ID** is `abCDE1f6gHiJKL7`.\n* **Local File**: Select this option to load the workflow from a locally saved JSON file. You must also enter:\n * **Workflow Path**: Enter the path to the local JSON workflow file you want the node to execute.\n* **Parameter**: Select this option to load the workflow from a parameter. You must also enter:\n * **Workflow JSON**: Enter the JSON code you want the node to execute.\n* **URL**: Select this option to load the workflow from a URL. You must also enter:\n * **Workflow URL**: Enter the URL you want to load the workflow from.\n\n### Workflow Inputs[#](#workflow-inputs \"Permanent link\")\n\nIf you select a sub-workflow using the **database** and **From list** options, the sub-workflow's input items will automatically display, ready for you to fill in or map values.\n\nYou can optionally remove requested input items, in which case the sub-workflow receives `null` as the item's value. You can also enable **Attempt to convert types** to try to automatically convert data to the sub-workflow item's requested type.\n\nInput items won't appear if the sub-workflow's Workflow Input Trigger node uses the \"Accept all data\" input data mode.\n\n### Mode[#](#mode \"Permanent link\")\n\nUse this parameter to control the execution mode for the node. Choose from these options:\n\n* **Run once with all items**: Pass all input items into a single execution of the node.\n* **Run once for each item**: Execute the node once for each input item in turn.\n\n## Node options[#](#node-options \"Permanent link\")\n\nThis node includes one option: **Wait for Sub-Workflow Completion**. This lets you control whether the main workflow should wait for the sub-workflow's completion before moving on to the next step (turned on) or whether the main workflow should continue without waiting (turned off).\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n## Set up and use a sub-workflow[#](#set-up-and-use-a-sub-workflow \"Permanent link\")\n\nThis section walks through setting up both the parent workflow and sub-workflow.\n\n### Create the sub-workflow[#](#create-the-sub-workflow \"Permanent link\")\n\n1. Create a new workflow.\n \n Create sub-workflows from existing workflows\n \n You can optionally create a sub-workflow directly from an existing parent workflow using the [Execute Sub-workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) node. In the node, select the **Database** and **From list** options and select **Create a sub-workflow** in the list.\n \n You can also extract selected nodes directly using [Sub-workflow conversion](https://docs.n8n.io/workflows/subworkflow-conversion/) in the context menu.\n \n2. **Optional**: configure which workflows can call the sub-workflow:\n \n 1. Select the **Options**  menu > **Settings**. n8n opens the **Workflow settings** modal.\n 2. Change the **This workflow can be called by** setting. Refer to [Workflow settings](https://docs.n8n.io/workflows/settings/) for more information on configuring your workflows.\n3. Add the **Execute Sub-workflow** trigger node (if you are searching under trigger nodes, this is also titled **When Executed by Another Workflow**).\n4. Set the **Input data mode** to choose how you will define the sub-workflow's input data:\n * **Define using fields below**: Choose this mode to define individual input names and data types that the calling workflow needs to provide. The [Execute Sub-workflow node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) or [Call n8n Workflow Tool node](https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow/) in the calling workflow will automatically pull in the fields defined here.\n * **Define using JSON example**: Choose this mode to provide an example JSON object that demonstrates the expected input items and their types.\n * **Accept all data**: Choose this mode to accept all data unconditionally. The sub-workflow won't define any required input items. This sub-workflow must handle any input inconsistencies or missing values.\n5. Add other nodes as needed to build your sub-workflow functionality.\n6. Save the sub-workflow.\n\nSub-workflow mustn't contain errors\n\nIf there are errors in the sub-workflow, the parent workflow can't trigger it.\n\nLoad data into sub-workflow before building\n\nThis requires the ability to [load data from previous executions](https://docs.n8n.io/workflows/executions/debug/), which is available on n8n Cloud and registered Community plans.\n\nIf you want to load data into your sub-workflow to use while building it:\n\n1. Create the sub-workflow and add the **Execute Sub-workflow Trigger**.\n2. Set the node's **Input data mode** to **Accept all data** or define the input items using fields or JSON if they're already known.\n3. In the sub-workflow [settings](https://docs.n8n.io/workflows/settings/), set **Save successful production executions** to **Save**.\n4. Skip ahead to setting up the parent workflow, and run it.\n5. Follow the steps to [load data from previous executions](https://docs.n8n.io/workflows/executions/debug/).\n6. Adjust the **Input data mode** to match the input sent by the parent workflow if necessary.\n\nYou can now pin example data in the trigger node, enabling you to work with real data while configuring the rest of the workflow.\n\n### Call the sub-workflow[#](#call-the-sub-workflow \"Permanent link\")\n\n1. Open the workflow where you want to call the sub-workflow.\n2. Add the **Execute Sub-workflow** node.\n3. In the **Execute Sub-workflow** node, set the sub-workflow you want to call. You can choose to call the workflow by ID, load a workflow from a local file, add workflow JSON as a parameter in the node, or target a workflow by URL.\n \n Find your workflow ID\n \n Your sub-workflow's ID is the alphanumeric string at the end of its URL.\n \n4. Fill in the required input items defined by the sub-workflow.\n \n5. Save your workflow.\n\nWhen your workflow executes, it will send data to the sub-workflow, and run it.\n\nYou can follow the execution flow from the parent workflow to the sub-workflow by opening the Execute Sub-workflow node and selecting the **View sub-execution** link. Likewise, the sub-workflow's execution contains a link back to the parent workflow's execution to navigate in the other direction.\n\n## How data passes between workflows[#](#how-data-passes-between-workflows \"Permanent link\")\n\nAs an example, imagine you have an Execute Sub-workflow node in **Workflow A**. The Execute Sub-workflow node calls another workflow called **Workflow B**:\n\n1. The Execute Sub-workflow node passes the data to the Execute Sub-workflow Trigger node (titled \"When executed by another node\" in the canvas) of **Workflow B**.\n2. The last node of **Workflow B** sends the data back to the Execute Sub-workflow node in **Workflow A**."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executiondata/",
"markdown": "# Execution Data | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.executiondata.md \"Edit this page\")\n\nUse this node to save metadata for workflow executions. You can then search by this data in the **Executions** list.\n\nYou can retrieve custom execution data during workflow execution using the Code node. Refer to [Custom executions data](https://docs.n8n.io/workflows/executions/custom-executions-data/) for more information.\n\nFeature availability\n\nCustom executions data is available on:\n\n* Cloud: Pro, Enterprise\n* Self-Hosted: Enterprise, registered Community\n\n## Operations[#](#operations \"Permanent link\")\n\n* Save Execution Data for Search\n\n## Data to Save[#](#data-to-save \"Permanent link\")\n\nAdd a **Saved Field** for each key/value pair of metadata you'd like to save.\n\n## Limitations[#](#limitations \"Permanent link\")\n\nThe Execution Data node has the following restrictions when storing execution metadata:\n\n* `key`: limited to 50 characters\n* `value`: limited to 512 characters\n\nIf either the `key` or `value` exceed the above limitations, n8n truncates to their maximum length and outputs a log entry.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger/",
"markdown": "# Execute Sub-workflow Trigger node documentation\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md \"Edit this page\")\n\nUse this node to start a workflow in response to another workflow. It should be the first node in the workflow.\n\nn8n allows you to call workflows from other workflows. This is useful if you want to:\n\n* Reuse a workflow: for example, you could have multiple workflows pulling and processing data from different sources, then have all those workflows call a single workflow that generates a report.\n* Break large workflows into smaller components.\n\n## Usage[#](#usage \"Permanent link\")\n\nThis node runs in response to a call from the [Execute Sub-workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) or [Call n8n Workflow Tool](https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow/) nodes.\n\n### Create the sub-workflow[#](#create-the-sub-workflow \"Permanent link\")\n\n1. Create a new workflow.\n \n Create sub-workflows from existing workflows\n \n You can optionally create a sub-workflow directly from an existing parent workflow using the [Execute Sub-workflow](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) node. In the node, select the **Database** and **From list** options and select **Create a sub-workflow** in the list.\n \n You can also extract selected nodes directly using [Sub-workflow conversion](https://docs.n8n.io/workflows/subworkflow-conversion/) in the context menu.\n \n2. **Optional**: configure which workflows can call the sub-workflow:\n \n 1. Select the **Options**  menu > **Settings**. n8n opens the **Workflow settings** modal.\n 2. Change the **This workflow can be called by** setting. Refer to [Workflow settings](https://docs.n8n.io/workflows/settings/) for more information on configuring your workflows.\n3. Add the **Execute Sub-workflow** trigger node (if you are searching under trigger nodes, this is also titled **When Executed by Another Workflow**).\n4. Set the **Input data mode** to choose how you will define the sub-workflow's input data:\n * **Define using fields below**: Choose this mode to define individual input names and data types that the calling workflow needs to provide. The [Execute Sub-workflow node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow/) or [Call n8n Workflow Tool node](https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow/) in the calling workflow will automatically pull in the fields defined here.\n * **Define using JSON example**: Choose this mode to provide an example JSON object that demonstrates the expected input items and their types.\n * **Accept all data**: Choose this mode to accept all data unconditionally. The sub-workflow won't define any required input items. This sub-workflow must handle any input inconsistencies or missing values.\n5. Add other nodes as needed to build your sub-workflow functionality.\n6. Save the sub-workflow.\n\nSub-workflow mustn't contain errors\n\nIf there are errors in the sub-workflow, the parent workflow can't trigger it.\n\nLoad data into sub-workflow before building\n\nThis requires the ability to [load data from previous executions](https://docs.n8n.io/workflows/executions/debug/), which is available on n8n Cloud and registered Community plans.\n\nIf you want to load data into your sub-workflow to use while building it:\n\n1. Create the sub-workflow and add the **Execute Sub-workflow Trigger**.\n2. Set the node's **Input data mode** to **Accept all data** or define the input items using fields or JSON if they're already known.\n3. In the sub-workflow [settings](https://docs.n8n.io/workflows/settings/), set **Save successful production executions** to **Save**.\n4. Skip ahead to setting up the parent workflow, and run it.\n5. Follow the steps to [load data from previous executions](https://docs.n8n.io/workflows/executions/debug/).\n6. Adjust the **Input data mode** to match the input sent by the parent workflow if necessary.\n\nYou can now pin example data in the trigger node, enabling you to work with real data while configuring the rest of the workflow.\n\n### Call the sub-workflow[#](#call-the-sub-workflow \"Permanent link\")\n\n1. Open the workflow where you want to call the sub-workflow.\n2. Add the **Execute Sub-workflow** node.\n3. In the **Execute Sub-workflow** node, set the sub-workflow you want to call. You can choose to call the workflow by ID, load a workflow from a local file, add workflow JSON as a parameter in the node, or target a workflow by URL.\n \n Find your workflow ID\n \n Your sub-workflow's ID is the alphanumeric string at the end of its URL.\n \n4. Fill in the required input items defined by the sub-workflow.\n \n5. Save your workflow.\n\nWhen your workflow executes, it will send data to the sub-workflow, and run it.\n\nYou can follow the execution flow from the parent workflow to the sub-workflow by opening the Execute Sub-workflow node and selecting the **View sub-execution** link. Likewise, the sub-workflow's execution contains a link back to the parent workflow's execution to navigate in the other direction.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n[Browse Execute Sub-workflow Trigger integration templates](https://n8n.io/integrations/execute-workflow-trigger/), or [search all templates](https://n8n.io/workflows/)\n\n## How data passes between workflows[#](#how-data-passes-between-workflows \"Permanent link\")\n\nAs an example, imagine you have an Execute Sub-workflow node in **Workflow A**. The Execute Sub-workflow node calls another workflow called **Workflow B**:\n\n1. The Execute Sub-workflow node passes the data to the Execute Sub-workflow Trigger node (titled \"When executed by another node\" in the canvas) of **Workflow B**.\n2. The last node of **Workflow B** sends the data back to the Execute Sub-workflow node in **Workflow A**."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/",
"markdown": "# Extract From File | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md \"Edit this page\")\n\nA common pattern in n8n workflows is to receive a file, either from and [HTTP Request node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) (for files you are fetching from a website), a [Webhook Node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.webhook/) (for files which are sent to your workflow from elsewhere), or from a local source. Data obtained in this way is often in a binary format, for example a spreadsheet or PDF.\n\nThe Extract From File node extracts data from a binary format file and converts it to JSON, which can then be easily manipulated by the rest of your workflow. For converting JSON back into a binary file type, please see the [Convert to File](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.converttofile/) node.\n\n## Operations[#](#operations \"Permanent link\")\n\nUse the **Operations** drop-down to select the format of the source file to extract data from.\n\n* **Extract From CSV**: The \"Comma Separated Values\" file type is commonly used for tabulated data.\n* **Extract From HTML**: Extract fields from standard web page HTML format files.\n* **Extract From JSON**: Extract JSON data from a binary file.\n* **Extract From ICS**: Extract fields from iCalendar format files.\n* **Extract From ODS**: Extract fields from ODS spreadsheet files.\n* **Extract From PDF**: Extract fields from Portable Document Format files.\n* **Extract From RTF**: Extract fields from Rich Text Format files.\n* **Extract From Text File**: Extract fields from a standard text file format.\n* **Extract From XLS**: Extract fields from a Microsoft Excel file (older format).\n* **Extract From XLSX**: Extract fields from a Microsoft Excel file.\n* **Move File to Base64 String**: Converts binary data to a text-friendly [base64](https://datatracker.ietf.org/doc/html/rfc4648#section-4) format.\n\n## Example workflow[#](#example-workflow \"Permanent link\")\n\nIn this example, a Webhook node is used to trigger the workflow. When a CSV file is sent to the webhook address, the file data is output and received by the Extract From File node.\n\nSet to operate as 'Extract from CSV', the node then outputs the data as a series of JSON 'row' objects:\n\n| | |\n| --- | --- |\n| | `{ \"row\": { \"0\": \"apple\", \"1\": \"1\", \"2\": \"2\", \"3\": \"3\" } ...` |\n\nReceiving files with a webhook\n\nSelect the Webhook Node's **Add Options** button and select **Raw body**, then enable that setting to get the node to output the binary file that the subsequent node is expecting.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\n### Input Binary Field[#](#input-binary-field \"Permanent link\")\n\nEnter the name of the field from the node input data that contains the binary file. The default is 'data'.\n\n### Destination Output Field[#](#destination-output-field \"Permanent link\")\n\nEnter the name of the field in the node output that will contain the extracted data.\n\nThis parameter is only available for these operations:\n\n* Extract From JSON\n* Extract From ICS\n* Extract From Text File\n* Move File to Base64 String\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.filter/",
"markdown": "# Filter | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.filter.md \"Edit this page\")\n\nFilter items based on a condition. If the item meets the condition, the Filter node passes it on to the next node in the Filter node output. If the item doesn't meet the condition, the Filter node omits the item from its output.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nCreate filter comparison **Conditions** to perform your filter.\n\n* Use the data type dropdown to select the data type and comparison operation type for your condition. For example, to filter for dates after a particular date, select **Date & Time > is after**.\n* The fields and values to enter into the condition change based on the data type and comparison you select. Refer to [Available data type comparisons](#available-data-type-comparisons) for a full list of all comparisons by data type.\n\nSelect **Add condition** to create more conditions.\n\n### Combining conditions[#](#combining-conditions \"Permanent link\")\n\nYou can choose to keep items:\n\n* When they meet all conditions: Create two or more conditions and select **AND** in the dropdown between them.\n* When they meet any of the conditions: Create two or more conditions and select **OR** in the dropdown between them.\n\nYou can't create a mix of AND and OR rules.\n\n## Node options[#](#node-options \"Permanent link\")\n\n* **Ignore Case**: Whether to ignore letter case (turned on) or be case sensitive (turned off).\n* **Less Strict Type Validation**: Whether you want n8n to attempt to convert value types based on the operator you choose (turned on) or not (turned off). Turn this on when facing a \"wrong type:\" error in your node.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n## Available data type comparisons[#](#available-data-type-comparisons \"Permanent link\")\n\n### String[#](#string \"Permanent link\")\n\nString data type supports these comparisons:\n\n* exists\n* does not exist\n* is empty\n* is not empty\n* is equal to\n* is not equal to\n* contains\n* does not contain\n* starts with\n* does not start with\n* ends with\n* does not end with\n* matches regex\n* does not match regex\n\n### Number[#](#number \"Permanent link\")\n\nNumber data type supports these comparisons:\n\n* exists\n* does not exist\n* is empty\n* is not empty\n* is equal to\n* is not equal to\n* is greater than\n* is less than\n* is greater than or equal to\n* is less than or equal to\n\n### Date & Time[#](#date-time \"Permanent link\")\n\nDate & Time data type supports these comparisons:\n\n* exists\n* does not exist\n* is empty\n* is not empty\n* is equal to\n* is not equal to\n* is after\n* is before\n* is after or equal to\n* is before or equal to\n\n### Boolean[#](#boolean \"Permanent link\")\n\nBoolean data type supports these comparisons:\n\n* exists\n* does not exist\n* is empty\n* is not empty\n* is true\n* is false\n* is equal to\n* is not equal to\n\n### Array[#](#array \"Permanent link\")\n\nArray data type supports these comparisons:\n\n* exists\n* does not exist\n* is empty\n* is not empty\n* contains\n* does not contain\n* length equal to\n* length not equal to\n* length greater than\n* length less than\n* length greater than or equal to\n* length less than or equal to\n\n### Object[#](#object \"Permanent link\")\n\nObject data type supports these comparisons:\n\n* exists\n* does not exist\n* is empty\n* is not empty"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.ftp/",
"markdown": "# FTP | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.ftp.md \"Edit this page\")\n\nThe FTP node is useful to access and upload files to an FTP or SFTP server.\n\nCredentials\n\nYou can find authentication information for this node [here](https://docs.n8n.io/integrations/builtin/credentials/ftp/).\n\nTo connect to an SFTP server, use an SFTP credential. Refer to [FTP credentials](https://docs.n8n.io/integrations/builtin/credentials/ftp/) for more information.\n\n## Operations[#](#operations \"Permanent link\")\n\n* [**Delete**](#delete) a file or folder\n* [**Download**](#download) a file\n* [**List**](#list) folder content\n* [**Rename**](#rename) or move a file or folder\n* [**Upload**](#upload) a file\n\n## Delete[#](#delete \"Permanent link\")\n\nThis operation includes one parameter: **Path**. Enter the remote path that you would like to connect to.\n\n### Delete options[#](#delete-options \"Permanent link\")\n\nThe delete operation adds one new option: **Folder**. If you turn this option on, the node can delete both folders and files. This configuration also displays one more option:\n\n* **Recursive**: If you turn this option on and you delete a folder or directory, the node will delete all files and directories within the target directory.\n\n## Download[#](#download \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Path**: Enter the remote path that you would like to connect to.\n* **Put Output File in Field**: Enter the name of the output binary field to put the file in.\n\n## List[#](#list \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Path**: Enter the remote path that you would like to connect to.\n* **Recursive**: Select whether to return an object representing all directories / objects recursively found within the FTP/SFTP server (turned on) or not (turned off).\n\n## Rename[#](#rename \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Old Path**: Enter the existing path of the file you'd like to rename in this field.\n* **New Path**: Enter the new path for the renamed file in this field.\n\n### Rename options[#](#rename-options \"Permanent link\")\n\nThis operation adds one new option: **Create Directories**. If you turn this option on, the node will recursively create the destination directory when renaming an existing file or folder.\n\n## Upload[#](#upload \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Path**: Enter the remote path that you would like to connect to.\n* **Binary File**: Select whether you'll upload a binary file (turned on) or enter text content to be uploaded (turned off). Other parameters depend on your selection in this field.\n * **Input Binary Field**: Displayed if you turn on **Binary File**. Enter the name of the input binary field that contains the file you'll upload in this field.\n * **File Content**: Displayed if you turn off **Binary File** Enter the text content of the file you'll upload in this field.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.git/",
"markdown": "# Git | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.git.md \"Edit this page\")\n\n[Git](https://git-scm.com/) is a free and open-source distributed version control system designed to handle everything from small to large projects with speed and efficiency.\n\nCredentials\n\nYou can find authentication information for this node [here](https://docs.n8n.io/integrations/builtin/credentials/git/).\n\n## Operations[#](#operations \"Permanent link\")\n\n* [**Add**](#add) a file or folder to commit. Performs a [git add](https://git-scm.com/docs/git-add).\n* [**Add Config**](#add-config): Add configuration property. Performs a [git config](https://git-scm.com/docs/git-config) set or add.\n* [**Clone**](#clone) a repository: Performs a [git clone](https://git-scm.com/docs/git-clone).\n* [**Commit**](#commit) files or folders to git. Performs a [git commit](https://git-scm.com/docs/git-commit).\n* [**Fetch**](#fetch) from remote repository. Performs a [git fetch](https://git-scm.com/docs/git-fetch).\n* [**List Config**](#list-config): Return current configuration. Performs a [git config](https://git-scm.com/docs/git-config) query.\n* [**Log**](#log): Return git commit history. Performs a [git log](https://git-scm.com/docs/git-log).\n* [**Pull**](#pull) from remote repository: Performs a [git pull](https://git-scm.com/docs/git-pull).\n* [**Push**](#push) to remote repository: Performs a [git push](https://git-scm.com/docs/git-push).\n* [**Push Tags**](#push-tags) to remote repository: Performs a [git push --tags](https://git-scm.com/docs/git-push#Documentation/git-push.txt---tags).\n* Return [**Status**](#status) of current repository: Performs a [git status](https://git-scm.com/docs/git-status).\n* Create a new [**Tag**](#tag): Performs a [git tag](https://git-scm.com/docs/git-tag).\n* [**User Setup**](#user-setup): Set the user.\n\nRefer to the sections below for more details on the parameters and options for each operation.\n\n## Add[#](#add \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Paths to Add**: Enter a comma-separated list of paths of files or folders to add in this field. You can use absolute paths or relative paths from the **Repository Path**.\n\n## Add Config[#](#add-config \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Key**: Enter the name of the key to set.\n* **Value**: Enter the value of the key to set.\n\n### Add Config options[#](#add-config-options \"Permanent link\")\n\nThe add config operation adds the **Mode** option. Choose whether to **Set** or **Append** the setting in the local config.\n\n## Clone[#](#clone \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Authentication**: Select **Authenticate** to pass credentials in. Select **None** to not use authentication.\n * **Credential for Git**: If you select **Authenticate**, you must select or create credentials for the node to use. Refer to [Git credential](https://docs.n8n.io/integrations/builtin/credentials/git/) for more information.\n* **New Repository Path**: Enter the local path where you'd like to locate the cloned repository.\n* **Source Repository**: Enter the URL or path of the repository you want to clone.\n\n## Commit[#](#commit \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Message**: Enter the commit message to use in this field.\n\n### Commit options[#](#commit-options \"Permanent link\")\n\nThe commit operation adds the **Paths to Add** option. To commit all \"added\" files and folders, leave this field blank. To commit specific \"added\" files and folders, enter a comma-separated list of paths of files or folders in this field.\n\nYou can use absolute paths or relative paths from the **Repository Path**.\n\n## Fetch[#](#fetch \"Permanent link\")\n\nThis operation only prompts you to enter the local path of the git repository in the **Repository Path** parameter.\n\n## List Config[#](#list-config \"Permanent link\")\n\nThis operation only prompts you to enter the local path of the git repository in the **Repository Path** parameter.\n\n## Log[#](#log \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Return All**: When turned on, the node will return all results. When turned off, the node will return results up to the set **Limit**.\n* **Limit**: Only available when you turn off **Return All**. Enter the maximum number of results to return.\n\n### Log options[#](#log-options \"Permanent link\")\n\nThe log operation adds the **File** option. Enter the path of a file or folder to get the history of in this field.\n\nYou can use absolute paths or relative paths from the **Repository Path**.\n\n## Pull[#](#pull \"Permanent link\")\n\nThis operation only prompts you to enter the local path of the git repository in the **Repository Path** parameter.\n\n## Push[#](#push \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Authentication**: Select **Authenticate** to pass credentials in or **None** to not use authentication.\n * If you select **Authenticate**, you must select or create **Credential for Git** for the node to use. Refer to [Git credential](https://docs.n8n.io/integrations/builtin/credentials/git/) for more information.\n\n### Push options[#](#push-options \"Permanent link\")\n\nThe push operation adds the **Target Repository** option. Enter the URL or path of the repository to push to in this field.\n\nThis operation only prompts you to enter the local path of the git repository in the **Repository Path** parameter.\n\n## Status[#](#status \"Permanent link\")\n\nThis operation only prompts you to enter the local path of the git repository in the **Repository Path** parameter.\n\n## Tag[#](#tag \"Permanent link\")\n\nConfigure this operation with these parameters:\n\n* **Repository Path**: Enter the local path of the git repository.\n* **Name**: Enter the name of the tag to create in this field.\n\n## User Setup[#](#user-setup \"Permanent link\")\n\nThis operation only prompts you to enter the local path of the git repository in the **Repository Path** parameter.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.graphql/",
"markdown": "# GraphQL | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.graphql.md \"Edit this page\")\n\n[GraphQL](https://graphql.org/) is an open-source data query and manipulation language for APIs, and a runtime for fulfilling queries with existing data. Use the GraphQL node to query a GraphQL endpoint.\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\nThis node can be used as an AI tool\n\nThis node can be used to enhance the capabilities of an AI agent. When used in this way, many parameters can be set automatically, or with information directed by AI - find out more in the [AI tool parameters documentation](https://docs.n8n.io/advanced-ai/examples/using-the-fromai-function/).\n\n### Authentication[#](#authentication \"Permanent link\")\n\nSelect the type of authentication to use.\n\nIf you select anything other than **None**, the **Credential for** parameter appears for you to select an existing or create a new authentication credential for that authentication type.\n\n### HTTP Request Method[#](#http-request-method \"Permanent link\")\n\nSelect the underlying HTTP Request method the node should use. Choose from:\n\n* **GET**\n* **POST**: If you select this method, you'll also need to select the **Request Format** the node should use for the query payload. Choose from:\n * **GraphQL (Raw)**\n * **JSON**\n\n### Endpoint[#](#endpoint \"Permanent link\")\n\nEnter the GraphQL Endpoint you'd like to hit.\n\n### Ignore SSL Issues[#](#ignore-ssl-issues \"Permanent link\")\n\nWhen you turn on this control, n8n ignores SSL certificate validation failure.\n\n### Query[#](#query \"Permanent link\")\n\nEnter the GraphQL query you want to execute.\n\nRefer to [Related Resources](#related-resources) for information on writing your query.\n\n### Response Format[#](#response-format \"Permanent link\")\n\nSelect the format you'd like to receive query results in. Choose between:\n\n* **JSON**\n* **String**: If you select this format, enter a **Response Data Property Name** to define the property the string is written to.\n\nEnter any **Headers** you want to pass as part of the query as **Name** / **Value** pairs.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\nTo use the GraphQL node, you need to understand GraphQL query language. GraphQL have their own [Introduction to GraphQL](https://graphql.org/learn/) tutorial."
},
{
"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.amqp/",
"markdown": "# AMQP Sender node documentation | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/app-nodes/n8n-nodes-base.amqp.md \"Edit this page\")\n\nUse the AMQP Sender node to automate work in AMQP Sender, and integrate AMQP Sender with other applications. n8n has built-in support for a wide range of AMQP Sender features, including sending messages.\n\nOn this page, you'll find a list of operations the AMQP Sender node supports and links to more resources.\n\n## Operations[#](#operations \"Permanent link\")\n\n* Send message\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n[Browse AMQP Sender integration templates](https://n8n.io/integrations/amqp-sender/), or [search all templates](https://n8n.io/workflows/)"
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/",
"markdown": "# HTTP Request node documentation | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md \"Edit this page\")\n\nThe HTTP Request node is one of the most versatile nodes in n8n. It allows you to make HTTP requests to query data from any app or service with a REST API. You can use the HTTP Request node a regular node or attached to an [AI agent](https://docs.n8n.io/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent/) to use as a [tool](https://docs.n8n.io/advanced-ai/examples/understand-tools/).\n\nWhen using this node, you're creating a REST API call. You need some understanding of basic API terminology and concepts.\n\nThere are two ways to create an HTTP request: configure the [node parameters](#node-parameters) or [import a curl command](#import-curl-command).\n\n## Node parameters[#](#node-parameters \"Permanent link\")\n\n### Method[#](#method \"Permanent link\")\n\nSelect the method to use for the request:\n\n* DELETE\n* GET\n* HEAD\n* OPTIONS\n* PATCH\n* POST\n* PUT\n\n### URL[#](#url \"Permanent link\")\n\nEnter the endpoint you want to use.\n\n### Authentication[#](#authentication \"Permanent link\")\n\nn8n recommends using the **Predefined Credential Type** option when it's available. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.\n\n#### Predefined credentials[#](#predefined-credentials \"Permanent link\")\n\nCredentials for integrations supported by n8n, including both built-in and community nodes. Use **Predefined Credential Type** for custom operations without extra setup. Refer to [Custom API operations](https://docs.n8n.io/integrations/custom-operations/) for more information.\n\n#### Generic credentials[#](#generic-credentials \"Permanent link\")\n\nCredentials for integrations not supported by n8n. You'll need to manually configure the authentication process, including specifying the required API endpoints, necessary parameters, and the authentication method.\n\nYou can select one of the following methods:\n\n* Basic auth\n* Custom auth\n* Digest auth\n* Header auth\n* OAuth1 API\n* OAuth2 API\n* Query auth\n\nRefer to [HTTP request credentials](https://docs.n8n.io/integrations/builtin/credentials/httprequest/) for more information on setting up each credential type.\n\n### Send Query Parameters[#](#send-query-parameters \"Permanent link\")\n\nQuery parameters act as filters on HTTP requests. If the API you're interacting with supports them and the request you're making needs a filter, turn this option on.\n\n**Specify your query parameters** using one of the available options:\n\n* **Using Fields Below**: Enter **Name**/**Value** pairs of **Query Parameters**. To enter more query parameter name/value pairs, select **Add Parameter**. The name is the name of the field you're filtering on, and the value is the filter value.\n* **Using JSON**: Enter **JSON** to define your query parameters.\n\nRefer to your service's API documentation for detailed guidance.\n\nUse this parameter to send headers with your request. Headers contain metadata or context about your request.\n\n**Specify Headers** using one of the available options:\n\n* **Using Fields Below**: Enter **Name**/**Value** pairs of **Header Parameters**. To enter more header parameter name/value pairs, select **Add Parameter**. The name is the header you wish to set, and the value is the value you want to pass for that header.\n* **Using JSON**: Enter **JSON** to define your header parameters.\n\nRefer to your service's API documentation for detailed guidance.\n\n### Send Body[#](#send-body \"Permanent link\")\n\nIf you need to send a body with your API request, turn this option on.\n\nThen select the **Body Content Type** that best matches the format for the body content you wish to send.\n\n#### Form URLencoded[#](#form-urlencoded \"Permanent link\")\n\nUse this option to send your body as `application/x-www-form-urlencoded`.\n\n**Specify Body** using one of the available options:\n\n* **Using Fields Below**: Enter **Name**/**Value** pairs of **Body Parameters**. To enter more body parameter name/value pairs, select **Add Parameter**. The name should be the form field name, and the value is what you wish to set that field to.\n* **Using Single Field**: Enter your name/value pairs in a single **Body** parameter with format `fieldname1=value1&fieldname2=value2`.\n\nRefer to your service's API documentation for detailed guidance.\n\n#### Form-Data[#](#form-data \"Permanent link\")\n\nUse this option to send your body as `multipart/form-data`.\n\nConfigure your **Body Parameters** by selecting the **Parameter Type**:\n\n* Choose **Form Data** to enter **Name**/**Value** pairs.\n* Choose **n8n Binary File** to pull the body from a file the node has access to.\n * **Name**: Enter the ID of the field to set.\n * **Input Data Field Name**: Enter the name of the incoming field containing the binary file data you want to process.\n\nSelect **Add Parameter** to enter more parameters.\n\nRefer to your service's API documentation for detailed guidance.\n\n#### JSON[#](#json \"Permanent link\")\n\nUse this option to send your body as JSON.\n\n**Specify Body** using one of the available options:\n\n* **Using Fields Below**: Enter **Name**/**Value** pairs of **Body Parameters**. To enter more body parameter name/value pairs, select **Add Parameter**.\n* **Using JSON**: Enter **JSON** to define your body.\n\nRefer to your service's API documentation for detailed guidance.\n\n#### n8n Binary File[#](#n8n-binary-file \"Permanent link\")\n\nUse this option to send the contents of a file stored in n8n as the body.\n\nEnter the name of the incoming field that contains the file as the **Input Data Field Name**.\n\nRefer to your service's API documentation for detailed guidance on how to format the file.\n\n#### Raw[#](#raw \"Permanent link\")\n\nUse this option to send raw data in the body.\n\n* **Content Type**: Enter the `Content-Type` header to use for the raw body content. Refer to the IANA [Media types](https://www.iana.org/assignments/media-types/media-types.xhtml) documentation for a full list of MIME content types.\n* **Body**: Enter the raw body content to send.\n\nRefer to your service's API documentation for detailed guidance.\n\n## Node options[#](#node-options \"Permanent link\")\n\nSelect **Add Option** to view and select these options. Options are available to all parameters unless otherwise noted.\n\n### Array Format in Query Parameters[#](#array-format-in-query-parameters \"Permanent link\")\n\nOption availability\n\nThis option is only available when you turn on **Send Query Parameters**.\n\nUse this option to control the format for arrays included in query parameters. Choose from these options:\n\n* **No Brackets**: Arrays will format as the name=value for each item in the array, for example: `foo=bar&foo=qux`.\n* **Brackets Only**: The node adds square brackets after each array name, for example: `foo[]=bar&foo[]=qux`.\n* **Brackets with Indices**: The node adds square brackets with an index value after each array name, for example: `foo[0]=bar&foo[1]=qux`.\n\nRefer to your service's API documentation for guidance on which option to use.\n\n### Batching[#](#batching \"Permanent link\")\n\nControl how to batch large numbers of input items:\n\n* **Items per Batch**: Enter the number of input items to include in each batch.\n* **Batch Interval**: Enter the time to wait between each batch of requests in milliseconds. Enter 0 for no batch interval.\n\n### Ignore SSL Issues[#](#ignore-ssl-issues \"Permanent link\")\n\nBy default, n8n only downloads the response if SSL certificate validation succeeds. If you'd like to download the response even if SSL certificate validation fails, turn this option on.\n\nChoose whether to lowercase header names (turned on, default) or not (turned off).\n\n### Redirects[#](#redirects \"Permanent link\")\n\nChoose whether to follow redirects (turned on by default) or not (turned off). If turned on, enter the maximum number of redirects the request should follow in **Max Redirects**.\n\n### Response[#](#response \"Permanent link\")\n\nUse this option to set some details about the expected API response, including:\n\n* **Include Response Headers and Status**: By default, the node returns only the body. Turn this option on to return the full response (headers and response status code) as well as the body.\n* **Never Error**: By default, the node returns success only when the response returns with a 2xx code. Turn this option on to return success regardless of the code returned.\n* **Response Format**: Select the format in which the data gets returned. Choose from:\n * **Autodetect** (default): The node detects and formats the response based on the data returned.\n * **File**: Select this option to put the response into a file. Enter the field name where you want the file returned in **Put Output in Field**.\n * **JSON**: Select this option to format the response as JSON.\n * **Text**: Select this option to format the response as plain text. Enter the field name where you want the file returned in **Put Output in Field**.\n\nUse this option to paginate results, useful for handling query results that are too big for the API to return in a single call.\n\nInspect the API data first\n\nSome options for pagination require knowledge of the data returned by the API you're using. Before setting up pagination, either check the API documentation, or do an API call without pagination, to see the data it returns.\n\nUnderstand pagination\n\nPagination means splitting a large set of data into multiple pages. The amount of data on each page depends on the limit you set.\n\nFor example, you make an API call to an endpoint called `/users`. The API wants to send back information on 300 users, but this is too much data for the API to send in one response.\n\nIf the API supports pagination, you can incrementally fetch the data. To do this, you call `/users` with a pagination limit, and a page number or URL to tell the API which page to send. In this example, say you use a limit of 10, and start from page 0. The API sends the first 10 users in its response. You then call the API again, increasing the page number by 1, to get the next 10 results.\n\nConfigure the pagination settings:\n\n* **Pagination Mode**:\n * **Off**: Turn off pagination.\n * **Update a Parameter in Each Request**: Use this when you need to dynamically set parameters for each request.\n * **Response Contains Next URL**: Use this when the API response includes the URL of the next page. Use an expression to set **Next URL**.\n\nFor example setups, refer to [HTTP Request node cookbook | Pagination](https://docs.n8n.io/code/cookbook/http-node/pagination/).\n\nn8n provides built-in variables for working with HTTP node requests and responses when using pagination:\n\n| Variable | Description |\n| --- | --- |\n| `$pageCount` | The pagination count. Tracks how many pages the node has fetched. |\n| `$request` | The request object sent by the HTTP node. |\n| `$response` | The response object from the HTTP call. Includes `$response.body`, `$response.headers`, and `$response.statusCode`. The contents of `body` and `headers` depend on the data sent by the API. |\n\nAPI differences\n\nDifferent APIs implement pagination in different ways. Check the API documentation for the API you're using for details. You need to find out things like:\n\n* Does the API provide the URL for the next page?\n* Are there API-specific limits on page size or page number?\n* The structure of the data that the API returns.\n\n### Proxy[#](#proxy \"Permanent link\")\n\nUse this option if you need to specify an HTTP proxy.\n\nEnter the **Proxy** the request should use. This takes precedence over global settings defined with the [`HTTP_PROXY`, `HTTPS_PROXY`, or `ALL_PROXY` environment variables](https://docs.n8n.io/hosting/configuration/environment-variables/deployment/).\n\n### Timeout[#](#timeout \"Permanent link\")\n\nUse this option to set how long the node should wait for the server to send response headers (and start the response body). The node aborts requests that exceed this value for the initial response.\n\nEnter the **Timeout** time to wait in milliseconds.\n\nThe following options are only available when attached to an [AI agent](https://docs.n8n.io/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent/) as a [tool](https://docs.n8n.io/advanced-ai/examples/understand-tools/).\n\n### Optimize Response[#](#optimize-response \"Permanent link\")\n\nWhether to optimize the tool response to reduce the amount of data passed to the LLM. Optimizing the response can reduce costs and can help the LLM ignore unimportant details, often leading to better results.\n\nWhen optimizing responses, you select an expected response type, which determines other options you can configure. The supported response types are:\n\n#### JSON[#](#json_1 \"Permanent link\")\n\nWhen expecting a **JSON** response, you can configure which parts of the JSON data to use as a response with the following choices:\n\n* **Field Containing Data**: This field identifies a specific part of the JSON object that contains your relevant data. You can leave this blank to use the entire response.\n* **Include Fields**: This is how you choose which fields you want in your response object. There are three choices:\n * **All**: Include all fields in the response object.\n * **Selected**: Include only the fields specified below.\n * **Fields**: A comma-separated list of fields to include in the response. You can use dot notation to specify nested fields. You can drag fields from the Input panel to add them to the field list.\n * **Exclude**: Include all fields _except_ the fields specified below.\n * **Fields**: A comma-separated list of fields to exclude from the response. You can use dot notation to specify nested fields. You can drag fields from the Input panel to add them to the field list.\n\n#### HTML[#](#html \"Permanent link\")\n\nWhen expecting **HTML**, you can identify the part of an HTML document relevant to the LLM and optimize the response with the following options:\n\n* **Selector (CSS)**: A specific element or element type to include in the response HTML. Uses the `body` element by default.\n* **Return Only Content**: Whether to strip HTML tags and attributes from the response, leaving only the actual content. This uses fewer tokens and may be easier for the model to understand.\n * **Elements To Omit**: A comma-separated list of CSS selectors to exclude when extracting content.\n* **Truncate Response**: Whether to limit the response size to save tokens.\n * **Max Response Characters**: The maximum number of characters to include in the HTML response. The default value is 1000.\n\n#### Text[#](#text \"Permanent link\")\n\nWhen expecting a generic **Text** response, you can optimize the results with the following options:\n\n* **Truncate Response**: Whether to limit the response size to save tokens.\n * **Max Response Characters**: The maximum number of characters to include in the HTML response. The default value is 1000.\n\n## Import curl command[#](#import-curl-command \"Permanent link\")\n\n[curl](https://curl.se/) is a command line tool and library for transferring data with URLs.\n\nYou can use curl to call REST APIs. If the API documentation of the service you want to use provides curl examples, you can copy them out of the documentation and into n8n to configure the HTTP Request node.\n\nImport a curl command:\n\n1. From the HTTP Request node's **Parameters** tab, select **Import cURL**. The **Import cURL command** modal opens.\n2. Paste your curl command into the text box.\n3. Select **Import**. n8n loads the request configuration into the node fields. This overwrites any existing configuration.\n\n## Templates and examples[#](#templates-and-examples \"Permanent link\")\n\n## Common issues[#](#common-issues \"Permanent link\")\n\nFor common questions or issues and suggested solutions, refer to [Common Issues](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/common-issues/)."
},
{
"url": "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.html/",
"markdown": "# HTML | n8n Docs\n\n[](https://github.com/n8n-io/n8n-docs/edit/main/docs/integrations/builtin/core-nodes/n8n-nodes-base.html.md \"Edit this page\")\n\nThe HTML node provides operations to help you work with HTML in n8n.\n\nHTML Extract node\n\nThe HTML node replaces the HTML Extract node from version 0.213.0 on. If you're using an older version of n8n, you can still view the [HTML Extract node documentation](https://github.com/n8n-io/n8n-docs/blob/86fe33b681621e618e3adcab9a27e8605dbc23ad/docs/integrations/builtin/core-nodes/n8n-nodes-base.htmlextract.md).\n\nCross-site scripting\n\nWhen using the HTML node to generate an HTML template you can introduce [XSS (cross-site scripting)](https://owasp.org/www-community/attacks/xss/). This is a security risk. Be careful with un-trusted inputs.\n\n## Operations[#](#operations \"Permanent link\")\n\n* [**Generate HTML template**](#generate-html-template): Use this operation to create an HTML template. This allows you to take data from your workflow and output it as HTML.\n* [**Extract HTML content**](#extract-html-content): Extract contents from an HTML-formatted source. The source can be in JSON or a binary file (`.html`).\n* [**Convert to HTML Table**](#convert-to-html-table): Convert content to an HTML table.\n\nThe node parameters and options depend on the operation you select. Refer to the sections below for more details on configuring each operation.\n\n## Generate HTML template[#](#generate-html-template \"Permanent link\")\n\nCreate an HTML template. This allows you to take data from your workflow and output it as HTML.\n\nYou can include:\n\n* Standard HTML\n* CSS in `