diff --git a/all_workflow_examples.json b/all_workflow_examples.json new file mode 100644 index 00000000000..baa01fbad79 --- /dev/null +++ b/all_workflow_examples.json @@ -0,0 +1,6366 @@ + + +// docs/_workflows/try-it-out/quickstart/tutorial.json +{ + "name": "Tutorial-workflow", + "nodes": [ + { + "parameters": { + "rule": { + "interval": [ + { + "field": "weeks", + "triggerAtDay": [ + 1 + ], + "triggerAtHour": 9 + } + ] + } + }, + "type": "n8n-nodes-base.scheduleTrigger", + "typeVersion": 1.2, + "position": [ + -680, + 100 + ], + "id": "ef14445c-2f5f-4c78-96c8-66732feb7a8f", + "name": "Schedule Trigger" + }, + { + "parameters": { + "resource": "donkiSolarFlare", + "additionalFields": { + "startDate": "={{ $today.minus(7, 'days') }}" + } + }, + "type": "n8n-nodes-base.nasa", + "typeVersion": 1, + "position": [ + -460, + 100 + ], + "id": "52c58b93-c780-4aff-a216-d67b28195a45", + "name": "NASA", + "credentials": { + "nasaApi": { + "id": "sSVnxV9AcBmBOYn8", + "name": "NASA account" + } + } + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "2f469c8e-12b3-4ee5-95fc-ff81508d0b43", + "leftValue": "={{ $json.classType }}", + "rightValue": "C", + "operator": { + "type": "string", + "operation": "contains" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "type": "n8n-nodes-base.if", + "typeVersion": 2.2, + "position": [ + -240, + 100 + ], + "id": "b54e3289-9ebb-451f-8bac-87edeeeced13", + "name": "If" + }, + { + "parameters": { + "resource": "request", + "operation": "send", + "binId": "1741914338605-0907339996192", + "binContent": "=There was a solar flare of class {{$json[\"classType\"]}}", + "requestOptions": {} + }, + "type": "n8n-nodes-base.postBin", + "typeVersion": 1, + "position": [ + -20, + 0 + ], + "id": "a8b602b6-17b1-4274-8d33-73344b6bb8fb", + "name": "PostBin(true)" + }, + { + "parameters": { + "resource": "request", + "operation": "send", + "binId": "1741914338605-0907339996192", + "binContent": "=There was a solar flare of class {{$json[\"classType\"]}}", + "requestOptions": {} + }, + "type": "n8n-nodes-base.postBin", + "typeVersion": 1, + "position": [ + -20, + 200 + ], + "id": "09c2c7a4-c229-430d-a5b0-8d7491515d9f", + "name": "PostBin(false)" + }, + { + "parameters": { + "content": "## Setup required\n\nYou need to create a NASA account and create credentials, and create a bin with Postbin and enter the ID - see [the documentation](https://docs.n8n.io/try-it-out/longer-introduction/)", + "height": 120, + "width": 600 + }, + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -720, + -60 + ], + "id": "08e0b8f9-c90e-4c9c-a663-01aca805b9be", + "name": "Sticky Note" + } + ], + "pinData": {}, + "connections": { + "Schedule Trigger": { + "main": [ + [ + { + "node": "NASA", + "type": "main", + "index": 0 + } + ] + ] + }, + "NASA": { + "main": [ + [ + { + "node": "If", + "type": "main", + "index": 0 + } + ] + ] + }, + "If": { + "main": [ + [ + { + "node": "PostBin(true)", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "PostBin(false)", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "37de4877-e4f6-4b9a-b6f0-9b7e7aea0163", + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "id": "DPzMzTIyDrYohiw4", + "tags": [ + { + "createdAt": "2021-06-25T07:47:07.640Z", + "updatedAt": "2021-06-25T07:47:07.640Z", + "id": "1", + "name": "docs" + } + ] +} + +// docs/_workflows/try-it-out/quickstart/very-quick-quickstart-workflow.json +{ + "nodes": [ + { + "parameters": { + "operation": "getAllPeople", + "returnAll": true + }, + "id": "ed1fd9cd-cc4f-4e0e-ba73-9f842db382c3", + "name": "Customer Datastore", + "type": "n8n-nodes-base.n8nTrainingCustomerDatastore", + "position": [ + 540, + 280 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**Get fake sample data**", + "height": 300, + "width": 220 + }, + "id": "5ddf393f-62b8-4240-adf8-f9a8f539df4b", + "name": "Note1", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 480, + 180 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**Extract data and prepare it for use in the next node**", + "height": 300, + "width": 220 + }, + "id": "6ad194ea-9821-40eb-ae2c-f50cc030300b", + "name": "Note2", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 760, + 180 + ], + "typeVersion": 1 + }, + { + "parameters": {}, + "id": "5af4b83b-31b6-4c29-aa55-3449f3851e2a", + "name": "When clicking \"Test Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "position": [ + 300, + 280 + ], + "typeVersion": 1 + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "df041e3c-fc09-4ba2-8e6b-37f2c6a02526", + "name": "customer_id", + "type": "string", + "value": "={{ $json.id }}" + }, + { + "id": "bf288953-4fef-4f55-a45f-c223714919c0", + "name": "customer_name", + "type": "string", + "value": "={{ $json.name }}" + }, + { + "id": "1cff0b21-6740-4697-9d2c-9bcb045af0be", + "name": "customer_description", + "type": "string", + "value": "={{ $json.notes }}" + } + ] + }, + "options": {} + }, + "id": "5dcd5776-5137-4f97-8b76-9f38e1d9ff9e", + "name": "Edit Fields1", + "type": "n8n-nodes-base.set", + "position": [ + 820, + 280 + ], + "typeVersion": 3.3 + }, + { + "parameters": { + "customerId": "={{ $json.customer_id }}", + "message": "=Hi {{ $json.customer_name }}. Your description is: {{ $json.customer_description }}" + }, + "type": "n8n-nodes-base.n8nTrainingCustomerMessenger", + "typeVersion": 1, + "position": [ + 1040, + 280 + ], + "id": "a726dcfd-f491-440f-ad64-6ba17472352f", + "name": "Customer Messenger (n8n training)" + } + ], + "connections": { + "Customer Datastore": { + "main": [ + [ + { + "node": "Edit Fields1", + "type": "main", + "index": 0 + } + ] + ] + }, + "When clicking \"Test Workflow\"": { + "main": [ + [ + { + "node": "Customer Datastore", + "type": "main", + "index": 0 + } + ] + ] + }, + "Edit Fields1": { + "main": [ + [ + { + "node": "Customer Messenger (n8n training)", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + } +} + + +// docs/_workflows/courses/level-one/chapter-2.json +{ + "nodes": [ + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 0, + 0 + ], + "id": "5738d1d8-ae7d-4e04-bca4-885c59e1d9e8", + "name": "When clicking ‘Execute workflow’" + }, + { + "parameters": { + "resource": "all", + "limit": 10, + "additionalFields": { + "keyword": "automation" + } + }, + "type": "n8n-nodes-base.hackerNews", + "typeVersion": 1, + "position": [ + 220, + 0 + ], + "id": "65e9d0a6-5261-4c7d-8d85-6ff49de04dee", + "name": "Hacker News", + "notesInFlow": true, + "notes": "Get the 10 latest articles." + } + ], + "connections": { + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "Hacker News", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/finished.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "4d259ec5241587a0d2820670fc048f0d" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 220, + -40 + ], + "id": "e1fb70b3-0212-4e78-9976-cb77c69f1a92", + "name": "HTTP Request", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": { + "operation": "create", + "base": { + "__rl": true, + "value": "app9nOVsRxdypoknP", + "mode": "list", + "cachedResultName": "beginner course" + }, + "table": { + "__rl": true, + "value": "tblTIOsm4BLJD9Tql", + "mode": "list", + "cachedResultName": "processingOrders" + }, + "columns": { + "mappingMode": "autoMapInputData", + "value": {}, + "matchingColumns": [], + "schema": [ + { + "id": "orderID", + "displayName": "orderID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "employeeName", + "displayName": "employeeName", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + } + ], + "attemptToConvertTypes": false, + "convertFieldsToString": false + }, + "options": {} + }, + "type": "n8n-nodes-base.airtable", + "typeVersion": 2.1, + "position": [ + 880, + -140 + ], + "id": "5cef2ef7-98a6-4dc6-bc30-667eba06fd7b", + "name": "Airtable", + "credentials": { + "airtableTokenApi": { + "id": "UT32NHUYnp4pn1H3", + "name": "Airtable Personal Access Token account" + } + } + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "526cb30c-0f90-4f66-8f98-b64ceb2e52f2", + "leftValue": "={{ $json.orderStatus }}", + "rightValue": "processing", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "type": "n8n-nodes-base.if", + "typeVersion": 2.2, + "position": [ + 440, + -40 + ], + "id": "448b2e3c-569d-42e6-a4b9-57c08b2cac1a", + "name": "If" + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "20d37948-763a-4d7b-b725-e65f3802af03", + "name": "orderID", + "value": "={{ $json.orderID }}", + "type": "number" + }, + { + "id": "9df108a7-6b13-42ab-a6dd-9ca582ba8b49", + "name": "employeeName", + "value": "={{ $json.employeeName }}", + "type": "string" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.set", + "typeVersion": 3.4, + "position": [ + 660, + -140 + ], + "id": "7e2a8092-fb0f-4260-84e8-d796cf14d309", + "name": "Edit Fields" + }, + { + "parameters": { + "jsCode": "let items = $input.all();\nlet totalBooked = items.length;\nlet bookedSum = 0;\n\nfor (let i=0; i < items.length; i++) {\n bookedSum = bookedSum + items[i].json.orderPrice;\n}\n\nreturn [{ json: {totalBooked, bookedSum} }];" + }, + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 660, + 60 + ], + "id": "26ce1d53-794b-4457-9aa8-0ecf9093b838", + "name": "Code" + }, + { + "parameters": { + "authentication": "webhook", + "content": "=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\"] }}", + "options": {} + }, + "type": "n8n-nodes-base.discord", + "typeVersion": 2, + "position": [ + 880, + 60 + ], + "id": "d8c0b4b6-3bf1-4055-a03f-f0023337777c", + "name": "Discord", + "webhookId": "eff0b651-f0be-4cae-8f18-7d831385be3c", + "credentials": { + "discordWebhookApi": { + "id": "lOieo0mIb6h1Wi9R", + "name": "Discord Webhook account" + } + } + }, + { + "parameters": { + "rule": { + "interval": [ + { + "field": "weeks", + "triggerAtDay": [ + 1 + ], + "triggerAtHour": 9 + } + ] + } + }, + "type": "n8n-nodes-base.scheduleTrigger", + "typeVersion": 1.2, + "position": [ + 0, + -40 + ], + "id": "15f0b179-6a43-483b-a522-2b8ba834b795", + "name": "Schedule Trigger" + } + ], + "connections": { + "HTTP Request": { + "main": [ + [ + { + "node": "If", + "type": "main", + "index": 0 + } + ] + ] + }, + "If": { + "main": [ + [ + { + "node": "Edit Fields", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + }, + "Edit Fields": { + "main": [ + [ + { + "node": "Airtable", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code": { + "main": [ + [ + { + "node": "Discord", + "type": "main", + "index": 0 + } + ] + ] + }, + "Schedule Trigger": { + "main": [ + [ + { + "node": "HTTP Request", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/chapter-5/chapter-5.1.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 340, + -680 + ], + "id": "ada6becf-c320-41a7-bdca-a842ea3ee769", + "name": "HTTP Request1", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 140, + -680 + ], + "id": "ffa1a8ce-1a1e-48c4-8a0d-6af28c0447a5", + "name": "When clicking ‘Execute workflow’" + } + ], + "connections": { + "HTTP Request1": { + "main": [ + [] + ] + }, + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "HTTP Request1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/chapter-5/chapter-5.2.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 340, + -680 + ], + "id": "ada6becf-c320-41a7-bdca-a842ea3ee769", + "name": "HTTP Request1", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": { + "operation": "create", + "base": { + "__rl": true, + "value": "app9nOVsRxdypoknP", + "mode": "list", + "cachedResultName": "beginner course" + }, + "table": { + "__rl": true, + "value": "tblo2KuMyn5X4jU0s", + "mode": "list", + "cachedResultName": "orders" + }, + "columns": { + "mappingMode": "autoMapInputData", + "value": {}, + "matchingColumns": [], + "schema": [ + { + "id": "orderID", + "displayName": "orderID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "customerID", + "displayName": "customerID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "employeeName", + "displayName": "employeeName", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + }, + { + "id": "orderPrice", + "displayName": "orderPrice", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "orderStatus", + "displayName": "orderStatus", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + } + ], + "attemptToConvertTypes": false, + "convertFieldsToString": false + }, + "options": {} + }, + "type": "n8n-nodes-base.airtable", + "typeVersion": 2.1, + "position": [ + 560, + -680 + ], + "id": "5e60ca72-d773-439c-b39a-4b14c54f795b", + "name": "Airtable1", + "credentials": { + "airtableTokenApi": { + "id": "UT32NHUYnp4pn1H3", + "name": "Airtable Personal Access Token account" + } + } + }, + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 140, + -680 + ], + "id": "ffa1a8ce-1a1e-48c4-8a0d-6af28c0447a5", + "name": "When clicking ‘Execute workflow’" + } + ], + "connections": { + "HTTP Request1": { + "main": [ + [ + { + "node": "Airtable1", + "type": "main", + "index": 0 + } + ] + ] + }, + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "HTTP Request1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/chapter-5/chapter-5.3.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 340, + -680 + ], + "id": "ada6becf-c320-41a7-bdca-a842ea3ee769", + "name": "HTTP Request1", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": { + "operation": "create", + "base": { + "__rl": true, + "value": "app9nOVsRxdypoknP", + "mode": "list", + "cachedResultName": "beginner course" + }, + "table": { + "__rl": true, + "value": "tblo2KuMyn5X4jU0s", + "mode": "list", + "cachedResultName": "orders" + }, + "columns": { + "mappingMode": "autoMapInputData", + "value": {}, + "matchingColumns": [], + "schema": [ + { + "id": "orderID", + "displayName": "orderID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "customerID", + "displayName": "customerID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "employeeName", + "displayName": "employeeName", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + }, + { + "id": "orderPrice", + "displayName": "orderPrice", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "orderStatus", + "displayName": "orderStatus", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + } + ], + "attemptToConvertTypes": false, + "convertFieldsToString": false + }, + "options": {} + }, + "type": "n8n-nodes-base.airtable", + "typeVersion": 2.1, + "position": [ + 800, + -680 + ], + "id": "5e60ca72-d773-439c-b39a-4b14c54f795b", + "name": "Airtable1", + "credentials": { + "airtableTokenApi": { + "id": "UT32NHUYnp4pn1H3", + "name": "Airtable Personal Access Token account" + } + } + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "526cb30c-0f90-4f66-8f98-b64ceb2e52f2", + "leftValue": "={{ $json.orderStatus }}", + "rightValue": "processing", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "type": "n8n-nodes-base.if", + "typeVersion": 2.2, + "position": [ + 540, + -680 + ], + "id": "70e4db65-f827-4e4f-8673-b405b7986d6e", + "name": "If1" + }, + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 140, + -680 + ], + "id": "ffa1a8ce-1a1e-48c4-8a0d-6af28c0447a5", + "name": "When clicking ‘Execute workflow’" + } + ], + "connections": { + "HTTP Request1": { + "main": [ + [ + { + "node": "If1", + "type": "main", + "index": 0 + } + ] + ] + }, + "If1": { + "main": [ + [ + { + "node": "Airtable1", + "type": "main", + "index": 0 + } + ], + [] + ] + }, + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "HTTP Request1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/chapter-5/chapter-5.4.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 300, + -520 + ], + "id": "ada6becf-c320-41a7-bdca-a842ea3ee769", + "name": "HTTP Request1", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": { + "operation": "create", + "base": { + "__rl": true, + "value": "app9nOVsRxdypoknP", + "mode": "list", + "cachedResultName": "beginner course" + }, + "table": { + "__rl": true, + "value": "tblTIOsm4BLJD9Tql", + "mode": "list", + "cachedResultName": "processingOrders" + }, + "columns": { + "mappingMode": "autoMapInputData", + "value": {}, + "matchingColumns": [], + "schema": [ + { + "id": "orderID", + "displayName": "orderID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "employeeName", + "displayName": "employeeName", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + } + ], + "attemptToConvertTypes": false, + "convertFieldsToString": false + }, + "options": {} + }, + "type": "n8n-nodes-base.airtable", + "typeVersion": 2.1, + "position": [ + 1020, + -600 + ], + "id": "5e60ca72-d773-439c-b39a-4b14c54f795b", + "name": "Airtable1", + "credentials": { + "airtableTokenApi": { + "id": "UT32NHUYnp4pn1H3", + "name": "Airtable Personal Access Token account" + } + } + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "526cb30c-0f90-4f66-8f98-b64ceb2e52f2", + "leftValue": "={{ $json.orderStatus }}", + "rightValue": "processing", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "type": "n8n-nodes-base.if", + "typeVersion": 2.2, + "position": [ + 520, + -520 + ], + "id": "70e4db65-f827-4e4f-8673-b405b7986d6e", + "name": "If1" + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "20d37948-763a-4d7b-b725-e65f3802af03", + "name": "orderID", + "value": "={{ $json.orderID }}", + "type": "number" + }, + { + "id": "9df108a7-6b13-42ab-a6dd-9ca582ba8b49", + "name": "employeeName", + "value": "={{ $json.employeeName }}", + "type": "string" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.set", + "typeVersion": 3.4, + "position": [ + 800, + -600 + ], + "id": "a3d3dc53-32f1-4f44-bf95-50bc5450d601", + "name": "Edit Fields1" + }, + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 80, + -520 + ], + "id": "ffa1a8ce-1a1e-48c4-8a0d-6af28c0447a5", + "name": "When clicking ‘Execute workflow’" + } + ], + "connections": { + "HTTP Request1": { + "main": [ + [ + { + "node": "If1", + "type": "main", + "index": 0 + } + ] + ] + }, + "If1": { + "main": [ + [ + { + "node": "Edit Fields1", + "type": "main", + "index": 0 + } + ], + [] + ] + }, + "Edit Fields1": { + "main": [ + [ + { + "node": "Airtable1", + "type": "main", + "index": 0 + } + ] + ] + }, + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "HTTP Request1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/chapter-5/chapter-5.5.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 300, + -520 + ], + "id": "ada6becf-c320-41a7-bdca-a842ea3ee769", + "name": "HTTP Request1", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": { + "operation": "create", + "base": { + "__rl": true, + "value": "app9nOVsRxdypoknP", + "mode": "list", + "cachedResultName": "beginner course" + }, + "table": { + "__rl": true, + "value": "tblTIOsm4BLJD9Tql", + "mode": "list", + "cachedResultName": "processingOrders" + }, + "columns": { + "mappingMode": "autoMapInputData", + "value": {}, + "matchingColumns": [], + "schema": [ + { + "id": "orderID", + "displayName": "orderID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "employeeName", + "displayName": "employeeName", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + } + ], + "attemptToConvertTypes": false, + "convertFieldsToString": false + }, + "options": {} + }, + "type": "n8n-nodes-base.airtable", + "typeVersion": 2.1, + "position": [ + 1020, + -600 + ], + "id": "5e60ca72-d773-439c-b39a-4b14c54f795b", + "name": "Airtable1", + "credentials": { + "airtableTokenApi": { + "id": "UT32NHUYnp4pn1H3", + "name": "Airtable Personal Access Token account" + } + } + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "526cb30c-0f90-4f66-8f98-b64ceb2e52f2", + "leftValue": "={{ $json.orderStatus }}", + "rightValue": "processing", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "type": "n8n-nodes-base.if", + "typeVersion": 2.2, + "position": [ + 520, + -520 + ], + "id": "70e4db65-f827-4e4f-8673-b405b7986d6e", + "name": "If1" + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "20d37948-763a-4d7b-b725-e65f3802af03", + "name": "orderID", + "value": "={{ $json.orderID }}", + "type": "number" + }, + { + "id": "9df108a7-6b13-42ab-a6dd-9ca582ba8b49", + "name": "employeeName", + "value": "={{ $json.employeeName }}", + "type": "string" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.set", + "typeVersion": 3.4, + "position": [ + 800, + -600 + ], + "id": "a3d3dc53-32f1-4f44-bf95-50bc5450d601", + "name": "Edit Fields1" + }, + { + "parameters": { + "jsCode": "let items = $input.all();\nlet totalBooked = items.length;\nlet bookedSum = 0;\n\nfor (let i=0; i < items.length; i++) {\n bookedSum = bookedSum + items[i].json.orderPrice;\n}\n\nreturn [{ json: {totalBooked, bookedSum} }];" + }, + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 760, + -420 + ], + "id": "d24ea5e9-c9e6-4d06-b6ee-8db1abd42bc0", + "name": "Code1" + }, + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 80, + -520 + ], + "id": "ffa1a8ce-1a1e-48c4-8a0d-6af28c0447a5", + "name": "When clicking ‘Execute workflow’" + } + ], + "connections": { + "HTTP Request1": { + "main": [ + [ + { + "node": "If1", + "type": "main", + "index": 0 + } + ] + ] + }, + "If1": { + "main": [ + [ + { + "node": "Edit Fields1", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Code1", + "type": "main", + "index": 0 + } + ] + ] + }, + "Edit Fields1": { + "main": [ + [ + { + "node": "Airtable1", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code1": { + "main": [ + [] + ] + }, + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "HTTP Request1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/courses/level-one/chapter-5/chapter-5.6.json +{ + "nodes": [ + { + "parameters": { + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "authentication": "genericCredentialType", + "genericAuthType": "httpHeaderAuth", + "sendHeaders": true, + "headerParameters": { + "parameters": [ + { + "name": "unique_id", + "value": "" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + 300, + -520 + ], + "id": "ada6becf-c320-41a7-bdca-a842ea3ee769", + "name": "HTTP Request1", + "credentials": { + "httpHeaderAuth": { + "id": "sMuanZ4xGobAurzY", + "name": "Nathan's ABCorp data warehouse account" + } + } + }, + { + "parameters": { + "operation": "create", + "base": { + "__rl": true, + "value": "app9nOVsRxdypoknP", + "mode": "list", + "cachedResultName": "beginner course" + }, + "table": { + "__rl": true, + "value": "tblTIOsm4BLJD9Tql", + "mode": "list", + "cachedResultName": "processingOrders" + }, + "columns": { + "mappingMode": "autoMapInputData", + "value": {}, + "matchingColumns": [], + "schema": [ + { + "id": "orderID", + "displayName": "orderID", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "number", + "readOnly": false, + "removed": false + }, + { + "id": "employeeName", + "displayName": "employeeName", + "required": false, + "defaultMatch": false, + "canBeUsedToMatch": true, + "display": true, + "type": "string", + "readOnly": false, + "removed": false + } + ], + "attemptToConvertTypes": false, + "convertFieldsToString": false + }, + "options": {} + }, + "type": "n8n-nodes-base.airtable", + "typeVersion": 2.1, + "position": [ + 1020, + -600 + ], + "id": "5e60ca72-d773-439c-b39a-4b14c54f795b", + "name": "Airtable1", + "credentials": { + "airtableTokenApi": { + "id": "UT32NHUYnp4pn1H3", + "name": "Airtable Personal Access Token account" + } + } + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "526cb30c-0f90-4f66-8f98-b64ceb2e52f2", + "leftValue": "={{ $json.orderStatus }}", + "rightValue": "processing", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "type": "n8n-nodes-base.if", + "typeVersion": 2.2, + "position": [ + 520, + -520 + ], + "id": "70e4db65-f827-4e4f-8673-b405b7986d6e", + "name": "If1" + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "20d37948-763a-4d7b-b725-e65f3802af03", + "name": "orderID", + "value": "={{ $json.orderID }}", + "type": "number" + }, + { + "id": "9df108a7-6b13-42ab-a6dd-9ca582ba8b49", + "name": "employeeName", + "value": "={{ $json.employeeName }}", + "type": "string" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.set", + "typeVersion": 3.4, + "position": [ + 800, + -600 + ], + "id": "a3d3dc53-32f1-4f44-bf95-50bc5450d601", + "name": "Edit Fields1" + }, + { + "parameters": { + "jsCode": "let items = $input.all();\nlet totalBooked = items.length;\nlet bookedSum = 0;\n\nfor (let i=0; i < items.length; i++) {\n bookedSum = bookedSum + items[i].json.orderPrice;\n}\n\nreturn [{ json: {totalBooked, bookedSum} }];" + }, + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 760, + -420 + ], + "id": "d24ea5e9-c9e6-4d06-b6ee-8db1abd42bc0", + "name": "Code1" + }, + { + "parameters": { + "authentication": "webhook", + "content": "=This week we've {{$json[\"totalBooked\"]}} booked orders with a total value of {{$json[\"bookedSum\"]}}. My Unique ID: {{ $('HTTP Request1').params[\"headerParameters\"][\"parameters\"][0][\"value\"] }}", + "options": {} + }, + "type": "n8n-nodes-base.discord", + "typeVersion": 2, + "position": [ + 1000, + -420 + ], + "id": "ed380465-c655-4c38-8eb3-2008b9e7869f", + "name": "Discord1", + "webhookId": "eff0b651-f0be-4cae-8f18-7d831385be3c", + "credentials": { + "discordWebhookApi": { + "id": "lOieo0mIb6h1Wi9R", + "name": "Discord Webhook account" + } + } + }, + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 80, + -520 + ], + "id": "ffa1a8ce-1a1e-48c4-8a0d-6af28c0447a5", + "name": "When clicking ‘Execute workflow’" + } + ], + "connections": { + "HTTP Request1": { + "main": [ + [ + { + "node": "If1", + "type": "main", + "index": 0 + } + ] + ] + }, + "If1": { + "main": [ + [ + { + "node": "Edit Fields1", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Code1", + "type": "main", + "index": 0 + } + ] + ] + }, + "Edit Fields1": { + "main": [ + [ + { + "node": "Airtable1", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code1": { + "main": [ + [ + { + "node": "Discord1", + "type": "main", + "index": 0 + } + ] + ] + }, + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "HTTP Request1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "24789c4d5aa56ca018d140332e7a43fd37dd7af0409453314fff12dc1aeebfa8" + } +} + + +// docs/_workflows/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches/rss-feed-example.json +{ + "nodes": [ + { + "parameters": {}, + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 0, + 0 + ], + "id": "e6e1cfe6-eff1-48bd-b21c-6ba83d4244d9", + "name": "When clicking ‘Execute workflow’" + }, + { + "parameters": { + "jsCode": "return [\n\t{\n\t\tjson: {\n\t\t\turl: 'https://medium.com/feed/n8n-io',\n\t\t}\n\t},\n\t{\n\t\tjson: {\n\t\t\turl: 'https://dev.to/feed/n8n',\n\t\t}\n\t}\n];" + }, + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 220, + 0 + ], + "id": "137f1128-45b6-4bc4-a9fb-8660baa652a9", + "name": "Code" + }, + { + "parameters": { + "options": {} + }, + "type": "n8n-nodes-base.splitInBatches", + "typeVersion": 3, + "position": [ + 440, + 0 + ], + "id": "3449a953-49c2-4a36-ba3d-cbc0573f3f6c", + "name": "Loop Over Items" + }, + { + "parameters": { + "url": "={{ $json.url }}", + "options": {} + }, + "type": "n8n-nodes-base.rssFeedRead", + "typeVersion": 1.1, + "position": [ + 660, + 100 + ], + "id": "cc2e59d7-0a9b-4640-8052-d8f7f8d8c9fe", + "name": "RSS Read" + } + ], + "connections": { + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code": { + "main": [ + [ + { + "node": "Loop Over Items", + "type": "main", + "index": 0 + } + ] + ] + }, + "Loop Over Items": { + "main": [ + [], + [ + { + "node": "RSS Read", + "type": "main", + "index": 0 + } + ] + ] + }, + "RSS Read": { + "main": [ + [ + { + "node": "Loop Over Items", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {}, + "meta": { + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + } +} + + +// docs/_workflows/integrations/builtin/core-nodes/n8n-nodes-base.form/multiple-branch-execution.json +{ + "name": "Form that can execute multiple branches", + "nodes": [ + { + "parameters": { + "formTitle": "Form that may execute multiple branches", + "formDescription": "This form contains multiple branches. Depending on the user's responses, more than one branch may execute sequentially.", + "formFields": { + "values": [ + { + "fieldLabel": "What are your favorite film genres", + "fieldType": "dropdown", + "fieldOptions": { + "values": [ + { + "option": "Documentary" + }, + { + "option": "Action" + }, + { + "option": "Romance" + }, + { + "option": "Comedy" + }, + { + "option": "Drama" + } + ] + }, + "multiselect": true, + "requiredField": true + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.formTrigger", + "typeVersion": 2.2, + "position": [ + -300, + 60 + ], + "id": "ad3f0e0a-a1e9-4504-8711-508bd29bd745", + "name": "On form submission", + "webhookId": "b3e1c86f-ae45-421e-9045-f19873b7a73e" + }, + { + "parameters": { + "rules": { + "values": [ + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "e3d995dd-d555-4e7a-b744-a3434ed602ad", + "leftValue": "={{ $json['What are your favorite film genres'] }}", + "rightValue": "Documentary", + "operator": { + "type": "array", + "operation": "contains", + "rightType": "any" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Documentary" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "ae94981b-1273-4830-ac2a-991bb25f41d8", + "leftValue": "={{ $json['What are your favorite film genres'] }}", + "rightValue": "Action", + "operator": { + "type": "array", + "operation": "contains", + "rightType": "any" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Action" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "b9545089-4054-484d-9e6c-98f4872e7e9e", + "leftValue": "={{ $json['What are your favorite film genres'] }}", + "rightValue": "Romance", + "operator": { + "type": "array", + "operation": "contains", + "rightType": "any" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Romance" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "71ae5a41-0927-40e3-a583-e569bcebfd1f", + "leftValue": "={{ $json['What are your favorite film genres'] }}", + "rightValue": "Comedy", + "operator": { + "type": "array", + "operation": "contains", + "rightType": "any" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Comedy" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "5bfe5981-203a-457a-bfaa-36846d7b79a8", + "leftValue": "={{ $json['What are your favorite film genres'] }}", + "rightValue": "Drama", + "operator": { + "type": "array", + "operation": "contains", + "rightType": "any" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Drama" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "adb1bfc5-08fd-4653-abe0-6f12aedda16a", + "leftValue": "={{ $json['What are your favorite film genres'] }}", + "rightValue": 1, + "operator": { + "type": "array", + "operation": "lengthGt", + "rightType": "number" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Final page" + } + ] + }, + "options": { + "allMatchingOutputs": true + } + }, + "type": "n8n-nodes-base.switch", + "typeVersion": 3.2, + "position": [ + 100, + 0 + ], + "id": "df96da7b-c7dc-43c6-8941-973842603e0c", + "name": "Switch" + }, + { + "parameters": { + "content": "## Form that may execute multiple branches\nThis form contains branching where more than one path may execute, depending on the user's selections.", + "width": 380 + }, + "type": "n8n-nodes-base.stickyNote", + "position": [ + -160, + -260 + ], + "typeVersion": 1, + "id": "c51af5ad-8f6c-4f2a-8974-65c4abc4fcbf", + "name": "Sticky Note" + }, + { + "parameters": { + "content": "This Switch node determines which branches will execute.\n\nMultiple conditions may be true, resulting in more than one branch being executed. When this happens, n8n executes the first branch completely before returning to execute the next branch.", + "height": 220, + "width": 260, + "color": 5 + }, + "type": "n8n-nodes-base.stickyNote", + "position": [ + 20, + 320 + ], + "typeVersion": 1, + "id": "eab3ff17-5030-4556-a0c7-2571345e8cdf", + "name": "Sticky Note1" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "What is your favorite documentary?" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 700, + -500 + ], + "id": "dc55c82f-7d4f-4368-8ab5-69a673e92027", + "name": "Documentary questions", + "webhookId": "0c72f06e-4cc0-41eb-931c-7bf82bb1927e" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "What is your favorite action film?" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 700, + -280 + ], + "id": "3f76b5df-561b-4159-9e14-33a43d8c45a8", + "name": "Action questions", + "webhookId": "bea04786-25cc-477e-aaf1-ab68159cbe28" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for answering our documentary questions!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 920, + -500 + ], + "id": "16660e2e-a047-45d2-ba54-12d573633ece", + "name": "Documentary thanks", + "webhookId": "0238f2c2-8984-4adc-aade-308bb458c16e" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for answering our action film questions!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 920, + -280 + ], + "id": "1853276a-3ba6-4315-b772-fbeb0c68a477", + "name": "Action thanks", + "webhookId": "2e47b563-bd17-466c-86b7-9237be55d226" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "What is your favorite romance film?" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 700, + -20 + ], + "id": "cd7bc8d0-a143-4733-be84-320c88ef241b", + "name": "Romance questions", + "webhookId": "3f77a665-fc03-46ba-a58f-6d9bd7099028" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for answering our romance film questions!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 920, + -20 + ], + "id": "42d7c8b5-f66f-4b34-821c-0df91bbaa9ea", + "name": "Romance thanks", + "webhookId": "eee896c5-d116-4586-972d-3fe02073ed11" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "What is your favorite comedy film?" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 700, + 220 + ], + "id": "b9422abf-1ad5-44e4-941d-692f72bc2fef", + "name": "Comedy questions", + "webhookId": "97b56894-28fb-47d1-b729-754e43f1ac09" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for answering our comedy film questions!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 920, + 220 + ], + "id": "1db70bda-0752-41b7-a930-b90f6e64b3e7", + "name": "Comedy thanks", + "webhookId": "b021494a-5a35-4ade-b7c0-ca43a309268d" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "What is your favorite drama film?" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 700, + 480 + ], + "id": "2bef931a-12d2-4873-ad19-9bdb0b5fe78f", + "name": "Drama questions", + "webhookId": "8d801d97-1103-42ee-a0c1-c1f1153727d9" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for answering our drama film questions!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 920, + 480 + ], + "id": "1fd7fa2f-d1be-430a-bb98-ded89ad8fca0", + "name": "Drama thanks", + "webhookId": "46a782bc-21b2-4fcd-9c52-82a7bb20ec2c" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for answering our film questions!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 700, + 720 + ], + "id": "7b0aeed0-0e13-4fcb-a3e9-c5ff4d6a77ca", + "name": "Multi-selection thank you", + "webhookId": "67fcd1f3-e5a6-4bf6-b17e-37b2a87f4c3d" + }, + { + "parameters": { + "content": "n8n Form nodes using the **Form Ending** page type are only executed if they are the last node in the execution path.\n\nThese endings specific to a genre are only executed if this is the only valid branch.", + "height": 1400, + "width": 280, + "color": 5 + }, + "type": "n8n-nodes-base.stickyNote", + "position": [ + 840, + -740 + ], + "typeVersion": 1, + "id": "7bda913a-d75c-4b20-8be6-a767c008a8f6", + "name": "Sticky Note2" + }, + { + "parameters": { + "content": "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nThe switch includes this **Form Ending** node whenever more than one branch is executed.\n\nBecause this is the [final branch](https://docs.n8n.io/flow-logic/execution-order/) that will be executed, this is the final display whenever multiple branches are executed.", + "height": 400, + "width": 300, + "color": 5 + }, + "type": "n8n-nodes-base.stickyNote", + "position": [ + 740, + 800 + ], + "typeVersion": 1, + "id": "9c3f93a5-5248-4ba1-99b5-9df6d21416c2", + "name": "Sticky Note3" + } + ], + "pinData": {}, + "connections": { + "On form submission": { + "main": [ + [ + { + "node": "Switch", + "type": "main", + "index": 0 + } + ] + ] + }, + "Switch": { + "main": [ + [ + { + "node": "Documentary questions", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Action questions", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Romance questions", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Comedy questions", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Drama questions", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Multi-selection thank you", + "type": "main", + "index": 0 + } + ] + ] + }, + "Documentary questions": { + "main": [ + [ + { + "node": "Documentary thanks", + "type": "main", + "index": 0 + } + ] + ] + }, + "Action questions": { + "main": [ + [ + { + "node": "Action thanks", + "type": "main", + "index": 0 + } + ] + ] + }, + "Romance questions": { + "main": [ + [ + { + "node": "Romance thanks", + "type": "main", + "index": 0 + } + ] + ] + }, + "Comedy questions": { + "main": [ + [ + { + "node": "Comedy thanks", + "type": "main", + "index": 0 + } + ] + ] + }, + "Drama questions": { + "main": [ + [ + { + "node": "Drama thanks", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "b1d38757-38ea-4ee8-a352-990185b17e31", + "meta": { + "instanceId": "1f94e052868811125a74dc63385a38f60e7a14ab6e00497af83e8b68412ec251" + }, + "id": "kl3goXzWrfrWHpYv", + "tags": [] +} + +// docs/_workflows/integrations/builtin/core-nodes/n8n-nodes-base.form/mutually-exclusive-branching.json +{ + "name": "Form with mutually exclusive branching", + "nodes": [ + { + "parameters": { + "formTitle": "Form with mutually exclusive branching", + "formDescription": "This form contains branches, but only one branch will ever be executed.", + "formFields": { + "values": [ + { + "fieldLabel": "Would you recommend this site?", + "fieldType": "dropdown", + "fieldOptions": { + "values": [ + { + "option": "Yes" + }, + { + "option": "No" + } + ] + }, + "requiredField": true + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.formTrigger", + "typeVersion": 2.2, + "position": [ + 0, + 0 + ], + "id": "1adce353-28c9-48b8-8326-c1f41d9311fd", + "name": "On form submission", + "webhookId": "d869b846-111d-4f53-96e4-2c4a533d9ed6" + }, + { + "parameters": { + "rules": { + "values": [ + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "leftValue": "={{ $json['Would you recommend this site?'] }}", + "rightValue": "Yes", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "Yes" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict", + "version": 2 + }, + "conditions": [ + { + "id": "1dd9b1f5-6f48-4182-ae04-f47c37e3fa98", + "leftValue": "={{ $json['Would you recommend this site?'] }}", + "rightValue": "No", + "operator": { + "type": "string", + "operation": "equals", + "name": "filter.operator.equals" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "No" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.switch", + "typeVersion": 3.2, + "position": [ + 220, + 0 + ], + "id": "c0d3e3f1-76c5-4bac-8382-c3d70a57ee8a", + "name": "Switch" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "What can we do to improve?", + "fieldType": "textarea" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 440, + 200 + ], + "id": "615cf27a-658c-43be-aff9-c5fda8a04c51", + "name": "If not recommended", + "webhookId": "3579ba77-7ba2-4a97-8a29-a228aac297d5" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for your review!", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 660, + -200 + ], + "id": "13423b3f-0380-429d-92bf-460cc8b409a3", + "name": "Thanks for the review", + "webhookId": "bce3f77b-3005-4989-bd61-b9c5ff19e59e" + }, + { + "parameters": { + "operation": "completion", + "completionTitle": "Thank you for your feedback", + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 660, + 200 + ], + "id": "0848a392-41f2-47e8-be17-124fef3d9a63", + "name": "Thanks for the feedback", + "webhookId": "8b1a34e2-aa24-4c12-841c-79f6491cb779" + }, + { + "parameters": { + "content": "## Form with mutually exclusive branching\nThis form contains a branch where only one of the two paths will execute, depending on your selections.", + "width": 380 + }, + "type": "n8n-nodes-base.stickyNote", + "position": [ + -160, + -260 + ], + "typeVersion": 1, + "id": "57c5e1cd-7dda-4bfb-8bfa-8c9f91110249", + "name": "Sticky Note" + }, + { + "parameters": { + "content": "This Switch node determines which branch will execute.\n\nThe switch uses data from a dropdown field with single selection enforced, so only one path will execute.", + "color": 5 + }, + "type": "n8n-nodes-base.stickyNote", + "position": [ + 440, + 0 + ], + "typeVersion": 1, + "id": "9bde0398-7021-4ec6-b950-d836979c973b", + "name": "Sticky Note1" + }, + { + "parameters": { + "formFields": { + "values": [ + { + "fieldLabel": "Leave your review below", + "fieldType": "textarea" + } + ] + }, + "options": {} + }, + "type": "n8n-nodes-base.form", + "typeVersion": 1, + "position": [ + 440, + -200 + ], + "id": "9956a49e-964d-4269-910f-28ad8393548e", + "name": "If recommended", + "webhookId": "f8298b40-1f61-465b-b228-30a659075f30" + } + ], + "pinData": {}, + "connections": { + "On form submission": { + "main": [ + [ + { + "node": "Switch", + "type": "main", + "index": 0 + } + ] + ] + }, + "Switch": { + "main": [ + [ + { + "node": "If recommended", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "If not recommended", + "type": "main", + "index": 0 + } + ] + ] + }, + "If not recommended": { + "main": [ + [ + { + "node": "Thanks for the feedback", + "type": "main", + "index": 0 + } + ] + ] + }, + "If recommended": { + "main": [ + [ + { + "node": "Thanks for the review", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "6797e22c-1b2b-421a-b16d-869f636d0790", + "meta": { + "instanceId": "1f94e052868811125a74dc63385a38f60e7a14ab6e00497af83e8b68412ec251" + }, + "id": "DCotkGqkv0VfT6QT", + "tags": [] +} + +// docs/_workflows/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/webhook-example.json +{ + "name": "Extract from file example", + "nodes": [ + { + "parameters": { + "httpMethod": "POST", + "path": "06696ea7-9dc7-464a-873b-3feb095b0874", + "options": { + "rawBody": true + } + }, + "type": "n8n-nodes-base.webhook", + "typeVersion": 2, + "position": [ + -380, + -80 + ], + "id": "dfbd51af-6050-47c5-a26c-74cba77f65f7", + "name": "Webhook", + "webhookId": "06696ea7-9dc7-464a-873b-3feb095b0874" + }, + { + "parameters": { + "options": { + "headerRow": false + } + }, + "type": "n8n-nodes-base.extractFromFile", + "typeVersion": 1, + "position": [ + -160, + -80 + ], + "id": "1b1e4643-8269-402b-83af-dfd90fd6a0b5", + "name": "Extract from File" + } + ], + "pinData": {}, + "connections": { + "Webhook": { + "main": [ + [ + { + "node": "Extract from File", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": true, + "settings": { + "executionOrder": "v1" + }, + "versionId": "dd2bf7f1-692a-41a8-9c2e-7931de57fa13", + "meta": { + "instanceId": "1060f46e51fc7902c377ab29d7cbfb87696ddf6b3c5c27cbbb65c3cb36e21baf" + }, + "id": "9i3iDZf5MpjlJ2sh", + "tags": [] +} + +// docs/_workflows/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/get-most-recent-file.json +{ + "meta": { + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "nodes": [ + { + "parameters": { + "operation": "download", + "fileId": { + "__rl": true, + "value": "={{ $json.id }}", + "mode": "id" + }, + "options": {} + }, + "id": "45b53bcd-7dcf-4266-8b6e-bfc12008f9e2", + "name": "Google Drive1", + "type": "n8n-nodes-base.googleDrive", + "typeVersion": 3, + "position": [ + 1500, + 300 + ] + }, + { + "parameters": {}, + "id": "ba223e7c-4fed-41dd-8c80-2e8fd742629f", + "name": "When clicking ‘Execute workflow’", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 620, + 300 + ] + }, + { + "parameters": { + "resource": "fileFolder", + "searchMethod": "query", + "returnAll": true, + "filter": { + "whatToSearch": "files" + }, + "options": { + "fields": [ + "*" + ] + } + }, + "id": "42799909-16f3-4f0a-9ad9-4dd0375814a0", + "name": "Google Drive", + "type": "n8n-nodes-base.googleDrive", + "typeVersion": 3, + "position": [ + 840, + 300 + ] + }, + { + "parameters": { + "sortFieldsUi": { + "sortField": [ + { + "fieldName": "modifiedTime", + "order": "descending" + } + ] + }, + "options": {} + }, + "id": "bfb8baa6-1b8c-4540-9ad6-b5d7c3f7521b", + "name": "Sort", + "type": "n8n-nodes-base.sort", + "typeVersion": 1, + "position": [ + 1060, + 300 + ] + }, + { + "parameters": {}, + "id": "2883d39a-f7d9-4244-bf7d-b06878678ccc", + "name": "Limit", + "type": "n8n-nodes-base.limit", + "typeVersion": 1, + "position": [ + 1280, + 300 + ] + } + ], + "connections": { + "When clicking ‘Execute workflow’": { + "main": [ + [ + { + "node": "Google Drive", + "type": "main", + "index": 0 + } + ] + ] + }, + "Google Drive": { + "main": [ + [ + { + "node": "Sort", + "type": "main", + "index": 0 + } + ] + ] + }, + "Sort": { + "main": [ + [ + { + "node": "Limit", + "type": "main", + "index": 0 + } + ] + ] + }, + "Limit": { + "main": [ + [ + { + "node": "Google Drive1", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {} +} + + +// docs/_workflows/advanced-ai/examples/agents_vs_chains.json +{ + "name": "Agents vs chains", + "nodes": [ + { + "parameters": {}, + "id": "9e1d8f35-e1ba-4600-977d-e54a919c2c62", + "name": "Chat Trigger", + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "typeVersion": 1, + "position": [ + 520, + 420 + ], + "webhookId": "84bfdbd0-e2ce-4bfa-b746-985e64a14484" + }, + { + "parameters": { + "options": {} + }, + "id": "4b89df4b-4f78-4f52-a51d-eeb66a7948e5", + "name": "OpenAI Chat Model", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "typeVersion": 1, + "position": [ + 1020, + 420 + ], + "credentials": { + "openAiApi": { + "id": "tW3bkXa0SAK0OzvR", + "name": "OpenAi account Debs" + } + } + }, + { + "parameters": { + "options": {} + }, + "id": "a0045df2-d212-4e6a-a2d4-722136dcb8b5", + "name": "OpenAI Chat Model1", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "typeVersion": 1, + "position": [ + 980, + 880 + ], + "credentials": { + "openAiApi": { + "id": "tW3bkXa0SAK0OzvR", + "name": "OpenAi account Debs" + } + } + }, + { + "parameters": {}, + "id": "d702f647-1fa7-4b4f-91b1-e0152326ea11", + "name": "Simple Memory", + "type": "@n8n/n8n-nodes-langchain.memoryBufferWindow", + "typeVersion": 1.2, + "position": [ + 1280, + 460 + ] + }, + { + "parameters": {}, + "id": "76cc359a-5ec8-446a-a8e0-9035d18247cb", + "name": "Wikipedia", + "type": "@n8n/n8n-nodes-langchain.toolWikipedia", + "typeVersion": 1, + "position": [ + 1540, + 340 + ] + }, + { + "parameters": { + "options": {} + }, + "id": "01d1785f-f7c4-47d2-97b7-76eeff68002d", + "name": "AI Agent", + "type": "@n8n/n8n-nodes-langchain.agent", + "typeVersion": 1.5, + "position": [ + 1060, + 140 + ] + }, + { + "parameters": { + "messages": { + "messageValues": [ + { + "message": "Every time you respond, start your response with the sentence: \"This message came from the chain\"." + } + ] + } + }, + "id": "bcdcd704-13f5-4906-b337-7ec4629b9781", + "name": "Basic LLM Chain", + "type": "@n8n/n8n-nodes-langchain.chainLlm", + "typeVersion": 1.4, + "position": [ + 1040, + 680 + ] + }, + { + "parameters": { + "content": "## Try it out\n\nSelect **Chat**, and try out these queries:\n\n- Please show me a Wikipedia article about cats (agent)\n- Please show me a Wikipedia article about cats (chain)\n- What was my last question? (chain)\n- What was my last question? (agent)\n", + "height": 343.8587887368956, + "color": 4 + }, + "id": "f08e231b-739a-4b9d-b738-139b7e3bd60b", + "name": "Sticky Note", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 240, + 420 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 193, + "width": 167, + "color": 2 + }, + "id": "5421fd4d-c82f-483a-8238-869b9a10000d", + "name": "Sticky Note1", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 980, + 360 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 193, + "width": 167, + "color": 2 + }, + "id": "23fac3a8-a220-40a5-8d3d-4a3013b0f1da", + "name": "Sticky Note2", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 940, + 820 + ] + }, + { + "parameters": { + "content": "**Memory allows the agent to access previous parts of the chat**\n", + "height": 244, + "color": 5 + }, + "id": "08397bde-06e4-4bff-b130-cbc4408a0ecc", + "name": "Sticky Note3", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1200, + 360 + ] + }, + { + "parameters": { + "content": "**The agent can use the Wikipedia tool to access articles from Wikipedia**", + "height": 238, + "color": 5 + }, + "id": "a53ff4f2-9d06-4166-9ad6-760cd8fe4a54", + "name": "Sticky Note4", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1460, + 240 + ] + }, + { + "parameters": { + "rules": { + "values": [ + { + "conditions": { + "options": { + "caseSensitive": false, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "leftValue": "={{ $json.chatInput }}", + "rightValue": "agent", + "operator": { + "type": "string", + "operation": "contains" + } + } + ], + "combinator": "and" + } + }, + { + "conditions": { + "options": { + "caseSensitive": false, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "id": "248f4a34-89c1-4d1e-867a-daa024c8635a", + "leftValue": "={{ $json.chatInput }}", + "rightValue": "chain", + "operator": { + "type": "string", + "operation": "contains" + } + } + ], + "combinator": "and" + } + } + ] + }, + "options": { + "ignoreCase": true + } + }, + "id": "ab2bff8d-e914-421d-9aa3-9d0ad815cea6", + "name": "Check user input for \"chain\" or \"agent\"", + "type": "n8n-nodes-base.switch", + "typeVersion": 3, + "position": [ + 740, + 420 + ] + }, + { + "parameters": { + "content": "## Next steps\n\nLearn more about [Advanced AI in n8n](https://docs.n8n.io/advanced-ai/)" + }, + "id": "f077f8e6-789a-4db1-8402-fb173c296017", + "name": "Sticky Note5", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1560, + 840 + ] + } + ], + "pinData": {}, + "connections": { + "Chat Trigger": { + "main": [ + [ + { + "node": "Check user input for \"chain\" or \"agent\"", + "type": "main", + "index": 0 + } + ] + ] + }, + "OpenAI Chat Model": { + "ai_languageModel": [ + [ + { + "node": "AI Agent", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "OpenAI Chat Model1": { + "ai_languageModel": [ + [ + { + "node": "Basic LLM Chain", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "Simple Memory": { + "ai_memory": [ + [ + { + "node": "AI Agent", + "type": "ai_memory", + "index": 0 + } + ] + ] + }, + "Wikipedia": { + "ai_tool": [ + [ + { + "node": "AI Agent", + "type": "ai_tool", + "index": 0 + } + ] + ] + }, + "Check user input for \"chain\" or \"agent\"": { + "main": [ + [ + { + "node": "AI Agent", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Basic LLM Chain", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "59784a0f-0601-4456-b48d-9a191e203461", + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "id": "qK43vJw6dRZkXo6h", + "tags": [ + { + "createdAt": "2021-06-25T07:47:07.640Z", + "updatedAt": "2021-06-25T07:47:07.640Z", + "id": "1", + "name": "docs" + }, + { + "createdAt": "2023-02-22T12:06:03.372Z", + "updatedAt": "2023-02-22T12:06:03.372Z", + "id": "63", + "name": "createdBy:Debs" + } + ] +} + +// docs/_workflows/advanced-ai/examples/ask_a_human.json +{ + "name": "Ask a human", + "nodes": [ + { + "parameters": {}, + "id": "a60c8572-56c1-4bf3-8352-a6419a475887", + "name": "Simple Memory", + "type": "@n8n/n8n-nodes-langchain.memoryBufferWindow", + "typeVersion": 1.1, + "position": [ + 900, + 760 + ] + }, + { + "parameters": { + "name": "dont_know_tool", + "description": "Use this tool if you don't know the answer to the user's question, or if you're not very confident about your answer.", + "workflowId": "={{ $workflow.id}}", + "fields": { + "values": [ + { + "name": "chatInput", + "stringValue": "={{ $('Chat Trigger').item.json.chatInput }}" + } + ] + } + }, + "id": "b4f2e26c-903b-46b8-bd8b-110fd64de9e4", + "name": "Not sure?", + "type": "@n8n/n8n-nodes-langchain.toolWorkflow", + "typeVersion": 1, + "position": [ + 1120, + 760 + ] + }, + { + "parameters": {}, + "id": "951cc691-b422-4ce6-901f-b7feb3afd1ad", + "name": "Execute Workflow Trigger", + "type": "n8n-nodes-base.executeWorkflowTrigger", + "typeVersion": 1, + "position": [ + 540, + 1360 + ] + }, + { + "parameters": { + "content": "### Sub-workflow: Custom tool\nThe agent above can call this workflow. It checks if the user has supplied an email address. If they haven't it prompts them to provide one. If they have, it messages a customer support channel for help.", + "height": 775.3931210698682, + "width": 1118.3459011229047, + "color": 7 + }, + "id": "194ba9c0-e256-449a-8da7-ac5339123a99", + "name": "Sticky Note1", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 500, + 1020 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "### Main workflow: AI agent using custom tool", + "height": 486.5625, + "width": 927.5, + "color": 7 + }, + "id": "38c6b363-45a7-4e72-9e40-8c0df3cc480f", + "name": "Sticky Note2", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 500, + 460 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**This tool calls the sub-workflow below**", + "height": 179.21380662202682, + "width": 197.45572294791873, + "color": 5 + }, + "id": "0389315b-e48d-4b00-b9a1-899302b1b094", + "name": "Sticky Note", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 1060, + 700 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 213.44323866265472, + "width": 150, + "color": 2 + }, + "id": "fb11064a-4cf5-4110-9e39-af24a3225164", + "name": "Sticky Note5", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 700, + 680 + ] + }, + { + "parameters": { + "content": "**Set your credentials and Slack details**", + "height": 250.57252651663197, + "width": 178.0499248677781, + "color": 2 + }, + "id": "d689021d-0a46-4dff-a01a-0b01ecdd198b", + "name": "Sticky Note4", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1020, + 1180 + ] + }, + { + "parameters": { + "content": "## Try it out\n\nSelect **Chat** at the bottom and enter:\n\n_Hi! Please respond to this as if you don't know the answer to my query._", + "height": 214.8397420554627, + "width": 185.9375, + "color": 4 + }, + "id": "0926cd61-c0b8-4bae-ae65-9afd130d17cd", + "name": "Sticky Note3", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 340, + 520 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "## Next steps\n\nLearn more about [Advanced AI in n8n](https://docs.n8n.io/advanced-ai/)", + "height": 144.50520156238127 + }, + "id": "cde69dfe-252e-4a05-8d56-fa79431df5d8", + "name": "Sticky Note6", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1580, + 1600 + ] + }, + { + "parameters": {}, + "id": "927b775a-47f6-4067-a1a5-5f13dea28e45", + "name": "Chat Trigger", + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "typeVersion": 1, + "position": [ + 600, + 520 + ], + "webhookId": "785e0c0c-12e5-4249-9abe-47bb131975cb" + }, + { + "parameters": { + "jsCode": "response = {\"response\":\"I'm sorry I don't know the answer. Please repeat your question and include your email address so I can request help.\"};\nreturn response;" + }, + "id": "971e7b90-c2d8-4292-9da8-732d7d399f04", + "name": "Prompt the user to provide an email", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1060, + 1520 + ] + }, + { + "parameters": { + "jsCode": "response = {\"response\": \"Thank you for getting in touch. I've messaged a human to help.\"}\nreturn response;" + }, + "id": "6f5a21b3-c145-46c8-8e69-660100c4a6fc", + "name": "Confirm that we've messaged a human", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1300, + 1260 + ] + }, + { + "parameters": { + "options": { + "systemMessage": "Try to answer the user's question. When you can't answer, or you're not confident of the answer, use the appropriate tool. When you use the dont_know_tool, respond with the message from the tool." + } + }, + "id": "8b17da5e-e392-4028-91b0-bc02d34e46ed", + "name": "AI Agent", + "type": "@n8n/n8n-nodes-langchain.agent", + "typeVersion": 1.2, + "position": [ + 820, + 520 + ] + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "id": "5e21e7c5-db60-4111-bb17-c289ae0fc159", + "leftValue": "={{ $('Execute Workflow Trigger').item.json.chatInput }}", + "rightValue": "/([a-zA-Z0-9._-]+@[a-zA-Z0-9._-]+\\.[a-zA-Z0-9_-]+)/gi", + "operator": { + "type": "string", + "operation": "regex" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "id": "990ecd3b-6aa0-4b17-8d01-d606b9164fa8", + "name": "Check if user has provided email", + "type": "n8n-nodes-base.if", + "typeVersion": 2, + "position": [ + 760, + 1360 + ] + }, + { + "parameters": { + "select": "channel", + "channelId": { + "__rl": true, + "value": "", + "mode": "name" + }, + "text": "={{ \"A user had a question the bot couldn't answer. Here's their message: \" + $('Execute Workflow Trigger').item.json.chatInput }}", + "otherOptions": {} + }, + "id": "d14da0ae-06ca-422b-b5b6-e7759e74c787", + "name": "Message Slack for help", + "type": "n8n-nodes-base.slack", + "typeVersion": 2.1, + "position": [ + 1060, + 1260 + ] + }, + { + "parameters": { + "model": "gpt-4", + "options": { + "temperature": 0.2 + } + }, + "id": "278391c7-6945-495e-a4f1-74fb8fcc3549", + "name": "GPT4", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "typeVersion": 1, + "position": [ + 740, + 740 + ] + } + ], + "pinData": {}, + "connections": { + "Simple Memory": { + "ai_memory": [ + [ + { + "node": "AI Agent", + "type": "ai_memory", + "index": 0 + } + ] + ] + }, + "Not sure?": { + "ai_tool": [ + [ + { + "node": "AI Agent", + "type": "ai_tool", + "index": 0 + } + ] + ] + }, + "Execute Workflow Trigger": { + "main": [ + [ + { + "node": "Check if user has provided email", + "type": "main", + "index": 0 + } + ] + ] + }, + "Chat Trigger": { + "main": [ + [ + { + "node": "AI Agent", + "type": "main", + "index": 0 + } + ] + ] + }, + "Check if user has provided email": { + "main": [ + [ + { + "node": "Message Slack for help", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Prompt the user to provide an email", + "type": "main", + "index": 0 + } + ] + ] + }, + "Message Slack for help": { + "main": [ + [ + { + "node": "Confirm that we've messaged a human", + "type": "main", + "index": 0 + } + ] + ] + }, + "GPT4": { + "ai_languageModel": [ + [ + { + "node": "AI Agent", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + } + } +} + +// docs/_workflows/advanced-ai/examples/chat_with_google_sheets_docs_version.json +{ + "name": "Chat with Google Sheets (docs version)", + "nodes": [ + { + "parameters": {}, + "id": "e96a5e41-f0d6-49c1-977e-ff724a857212", + "name": "Execute Workflow Trigger", + "type": "n8n-nodes-base.executeWorkflowTrigger", + "position": [ + 540, + 1240 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "### Sub-workflow: Custom tool\nThe agent above can call this workflow. It returns three different types of data from the Google Sheet, which can be used together for more complex queries without returning the whole sheet (which might be too big for GPT to handle).", + "height": 612.0936015224503, + "width": 1449.2963504228514, + "color": 7 + }, + "id": "67facef0-e9c6-4280-8232-78f654b420d5", + "name": "Sticky Note1", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 461.9740563285368, + 970.616715060075 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "### Main workflow: AI agent using custom tool", + "height": 486.5625, + "width": 927.5, + "color": 7 + }, + "id": "bc448102-954b-451e-9bf7-bcadbc53bdbc", + "name": "Sticky Note2", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 460, + 460 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "## Try it out\n\nSelect **Chat** at the bottom and enter:\n\n_Which is our biggest customer?_", + "height": 183.85014518022527, + "width": 185.9375, + "color": 4 + }, + "id": "afb2da2f-8da2-4ee8-bff9-55a99eeecc5c", + "name": "Sticky Note3", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 300, + 540 + ], + "typeVersion": 1 + }, + { + "parameters": {}, + "id": "5d56d128-9a83-45ee-a34c-bc1190d59322", + "name": "Chat Trigger", + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "position": [ + 600, + 560 + ], + "webhookId": "e3f23177-c7c1-417b-a513-1c1090dda0a2", + "typeVersion": 1 + }, + { + "parameters": { + "authentication": "serviceAccount", + "documentId": { + "__rl": true, + "mode": "url", + "value": "={{ $json.sheetUrl }}" + }, + "sheetName": { + "__rl": true, + "mode": "url", + "value": "={{ $json.sheetUrl }}" + }, + "options": {} + }, + "id": "3c0e4b48-a27b-472f-948e-9aa001c49149", + "name": "Get Google sheet contents", + "type": "n8n-nodes-base.googleSheets", + "position": [ + 980, + 1240 + ], + "typeVersion": 4.2 + }, + { + "parameters": { + "fields": { + "values": [ + { + "name": "sheetUrl" + } + ] + }, + "options": {} + }, + "id": "67f9c172-e70f-4a0f-afd3-513cfeae09db", + "name": "Set Google Sheet URL", + "type": "n8n-nodes-base.set", + "position": [ + 760, + 1240 + ], + "typeVersion": 3.2 + }, + { + "parameters": { + "fields": { + "values": [ + { + "name": "response", + "stringValue": "={{ Object.keys($json) }}" + } + ] + }, + "include": "none", + "options": {} + }, + "id": "d49223eb-2927-4ddd-bd2c-cd439f927341", + "name": "Get column names", + "type": "n8n-nodes-base.set", + "position": [ + 1440, + 1060 + ], + "executeOnce": true, + "typeVersion": 3.2 + }, + { + "parameters": { + "jsCode": "return {\n 'response': JSON.stringify($input.all().map(x => x.json))\n}" + }, + "id": "37ceba7a-1f0b-4de7-ae4a-d29a18dabaf6", + "name": "Prepare output", + "type": "n8n-nodes-base.code", + "position": [ + 1720, + 1240 + ], + "typeVersion": 2 + }, + { + "parameters": { + "name": "list_columns_tool", + "description": "=### List all column names in customer data\nThis is useful to find out what data is available for each customer. Returns a JSON array containing all the column names.", + "workflowId": "={{ $workflow.id }}", + "fields": { + "values": [ + { + "name": "operation", + "stringValue": "column_names" + } + ] + } + }, + "id": "94516eb1-89fc-4d3f-8000-d0fa43cd71cd", + "name": "List columns tool", + "type": "@n8n/n8n-nodes-langchain.toolWorkflow", + "position": [ + 940, + 780 + ], + "typeVersion": 1 + }, + { + "parameters": { + "name": "get_customer_tool", + "description": "=### Get all columns for a given customer\nTo use this mode, pass the row number of the customer. Returns a JSON object with all the column names and their values.", + "workflowId": "={{ $workflow.id }}", + "fields": { + "values": [ + { + "name": "operation", + "stringValue": "row" + } + ] + } + }, + "id": "006745a1-3df7-4de9-9483-c6e133272c55", + "name": "Get customer tool", + "type": "@n8n/n8n-nodes-langchain.toolWorkflow", + "position": [ + 1220, + 780 + ], + "typeVersion": 1 + }, + { + "parameters": {}, + "id": "c3d20569-1374-4f8d-8779-23b98952d124", + "name": "Simple Memory", + "type": "@n8n/n8n-nodes-langchain.memoryBufferWindow", + "position": [ + 800, + 780 + ], + "typeVersion": 1.1 + }, + { + "parameters": { + "name": "column_values_tool", + "description": "=### Get the specified column value for all customers\nThis is useful if you want to find out which customers have a certain value for a given column. Returns an array of JSON objects, one per customer. Each JSON object includes the column being requested, plus the row_number column. (The row_number column can be used to request the full customer data in a second step.). To use this mode, pass the name of the column to fetch.\n\nYou may want to call the 'list columns' tool first to find out which columns you could be fetching.", + "workflowId": "={{ $workflow.id }}", + "fields": { + "values": [ + { + "name": "operation", + "stringValue": "column_values" + } + ] + } + }, + "id": "3a370ae9-eaf8-4e84-948b-848c461ac9eb", + "name": "Get column values tool", + "type": "@n8n/n8n-nodes-langchain.toolWorkflow", + "position": [ + 1080, + 780 + ], + "typeVersion": 1 + }, + { + "parameters": { + "text": "={{ $json.chatInput }}", + "options": { + "maxIterations": 10 + } + }, + "id": "8f2a4854-2177-4ac8-9501-fa36cf2a3d73", + "name": "AI Agent", + "type": "@n8n/n8n-nodes-langchain.agent", + "position": [ + 820, + 560 + ], + "typeVersion": 1.1 + }, + { + "parameters": { + "content": "**These tools all call the sub-workflow below**", + "height": 179.21380662202682, + "width": 432.3271051132649, + "color": 5 + }, + "id": "2576563b-a104-4d99-b3c8-b53bff4c740c", + "name": "Sticky Note", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 900, + 740.8693557231958 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**Change the URL of the Google Sheet**", + "height": 226.64416053838073, + "width": 179.99762227826224, + "color": 2 + }, + "id": "5b623d9e-e188-403d-a702-9ece6172a487", + "name": "Sticky Note4", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 723, + 1172 + ], + "typeVersion": 1 + }, + { + "parameters": { + "model": "gpt-4", + "options": { + "temperature": 0 + } + }, + "id": "2b8c8a67-a4df-4f5c-8c13-3cb2d25d2c5f", + "name": "GPT4 Model", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "position": [ + 660, + 780 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 171, + "width": 150, + "color": 2 + }, + "id": "f39d0c9b-4055-4331-83c8-3dbffb43478e", + "name": "Sticky Note5", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 620, + 720 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 237, + "width": 176, + "color": 2 + }, + "id": "a8e09ef8-4dc6-4918-9194-047de402a8fa", + "name": "Sticky Note6", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 940, + 1172 + ] + }, + { + "parameters": { + "content": "## Next steps\n\nLearn more about [Advanced AI in n8n](https://docs.n8n.io/advanced-ai/)", + "height": 126.0084096222716, + "width": 291.1204551358572 + }, + "id": "a391dfb1-f408-4498-99cd-d35a258d6c9a", + "name": "Sticky Note7", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1740, + 1540 + ] + }, + { + "parameters": { + "rules": { + "values": [ + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "leftValue": "={{ $('Execute Workflow Trigger').item.json.operation }}", + "rightValue": "column_names", + "operator": { + "type": "string", + "operation": "equals" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "col names" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "id": "9fe58592-72e2-4379-9bdb-10da19c8218b", + "leftValue": "={{ $('Execute Workflow Trigger').item.json.operation }}", + "rightValue": "column_values", + "operator": { + "type": "string", + "operation": "equals", + "name": "filter.operator.equals" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "col values" + }, + { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "id": "c1836f93-7874-43a4-98ff-cc487b276600", + "leftValue": "={{ $('Execute Workflow Trigger').item.json.operation }}", + "rightValue": "row", + "operator": { + "type": "string", + "operation": "equals", + "name": "filter.operator.equals" + } + } + ], + "combinator": "and" + }, + "renameOutput": true, + "outputKey": "rows" + } + ] + }, + "options": {} + }, + "id": "907deea9-26cc-427e-93fc-52ce6b67e5e1", + "name": "Check operations", + "type": "n8n-nodes-base.switch", + "typeVersion": 3, + "position": [ + 1220, + 1240 + ] + }, + { + "parameters": { + "fields": { + "values": [ + { + "name": "={{ $('Execute Workflow Trigger').item.json.query }}", + "stringValue": "={{ $json[$('Execute Workflow Trigger').item.json.query] }}" + }, + { + "name": "row_number", + "stringValue": "={{ $json.row_number }}" + } + ] + }, + "include": "none", + "options": {} + }, + "id": "f2ebcae6-3cfb-4862-a927-dc66bd24f197", + "name": "Prepare column data", + "type": "n8n-nodes-base.set", + "position": [ + 1440, + 1240 + ], + "typeVersion": 3.2 + }, + { + "parameters": { + "conditions": { + "options": { + "leftValue": "", + "caseSensitive": true, + "typeValidation": "loose" + }, + "combinator": "and", + "conditions": [ + { + "id": "bf712098-97e4-42cb-8e08-2ee32d19d3e7", + "operator": { + "type": "number", + "operation": "equals" + }, + "leftValue": "={{ $json.row_number }}", + "rightValue": "={{ $('Execute Workflow Trigger').item.json.query }}" + } + ] + }, + "options": { + "looseTypeValidation": true + } + }, + "id": "f40acb04-ef06-4670-b8b1-86b04f066af8", + "name": "Filter out other rows", + "type": "n8n-nodes-base.filter", + "position": [ + 1440, + 1420 + ], + "typeVersion": 2 + } + ], + "pinData": {}, + "connections": { + "GPT4 Model": { + "ai_languageModel": [ + [ + { + "node": "AI Agent", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "Chat Trigger": { + "main": [ + [ + { + "node": "AI Agent", + "type": "main", + "index": 0 + } + ] + ] + }, + "Get column names": { + "main": [ + [ + { + "node": "Prepare output", + "type": "main", + "index": 0 + } + ] + ] + }, + "Get customer tool": { + "ai_tool": [ + [ + { + "node": "AI Agent", + "type": "ai_tool", + "index": 0 + } + ] + ] + }, + "List columns tool": { + "ai_tool": [ + [ + { + "node": "AI Agent", + "type": "ai_tool", + "index": 0 + } + ] + ] + }, + "Set Google Sheet URL": { + "main": [ + [ + { + "node": "Get Google sheet contents", + "type": "main", + "index": 0 + } + ] + ] + }, + "Simple Memory": { + "ai_memory": [ + [ + { + "node": "AI Agent", + "type": "ai_memory", + "index": 0 + } + ] + ] + }, + "Get column values tool": { + "ai_tool": [ + [ + { + "node": "AI Agent", + "type": "ai_tool", + "index": 0 + } + ] + ] + }, + "Execute Workflow Trigger": { + "main": [ + [ + { + "node": "Set Google Sheet URL", + "type": "main", + "index": 0 + } + ] + ] + }, + "Get Google sheet contents": { + "main": [ + [ + { + "node": "Check operations", + "type": "main", + "index": 0 + } + ] + ] + }, + "Check operations": { + "main": [ + [ + { + "node": "Get column names", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Prepare column data", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Filter out other rows", + "type": "main", + "index": 0 + } + ] + ] + }, + "Prepare column data": { + "main": [ + [ + { + "node": "Prepare output", + "type": "main", + "index": 0 + } + ] + ] + }, + "Filter out other rows": { + "main": [ + [ + { + "node": "Prepare output", + "type": "main", + "index": 0 + } + ] + ] + } + } +} + + +// docs/_workflows/advanced-ai/examples/let_your_ai_call_an_api.json +{ + "name": "Let your AI call an API", + "nodes": [ + { + "parameters": {}, + "id": "35ce49a9-eda1-4da5-a6cb-39a39680111b", + "name": "Execute Workflow Trigger", + "type": "n8n-nodes-base.executeWorkflowTrigger", + "position": [ + 520, + 1140 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "### Sub-workflow: Custom tool\nThe agent above can call this workflow. It calls an example API called \"Bored API\" and returns a string with an activity idea.", + "height": 775.3931210698682, + "width": 1180.0825159534493, + "color": 7 + }, + "id": "ec6e261b-922f-401c-9392-12ff73488a5f", + "name": "Sticky Note1", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 460, + 960 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "### Main workflow: AI agent using custom tool", + "height": 486.5625, + "width": 927.5, + "color": 7 + }, + "id": "25780e87-0ae0-4bee-9582-75f98bf66635", + "name": "Sticky Note2", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 460, + 460 + ], + "typeVersion": 1 + }, + { + "parameters": {}, + "id": "f262f04b-964c-47c0-b7dc-a86b82b0184b", + "name": "Chat Trigger", + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "position": [ + 600, + 560 + ], + "webhookId": "e3f23177-c7c1-417b-a513-1c1090dda0a2", + "typeVersion": 1 + }, + { + "parameters": {}, + "id": "29678c05-9a48-41ec-9c5c-af36ee0d7fc6", + "name": "Simple Memory", + "type": "@n8n/n8n-nodes-langchain.memoryBufferWindow", + "position": [ + 860, + 780 + ], + "typeVersion": 1.1 + }, + { + "parameters": { + "content": "**This tool calls the sub-workflow below**", + "height": 179.21380662202682, + "width": 197.45572294791873, + "color": 5 + }, + "id": "e078f88b-489c-42ea-9544-6bdaeae213a0", + "name": "Sticky Note", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 1020, + 720 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 171, + "width": 150, + "color": 2 + }, + "id": "1d1d1a4e-0d1d-4094-81c7-e01f2674df0d", + "name": "Sticky Note5", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 620, + 720 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 170.10898979087855, + "width": 152.85917676941358, + "color": 2 + }, + "id": "8c83d554-bf1f-4b3c-abb9-a6bb76846698", + "name": "Sticky Note7", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 880, + 1540.2624287261167 + ] + }, + { + "parameters": { + "name": "activity_tool", + "description": "=Suggest an activity for a person to do. Use this tool if someone is bored, or asking for ideas of things to do.", + "workflowId": "={{ $workflow.id }}", + "fields": { + "values": [ + { + "name": "chatInput", + "stringValue": "={{ $('Chat Trigger').item.json.chatInput }}" + } + ] + } + }, + "id": "82a3c606-0d7a-4b45-aae7-df35525615f7", + "name": "Activity tool", + "type": "@n8n/n8n-nodes-langchain.toolWorkflow", + "position": [ + 1080, + 780 + ], + "typeVersion": 1 + }, + { + "parameters": { + "text": "={{ $json.chatInput }}", + "options": { + "maxIterations": 10 + } + }, + "id": "716dea0d-a987-4cf7-ae4a-bf0f7c7d7da9", + "name": "AI Agent", + "type": "@n8n/n8n-nodes-langchain.agent", + "position": [ + 820, + 560 + ], + "typeVersion": 1.1 + }, + { + "parameters": {}, + "id": "f469fba8-07ae-4c79-a79c-2c49946d94e2", + "name": "Auto-fixing Output Parser", + "type": "@n8n/n8n-nodes-langchain.outputParserAutofixing", + "typeVersion": 1, + "position": [ + 920, + 1380 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 189.79768930311286, + "width": 150, + "color": 2 + }, + "id": "e6d252d3-d78e-4827-b911-0528c3b80794", + "name": "Sticky Note4", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 648.9502850955331, + 1340 + ] + }, + { + "parameters": { + "model": "gpt-4", + "options": {} + }, + "id": "f65054a9-771c-47f8-94cc-4ed766f89d19", + "name": "GPT4 Model 1", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "position": [ + 660, + 780 + ], + "typeVersion": 1 + }, + { + "parameters": { + "model": "gpt-4", + "options": {} + }, + "id": "94c2a6d8-cab9-48c2-8801-4306f0957f50", + "name": "GPT4 Model 2", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "typeVersion": 1, + "position": [ + 700, + 1420 + ] + }, + { + "parameters": { + "model": "gpt-4", + "options": {} + }, + "id": "5f423800-2eaf-43f5-bd59-dc1212cb55ad", + "name": "GPT4 Model 3", + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "typeVersion": 1, + "position": [ + 920, + 1600 + ] + }, + { + "parameters": { + "content": "## Try it out\n\nSelect **Chat** at the bottom and enter:\n\n_Hi! Please suggest something to do. I feel like learning something new._", + "height": 214.8397420554627, + "width": 185.9375, + "color": 4 + }, + "id": "8ba60ef6-c375-41d9-bf79-1f19f1495adb", + "name": "Sticky Note3", + "type": "n8n-nodes-base.stickyNote", + "position": [ + 300, + 540 + ], + "typeVersion": 1 + }, + { + "parameters": { + "content": "## Next steps\n\nLearn more about [Advanced AI in n8n](https://docs.n8n.io/advanced-ai/)", + "height": 144.50520156238127 + }, + "id": "4bbd5942-4f2a-4a9a-a26c-61f95ad57549", + "name": "Sticky Note6", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1500, + 1540 + ] + }, + { + "parameters": { + "jsonSchema": "{\n \"type\": \"object\",\n \"properties\": {\n \"type\": {\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"enum\": [\"education\", \"recreational\",\"social\",\"diy\",\"charity\",\"cooking\",\"relaxation\",\"music\",\"busywork\"]\n }\n }\n },\n \"participants\": {\n \"type\": \"number\"\n }\n }\n}" + }, + "id": "a50c7858-b0fd-44d6-898d-452ffc5cbd72", + "name": "Structure as JSON", + "type": "@n8n/n8n-nodes-langchain.outputParserStructured", + "typeVersion": 1, + "position": [ + 1120, + 1520 + ] + }, + { + "parameters": { + "url": "http://www.boredapi.com/api/activity/", + "sendQuery": true, + "queryParameters": { + "parameters": [ + { + "name": "type", + "value": "={{ $json.output.type.data }}" + }, + { + "name": "participants", + "value": "={{ $json.output.participants }}" + } + ] + }, + "options": {} + }, + "id": "340c2536-6e79-4af6-9cd0-5cbf6eae1983", + "name": "Call the API", + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.1, + "position": [ + 1120, + 1140 + ] + }, + { + "parameters": { + "prompt": "={{ $('Execute Workflow Trigger').item.json.chatInput }}" + }, + "id": "d7d5455c-2e46-4896-853c-6b527e9403e4", + "name": "Work out activity type and number of people", + "type": "@n8n/n8n-nodes-langchain.chainLlm", + "typeVersion": 1.3, + "position": [ + 740, + 1140 + ] + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "e37e64f6-64e7-4fbd-9ea1-e9d3ef99b39c", + "name": "response", + "value": "={{ $json.activity }}", + "type": "string" + } + ] + }, + "options": {} + }, + "id": "83f9ac05-4583-4cc4-bcc8-29ae450c95cb", + "name": "Set 'response' value", + "type": "n8n-nodes-base.set", + "typeVersion": 3.3, + "position": [ + 1340, + 1140 + ] + } + ], + "pinData": {}, + "connections": { + "Chat Trigger": { + "main": [ + [ + { + "node": "AI Agent", + "type": "main", + "index": 0 + } + ] + ] + }, + "Simple Memory": { + "ai_memory": [ + [ + { + "node": "AI Agent", + "type": "ai_memory", + "index": 0 + } + ] + ] + }, + "Execute Workflow Trigger": { + "main": [ + [ + { + "node": "Work out activity type and number of people", + "type": "main", + "index": 0 + } + ] + ] + }, + "Activity tool": { + "ai_tool": [ + [ + { + "node": "AI Agent", + "type": "ai_tool", + "index": 0 + } + ] + ] + }, + "Auto-fixing Output Parser": { + "ai_outputParser": [ + [ + { + "node": "Work out activity type and number of people", + "type": "ai_outputParser", + "index": 0 + } + ] + ] + }, + "GPT4 Model 1": { + "ai_languageModel": [ + [ + { + "node": "AI Agent", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "GPT4 Model 2": { + "ai_languageModel": [ + [ + { + "node": "Work out activity type and number of people", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "GPT4 Model 3": { + "ai_languageModel": [ + [ + { + "node": "Auto-fixing Output Parser", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "Structure as JSON": { + "ai_outputParser": [ + [ + { + "node": "Auto-fixing Output Parser", + "type": "ai_outputParser", + "index": 0 + } + ] + ] + }, + "Call the API": { + "main": [ + [ + { + "node": "Set 'response' value", + "type": "main", + "index": 0 + } + ] + ] + }, + "Work out activity type and number of people": { + "main": [ + [ + { + "node": "Call the API", + "type": "main", + "index": 0 + } + ] + ] + } + } +} + +// docs/_workflows/advanced-ai/examples/populate_a_pinecone_vector_database_from_a_website.json +{ + "name": "Populate a Pinecone vector database from a website", + "nodes": [ + { + "parameters": { + "model": "text-embedding-3-large", + "options": {}, + "requestOptions": {} + }, + "id": "856f2426-b4b5-4180-a422-d26692844afb", + "name": "Embeddings OpenAI", + "type": "@n8n/n8n-nodes-langchain.embeddingsOpenAi", + "typeVersion": 1, + "position": [ + 80, + 1040 + ], + "credentials": { + "openAiApi": { + "id": "tW3bkXa0SAK0OzvR", + "name": "OpenAi account Debs" + } + } + }, + { + "parameters": { + "options": {}, + "requestOptions": {} + }, + "id": "1e702984-6f79-416e-981a-6728d4b3c233", + "name": "Default Data Loader", + "type": "@n8n/n8n-nodes-langchain.documentDefaultDataLoader", + "typeVersion": 1, + "position": [ + 260, + 960 + ] + }, + { + "parameters": { + "options": { + "splitCode": "markdown" + }, + "requestOptions": {} + }, + "id": "2d1f30fd-f251-4389-8f6d-2c950018a91f", + "name": "Recursive Character Text Splitter", + "type": "@n8n/n8n-nodes-langchain.textSplitterRecursiveCharacterTextSplitter", + "typeVersion": 1, + "position": [ + 300, + 1160 + ] + }, + { + "parameters": { + "batchSize": 10, + "options": {} + }, + "id": "4e8a9d4c-6009-4d9b-b603-0438c65ba9df", + "name": "Loop Over Items", + "type": "n8n-nodes-base.splitInBatches", + "typeVersion": 3, + "position": [ + -840, + 1040 + ] + }, + { + "parameters": { + "model": { + "__rl": true, + "value": "gpt-4o", + "mode": "list", + "cachedResultName": "gpt-4o" + }, + "options": {}, + "requestOptions": {} + }, + "id": "e7967355-41b4-4bc5-b192-c8bc0699e925", + "name": "OpenAI Model", + "type": "@n8n/n8n-nodes-langchain.lmOpenAi", + "typeVersion": 1, + "position": [ + -1320, + 1680 + ], + "credentials": { + "openAiApi": { + "id": "tW3bkXa0SAK0OzvR", + "name": "OpenAi account Debs" + } + } + }, + { + "parameters": { + "url": "https://n8n-io.github.io/n8n-demo-website/sitemap.xml", + "options": {} + }, + "id": "5fb88663-f28b-4da2-acd9-1cbb0c5d28e7", + "name": "Get sitemap", + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + -1480, + 740 + ] + }, + { + "parameters": { + "options": { + "explicitRoot": false, + "ignoreAttrs": true + } + }, + "id": "0e6287b8-9a65-4af0-8e69-3aae3648fd13", + "name": "Turn XML sitemap into JSON", + "type": "n8n-nodes-base.xml", + "typeVersion": 1, + "position": [ + -1260, + 740 + ] + }, + { + "parameters": { + "fieldToSplitOut": "url", + "options": {} + }, + "id": "acd3e717-99f5-4238-aa4d-795caef660b1", + "name": "Turn the URL array into multiple items", + "type": "n8n-nodes-base.splitOut", + "typeVersion": 1, + "position": [ + -1040, + 740 + ] + }, + { + "parameters": {}, + "id": "f3b4ad5e-b261-4b97-9077-3b9259d5b37d", + "name": "Wait 5 seconds", + "type": "n8n-nodes-base.wait", + "typeVersion": 1.1, + "position": [ + -320, + 1060 + ], + "webhookId": "f4e7dead-77ad-4216-a5a0-ef95914bf3ab" + }, + { + "parameters": { + "url": "={{ $json.loc }}", + "options": {} + }, + "id": "361b2a70-d0c5-4498-8a70-0688710e76e6", + "name": "Get pages listed in the sitemap", + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.2, + "position": [ + -580, + 1060 + ] + }, + { + "parameters": {}, + "id": "14ddd282-9bf0-459f-9595-5154e16f9cc0", + "name": "Chat Trigger", + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "typeVersion": 1, + "position": [ + -1620, + 1420 + ], + "webhookId": "4b338d3c-b03f-42f2-94c1-9353d0f1fbc2" + }, + { + "parameters": { + "promptType": "define", + "text": "={{ $('Chat Trigger').item.json.chatInput }}" + }, + "id": "263585e6-02bb-4940-9bb3-15f32b0f8079", + "name": "Question and Answer Chain", + "type": "@n8n/n8n-nodes-langchain.chainRetrievalQa", + "typeVersion": 1.3, + "position": [ + -1280, + 1420 + ] + }, + { + "parameters": { + "topK": 10, + "requestOptions": {} + }, + "id": "91ad53ec-a761-43f6-a6f1-835263222e0c", + "name": "Vector Store Retriever", + "type": "@n8n/n8n-nodes-langchain.retrieverVectorStore", + "typeVersion": 1, + "position": [ + -1080, + 1620 + ] + }, + { + "parameters": { + "model": "text-embedding-3-large", + "options": {}, + "requestOptions": {} + }, + "id": "5c55cb38-be26-405d-bd39-d29e0a33b683", + "name": "Embeddings OpenAI2", + "type": "@n8n/n8n-nodes-langchain.embeddingsOpenAi", + "typeVersion": 1, + "position": [ + -780, + 2040 + ], + "credentials": { + "openAiApi": { + "id": "tW3bkXa0SAK0OzvR", + "name": "OpenAi account Debs" + } + } + }, + { + "parameters": { + "fieldsToAggregate": { + "fieldToAggregate": [ + { + "fieldToAggregate": "content" + } + ] + }, + "options": {} + }, + "id": "48dbd7f7-1ca1-41e2-9fd5-e916ea76589b", + "name": "Aggregate", + "type": "n8n-nodes-base.aggregate", + "typeVersion": 1, + "position": [ + -100, + 740 + ] + }, + { + "parameters": { + "content": "**Aggregate into one item**\n\nThe Pinecone node loops over each input item. This is standard n8n node behavior.\n\nThis means if you want to use the **Clear namespace** setting in the Pinecone node, you need to input a single item.", + "height": 381.66422439067196, + "color": 5 + }, + "id": "5b70d4ae-1889-43d3-b92d-bf73e43236bd", + "name": "Sticky Note", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -160, + 520 + ] + }, + { + "parameters": { + "content": "### Workflow to scrape data and send it to Pinecone", + "height": 878.8927796727229, + "width": 2382.6739342193496, + "color": 7 + }, + "id": "e9b5d557-51af-48d1-af33-8783f9ca3718", + "name": "Sticky Note1", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -1856.703373323493, + 480 + ] + }, + { + "parameters": { + "content": "### Workflow to chat and get answers from the Pinecone vector database", + "height": 825.9872504327399, + "width": 1181.407211476183, + "color": 7 + }, + "id": "7efa097b-d4f2-49a4-9da5-4fcf6b83be3b", + "name": "Sticky Note2", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -1680, + 1380 + ] + }, + { + "parameters": { + "content": "## Try it out \n\n1. Set credentials and choose your Pinecone vector database. See the notes on individual nodes for details.\n2. Select **Execute workflow** to run the main workflow and load data into Pinecone.\n3. Select **Chat** and try asking:\n\n_What is the purpose of the n8n demo website?_", + "height": 326.49681260818465, + "color": 4 + }, + "id": "f21bc32b-a405-4d71-b6c9-7bffbb6faed9", + "name": "Sticky Note3", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -2040, + 560 + ] + }, + { + "parameters": { + "content": "**Setup**\n\n1. In Pinecone, create a vector database. Set **Dimensions** to `3072` and **Metric** to `cosine`. You can use the free starter plan.\n2. In the Pinecone node, set your credentials.\n3. Select your Pinecone index.", + "height": 381.3701016273242, + "width": 304.1011298750183, + "color": 2 + }, + "id": "4be87782-f811-418f-b4b5-9e12c4cf7970", + "name": "Sticky Note4", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 140, + 520 + ] + }, + { + "parameters": { + "mode": "insert", + "pineconeIndex": { + }, + "options": { + "clearNamespace": true, + "pineconeNamespace": "test-web-scraper" + } + }, + "id": "94035a97-5a09-493c-aaae-dcba7bbf8526", + "name": "Pinecone Vector Store", + "type": "@n8n/n8n-nodes-langchain.vectorStorePinecone", + "typeVersion": 1, + "position": [ + 160, + 740 + ], + "credentials": { + "pineconeApi": { + "id": "lruA9GaKZSEY8dky", + "name": "Debs Pinecone" + } + } + }, + { + "parameters": { + "content": "## Next steps\n\nLearn more about [Advanced AI in n8n](https://docs.n8n.io/advanced-ai/)", + "width": 331.8066536811489 + }, + "id": "2be1433b-0488-4c7e-8c10-e771d4dd4686", + "name": "Sticky Note5", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 460, + 1280 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 206.68134932939768, + "width": 182.42633582707612, + "color": 2 + }, + "id": "fffbb04d-6d61-4dfa-bfd3-46b8c92a36d5", + "name": "Sticky Note6", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 20, + 1000 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 184.89671964234537, + "width": 173.09006596119673, + "color": 2 + }, + "id": "810ac5e1-d730-47af-9282-64ab0b4fca16", + "name": "Sticky Note7", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -1369.107685156473, + 1620.2285847094058 + ] + }, + { + "parameters": { + "content": "**Set your credentials**", + "height": 192.67694453057842, + "width": 221.3274602682409, + "color": 2 + }, + "id": "2cecc8ac-3c65-4294-8a5d-2842bc07d10a", + "name": "Sticky Note8", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -860, + 1980 + ] + }, + { + "parameters": { + "pineconeIndex": { + "__rl": true, + "value": "debs-test", + "mode": "list", + "cachedResultName": "debs-test" + }, + "options": { + "pineconeNamespace": "test-web-scraper" + } + }, + "id": "e673c46e-0815-4b58-9a8f-2fb86445b578", + "name": "Pinecone Vector Store2", + "type": "@n8n/n8n-nodes-langchain.vectorStorePinecone", + "typeVersion": 1, + "position": [ + -980, + 1840 + ], + "credentials": { + "pineconeApi": { + "id": "lruA9GaKZSEY8dky", + "name": "Debs Pinecone" + } + } + }, + { + "parameters": { + "content": "**Set your credentials**\n\n**Select your Pinecone index***", + "width": 367.59568816702017, + "color": 2 + }, + "id": "ca4499ae-4e27-4848-9654-f7e744c081e7", + "name": "Sticky Note9", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -1080, + 1760 + ] + }, + { + "parameters": {}, + "id": "b43ddbd1-adfd-4bba-bee5-4b81229e88dd", + "name": "Start the workflow by clicking \"Execute workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + -1700, + 740 + ] + }, + { + "parameters": { + "operation": "extractHtmlContent", + "extractionValues": { + "values": [ + { + "key": "content", + "cssSelector": ".md-content", + "returnValue": "html" + } + ] + }, + "options": { + "trimValues": true, + "cleanUpText": true + } + }, + "id": "d39624d7-93c0-4452-81b1-ffa04b216ceb", + "name": "Extract main content", + "type": "n8n-nodes-base.html", + "typeVersion": 1.2, + "position": [ + -380, + 740 + ] + }, + { + "parameters": { + "content": "**Batch the calls to the website**\n\nFor the small demo website in this example, this is not essential. If you want to use this example with a larger website, batching like this helps avoid timeouts. Using the Wait node between batches avoids hitting the website with too many requests too fast.", + "height": 298.48800301054644, + "width": 316.2462039046831, + "color": 5 + }, + "id": "9825926d-ce6d-429e-9006-6ff5fd1f46ca", + "name": "Sticky Note10", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -1220, + 1020 + ] + }, + { + "parameters": { + "content": "## How to scrape a different website\n\nThis workflow uses a small example website provided by n8n. To use a different site:\n\n1. Change the sitemap URL in **Get sitemap**.\n2. Update **Extract main content** according to the HTML structure of the website you're scraping.", + "height": 356.06166718347 + }, + "id": "7c2e4bde-3900-49b0-9bee-704e34664163", + "name": "Sticky Note11", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + -2040, + 960 + ] + } + ], + "pinData": {}, + "connections": { + "Embeddings OpenAI": { + "ai_embedding": [ + [ + { + "node": "Pinecone Vector Store", + "type": "ai_embedding", + "index": 0 + } + ] + ] + }, + "Default Data Loader": { + "ai_document": [ + [ + { + "node": "Pinecone Vector Store", + "type": "ai_document", + "index": 0 + } + ] + ] + }, + "Recursive Character Text Splitter": { + "ai_textSplitter": [ + [ + { + "node": "Default Data Loader", + "type": "ai_textSplitter", + "index": 0 + } + ] + ] + }, + "Loop Over Items": { + "main": [ + [ + { + "node": "Extract main content", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Get pages listed in the sitemap", + "type": "main", + "index": 0 + } + ] + ] + }, + "Get sitemap": { + "main": [ + [ + { + "node": "Turn XML sitemap into JSON", + "type": "main", + "index": 0 + } + ] + ] + }, + "Turn XML sitemap into JSON": { + "main": [ + [ + { + "node": "Turn the URL array into multiple items", + "type": "main", + "index": 0 + } + ] + ] + }, + "Turn the URL array into multiple items": { + "main": [ + [ + { + "node": "Loop Over Items", + "type": "main", + "index": 0 + } + ] + ] + }, + "Wait 5 seconds": { + "main": [ + [ + { + "node": "Loop Over Items", + "type": "main", + "index": 0 + } + ] + ] + }, + "Get pages listed in the sitemap": { + "main": [ + [ + { + "node": "Wait 5 seconds", + "type": "main", + "index": 0 + } + ] + ] + }, + "Chat Trigger": { + "main": [ + [ + { + "node": "Question and Answer Chain", + "type": "main", + "index": 0 + } + ] + ] + }, + "OpenAI Model": { + "ai_languageModel": [ + [ + { + "node": "Question and Answer Chain", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "Vector Store Retriever": { + "ai_retriever": [ + [ + { + "node": "Question and Answer Chain", + "type": "ai_retriever", + "index": 0 + } + ] + ] + }, + "Embeddings OpenAI2": { + "ai_embedding": [ + [ + { + "node": "Pinecone Vector Store2", + "type": "ai_embedding", + "index": 0 + } + ] + ] + }, + "Aggregate": { + "main": [ + [ + { + "node": "Pinecone Vector Store", + "type": "main", + "index": 0 + } + ] + ] + }, + "Pinecone Vector Store2": { + "ai_vectorStore": [ + [ + { + "node": "Vector Store Retriever", + "type": "ai_vectorStore", + "index": 0 + } + ] + ] + }, + "Start the workflow by clicking \"Execute workflow\"": { + "main": [ + [ + { + "node": "Get sitemap", + "type": "main", + "index": 0 + } + ] + ] + }, + "Extract main content": { + "main": [ + [ + { + "node": "Aggregate", + "type": "main", + "index": 0 + } + ] + ] + } + } +} + + +// docs/_workflows/advanced-ai/tutorials/chat_01.json +{ + "name": "AI tutorial", + "nodes": [ + { + "parameters": { + "options": {} + }, + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "typeVersion": 1.1, + "position": [ + -200, + -40 + ], + "id": "a2d42e1f-36df-4a6a-a3b4-99a162074d11", + "name": "When chat message received", + "webhookId": "97c1a41f-8ef0-4d63-a924-92eb634384d3" + } + ], + "pinData": {}, + "connections": {}, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "b1641385-c6b0-48a8-8e26-20d1f6bd7fda", + "meta": { + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "id": "l05TkWXXYbOiuL4o", + "tags": [] + } + +// docs/_workflows/advanced-ai/tutorials/chat_02.json +{ + "name": "AI tutorial", + "nodes": [ + { + "parameters": { + "options": {} + }, + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "typeVersion": 1.1, + "position": [ + -300, + -40 + ], + "id": "a2d42e1f-36df-4a6a-a3b4-99a162074d11", + "name": "When chat message received", + "webhookId": "97c1a41f-8ef0-4d63-a924-92eb634384d3" + }, + { + "parameters": { + "options": {} + }, + "type": "@n8n/n8n-nodes-langchain.agent", + "typeVersion": 1.7, + "position": [ + -80, + -40 + ], + "id": "0f61a10f-668f-42f7-b835-cf3efb60082a", + "name": "AI Agent" + } + ], + "pinData": {}, + "connections": { + "When chat message received": { + "main": [ + [ + { + "node": "AI Agent", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "b1641385-c6b0-48a8-8e26-20d1f6bd7fda", + "meta": { + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "id": "l05TkWXXYbOiuL4o", + "tags": [] + } + +// docs/_workflows/advanced-ai/tutorials/chat_complete.json +{ + "name": "AI tutorial", + "nodes": [ + { + "parameters": { + "options": {} + }, + "type": "@n8n/n8n-nodes-langchain.chatTrigger", + "typeVersion": 1.1, + "position": [ + -300, + -40 + ], + "id": "a2d42e1f-36df-4a6a-a3b4-99a162074d11", + "name": "When chat message received", + "webhookId": "97c1a41f-8ef0-4d63-a924-92eb634384d3" + }, + { + "parameters": { + "options": {} + }, + "type": "@n8n/n8n-nodes-langchain.agent", + "typeVersion": 1.7, + "position": [ + -80, + -40 + ], + "id": "0f61a10f-668f-42f7-b835-cf3efb60082a", + "name": "AI Agent" + }, + { + "parameters": { + "model": { + "__rl": true, + "mode": "list", + "value": "gpt-4o-mini" + }, + "options": {} + }, + "type": "@n8n/n8n-nodes-langchain.lmChatOpenAi", + "typeVersion": 1.2, + "position": [ + -100, + 160 + ], + "id": "b8129c6d-f201-4378-8f66-ce9a6cfd5f3b", + "name": "OpenAI Chat Model", + "credentials": { + "openAiApi": { + "id": "jiPPcYV9I70iKapN", + "name": "OpenAi account 37" + } + } + }, + { + "parameters": {}, + "type": "@n8n/n8n-nodes-langchain.memoryBufferWindow", + "typeVersion": 1.3, + "position": [ + 20, + 180 + ], + "id": "afbab05c-1e87-4f7a-9d66-c86f9db1ec64", + "name": "Simple Memory" + } + ], + "pinData": {}, + "connections": { + "When chat message received": { + "main": [ + [ + { + "node": "AI Agent", + "type": "main", + "index": 0 + } + ] + ] + }, + "OpenAI Chat Model": { + "ai_languageModel": [ + [ + { + "node": "AI Agent", + "type": "ai_languageModel", + "index": 0 + } + ] + ] + }, + "Simple Memory": { + "ai_memory": [ + [ + { + "node": "AI Agent", + "type": "ai_memory", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "b1641385-c6b0-48a8-8e26-20d1f6bd7fda", + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "id": "l05TkWXXYbOiuL4o", + "tags": [] + } + +// docs/_workflows/credentials/dynamic_credentials_using_expressions.json +{ + "name": "Dynamic credentials using expressions", + "nodes": [ + { + "parameters": { + "path": "da4071f2-7550-4dae-aa48-8bced4291643", + "formTitle": "Test dynamic credentials", + "formDescription": "This form is for testing an n8n workflow that demonstrates setting credentials with expressions.", + "formFields": { + "values": [ + { + "fieldLabel": "Enter your NASA API key", + "requiredField": true + } + ] + }, + "responseMode": "responseNode" + }, + "id": "cc6f2b1e-0ed0-4d22-8a44-d7223ba283b4", + "name": "n8n Form Trigger", + "type": "n8n-nodes-base.formTrigger", + "typeVersion": 2, + "position": [ + 560, + 520 + ], + "webhookId": "da4071f2-7550-4dae-aa48-8bced4291643" + }, + { + "parameters": { + "additionalFields": {} + }, + "id": "ef336bae-3d4f-419c-ab5c-b9f0de89f170", + "name": "NASA", + "type": "n8n-nodes-base.nasa", + "typeVersion": 1, + "position": [ + 900, + 520 + ], + "credentials": { + "nasaApi": { + "id": "QDDBOZOD6k3ijL5t", + "name": "NASA account" + } + } + }, + { + "parameters": { + "respondWith": "redirect", + "redirectURL": "={{ $json.url }}", + "options": {} + }, + "id": "143bcdb6-aca0-4dd8-9204-9777271cd230", + "name": "Respond to Webhook", + "type": "n8n-nodes-base.respondToWebhook", + "typeVersion": 1, + "position": [ + 1220, + 520 + ] + }, + { + "parameters": { + "content": "This workflow shows how to set credentials dynamically using expressions.\n\n\nFirst, set up your NASA credential: \n\n1. Create a new NASA credential.\n1. Hover over **API Key**.\n1. Toggle **Expression** on.\n1. In the **API Key** field, enter `{{ $json[\"Enter your NASA API key\"] }}`.\n\n\nThen, test the workflow:\n\n1. Get an [API key from NASA](https://api.nasa.gov/)\n2. Select **Execute workflow**\n3. Enter your key using the form.\n4. The workflow runs and sends you to the NASA picture of the day.\n\n\nFor more information on expressions, refer to [n8n documentation | Expressions](https://docs.n8n.io/code/expressions/).", + "height": 564, + "width": 322, + "color": 4 + }, + "id": "0a0dee23-fa16-4f09-b5e0-856f47fb53d0", + "name": "Sticky Note", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 120, + 140 + ] + }, + { + "parameters": { + "content": "User submits an API key using the form", + "height": 319 + }, + "id": "dd766e32-334d-4e46-9daa-7800b134a3a5", + "name": "Sticky Note1", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 500, + 380 + ] + }, + { + "parameters": { + "content": "The workflow passes the key to the NASA node. You can reference the value using the expression `$json[\"Enter your NASA API key\"]`. This is also available to the node credential. ", + "height": 319, + "color": 5 + }, + "id": "3d8f02e6-e029-41dc-89ad-0f5cffe09348", + "name": "Sticky Note2", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 820, + 380 + ] + }, + { + "parameters": { + "content": "The Respond to Webhook node controls the form response (in this example, redirecting the user to an image)", + "height": 319 + }, + "id": "096eb6ab-c276-4687-9dc0-50e16a8f709a", + "name": "Sticky Note3", + "type": "n8n-nodes-base.stickyNote", + "typeVersion": 1, + "position": [ + 1140, + 380 + ] + } + ], + "pinData": {}, + "connections": { + "n8n Form Trigger": { + "main": [ + [ + { + "node": "NASA", + "type": "main", + "index": 0 + } + ] + ] + }, + "NASA": { + "main": [ + [ + { + "node": "Respond to Webhook", + "type": "main", + "index": 0 + } + ] + ] + } + } +} + + +// docs/_workflows/ai-code/data-transformation.json +{ + "name": "Data transformation", + "nodes": [ + { + "parameters": {}, + "id": "3ada6076-1cfb-4c2d-a421-4fce5466fc2d", + "name": "When clicking \"Execute Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 1340, + 840 + ] + }, + { + "parameters": { + "jsCode": "return [\n{\n\"user_id\":\n\"0001\",\n\"username\":\n\"nathan\",\n\"date\":\n\"2023-08-10\",\n\"variant\":\n\"control\",\n\"data_exec_success\":\n\"TRUE\"\n},\n{\n\"user_id\":\n\"0002\",\n\"username\":\n\"natalie\",\n\"date\":\n\"2023-08-10\",\n\"variant\":\n\"control\",\n\"data_exec_success\":\n\"TRUE\"\n},\n{\n\"user_id\":\n\"0003\",\n\"username\":\n\"nadia\",\n\"date\":\n\"2023-08-10\",\n\"variant\":\n\"control\",\n\"data_exec_success\":\n\"FALSE\"\n},\n{\n\"user_id\":\n\"naomi\",\n\"username\":\n\"hkhjk\",\n\"date\":\n\"2023-08-10\",\n\"variant\":\n\"control\",\n\"data_exec_success\":\n\"FALSE\"\n},\n{\n\"user_id\":\n\"0005\",\n\"username\":\n\"nolan\",\n\"date\":\n\"2023-08-10\",\n\"variant\":\n\"control\",\n\"data_exec_success\":\n\"FALSE\"\n}\n]" + }, + "id": "08e4d878-01ab-4f01-ab27-84ef5afbf581", + "name": "Code", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1560, + 840 + ] + }, + { + "parameters": {}, + "id": "57a9330b-9e46-42a6-b432-681e906de93a", + "name": "Join items", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1780, + 840 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute Workflow\"": { + "main": [ + [ + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code": { + "main": [ + [ + { + "node": "Join items", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "d7409102-d3af-4ddf-bead-2df008554458", + "id": "B4K5I5pN4nqu85ac", + "meta": { + "instanceId": "c5aabef739d71e3d0ceb8b6078a241aaf1b145fa71cbbe36ecfb2c8c3fd64f5f" + }, + "tags": [] +} + +// docs/_workflows/ai-code/find-a-piece-of-data.json +{ + "name": "Find a piece of data", + "nodes": [ + { + "parameters": {}, + "id": "5319a081-f4f9-44ac-a91e-a57270e6eaa8", + "name": "When clicking \"Execute Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 460, + 460 + ] + }, + { + "parameters": { + "jsCode": "return [\n{\n\"title\":\n\"\",\n\"phone\":\n\"\",\n\"skype\":\n\"\",\n\"real_name\":\n\"Nathan Berlin\",\n\"email\": \"nathan@example.io\",\n\"real_name_normalized\":\n\"Nathan Berlin\",\n\"display_name\":\n\"Nathan Berlin\",\n\"display_name_normalized\":\n\"Nathan Berlin\",\n\"fields\":\n{\n},\n\"status_text\":\n\"\",\n\"status_emoji\":\n\"\",\n\"status_emoji_display_info\":\n[\n],\n\"status_expiration\":\n0,\n\"avatar_hash\":\n\"0856f5fbbd43\",\n\"image_original\":\n\"https://example.png\",\n\"is_custom_image\":\ntrue,\n\"huddle_state\":\n\"default_unset\",\n\"huddle_state_expiration_ts\":\n0,\n\"first_name\":\n\"Nathan\",\n\"last_name\":\n\"Berlin\",\n\"image_24\":\n\"https://example.png\",\n\"image_32\":\n\"https://example.png\",\n\"image_48\":\n\"https://example.png\",\n\"image_72\":\n\"https://example.png\",\n\"image_192\":\n\"https://example.png\",\n\"image_512\":\n\"https://example.png\",\n\"image_1024\":\n\"https://example.png\",\n\"status_text_canonical\":\n\"\"\n}\n]" + }, + "id": "3ec439bc-7e3f-4ec2-b724-092466efaa18", + "name": "Mock Slack", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 680, + 460 + ] + }, + { + "parameters": { + "jsCode": "return [\n{\n\"object\":\n\"user\",\n\"id\":\n\"1234\",\n\"name\":\n\"Nathan Berlin\",\n\"avatar_url\":\n\"https://example.jpeg\",\n\"type\":\n\"person\",\n\"person\":\n{\n\"email\":\n\"nathan@example.io\"\n}\n},\n{\n\"object\":\n\"user\",\n\"id\":\n\"5678\",\n\"name\":\n\"Natalie Berlin\",\n\"avatar_url\":\n\"https://example.jpeg\",\n\"type\":\n\"person\",\n\"person\":\n{\n\"email\":\n\"natalie@example.io\"\n}\n}\n]" + }, + "id": "4bb97ec6-c73a-4f01-b935-a94ffbf15d23", + "name": "Mock Notion", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 900, + 460 + ] + }, + { + "parameters": {}, + "id": "330ecf72-cff0-4ada-9b04-b1c99bb0f4de", + "name": "Code", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1120, + 460 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute Workflow\"": { + "main": [ + [ + { + "node": "Mock Slack", + "type": "main", + "index": 0 + } + ] + ] + }, + "Mock Slack": { + "main": [ + [ + { + "node": "Mock Notion", + "type": "main", + "index": 0 + } + ] + ] + }, + "Mock Notion": { + "main": [ + [ + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "81cabd2b-2854-4afb-b656-90a0cb77fa96", + "id": "3Brrdjs5aRHo57EX", + "meta": { + "instanceId": "c5aabef739d71e3d0ceb8b6078a241aaf1b145fa71cbbe36ecfb2c8c3fd64f5f" + }, + "tags": [] +} + +// docs/_workflows/ai-code/reference-incoming-data-explicitly.json +{ + "name": "Reference incoming data explicitly", + "nodes": [ + { + "parameters": {}, + "id": "0abbe7f6-f8a0-4f71-8229-f4fd1a3c2683", + "name": "When clicking \"Execute Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 620, + 520 + ] + }, + { + "parameters": { + "jsCode": "return [\n {\n \"id\": 0001,\n \"personal_info\": {\n \"first_name\": \"Natalie\",\n \"surname\": \"Berlin\"\n },\n \"work_info\": {\n \"job_title\": \"Automation engineer\"\n }\n },\n {\n \"id\": 0002,\n \"personal_info\": {\n \"first_name\": \"Nathan\",\n \"surname\": \"Berlin\"\n },\n \"work_info\": {\n \"job_title\": \"Automation designer\"\n }\n }\n]" + }, + "id": "e19f11cd-c868-4aca-b88e-04b4ee6f0187", + "name": "Mock data", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 840, + 520 + ] + }, + { + "parameters": {}, + "id": "ef54d477-0596-441a-98e5-1ab005e9a268", + "name": "Code", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1060, + 520 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute Workflow\"": { + "main": [ + [ + { + "node": "Mock data", + "type": "main", + "index": 0 + } + ] + ] + }, + "Mock data": { + "main": [ + [ + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "4e3a0a21-c993-4851-848b-01bd5c090b6b", + "id": "EipyYyqKKQm7siq4", + "meta": { + "instanceId": "c5aabef739d71e3d0ceb8b6078a241aaf1b145fa71cbbe36ecfb2c8c3fd64f5f" + }, + "tags": [] +} + +// docs/_workflows/ai-code/summarize-data.json +{ + "name": "Summarize data and prepare Slack message", + "nodes": [ + { + "parameters": {}, + "id": "5d4bd82f-24e9-484e-a17e-c5de889087d9", + "name": "When clicking \"Execute Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 860, + 540 + ] + }, + { + "parameters": {}, + "id": "0d73c3df-300a-4397-8f53-fb0750dbf97f", + "name": "Summarize", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1300, + 540 + ] + }, + { + "parameters": { + "jsCode": "return [\n{\n\"id\":\n\"0001\",\n\"name\":\n\"Example feature 1\",\n\"url\": \"example.com\",\n\"property_tags\":\n[\n],\n\"property_type\":\n[\n\"Feature\"\n],\n\"property_votes\":\n2\n},\n{\n\"id\":\n\"0002\",\n\"name\":\n\"Example feature 2\",\n\"url\": \"example.com\",\n\"property_type\":\n[\n\"Feature\"\n],\n\"property_votes\":\n3\n},\n{\n\"id\":\n\"0003\",\n\"name\":\n\"Example feature 3\",\n\"url\": \"example.com\",\n\"property_type\":\n[\n\"Feature\"\n],\n\"property_votes\":\n1\n},\n{\n\"id\":\n\"0004\",\n\"name\":\n\"Example bug 1\",\n\"url\": \"example.com\",\n\"property_type\":\n[\n\"Bug\"\n],\n\"property_votes\":\n0\n},\n{\n\"id\":\n\"0005\",\n\"name\":\n\"Example idea 1\",\n\"url\": \"example.com\",\n\"property_type\":\n[\n\"Idea\"\n],\n\"property_votes\":\n4\n}\n]" + }, + "id": "fda17968-61a5-4c0b-ab83-adb4e0bbf7c5", + "name": "Mock Ideas", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 1080, + 540 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute Workflow\"": { + "main": [ + [ + { + "node": "Mock Ideas", + "type": "main", + "index": 0 + } + ] + ] + }, + "Mock Ideas": { + "main": [ + [ + { + "node": "Summarize", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "active": false, + "settings": { + "executionOrder": "v1" + }, + "versionId": "077fe5dc-2214-4149-9f1b-ef6342e45dec", + "id": "5IoF8z4YUoSUpBUk", + "meta": { + "instanceId": "c5aabef739d71e3d0ceb8b6078a241aaf1b145fa71cbbe36ecfb2c8c3fd64f5f" + }, + "tags": [] +} \ No newline at end of file diff --git a/llms/advanced-ai.md b/llms/advanced-ai.md new file mode 100644 index 00000000000..64bd8a0f699 --- /dev/null +++ b/llms/advanced-ai.md @@ -0,0 +1,1009 @@ + + +# advanced-ai/examples/agent-chain-comparison.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +title: Agents vs chains +description: A workflow example that demonstrates key differences between agents and chains. +--- + +# Demonstration of key differences between agents and chains + +In this workflow you can choose whether your chat query goes to an [agent](/glossary.md#ai-agent) or [chain](/glossary.md#ai-chain). It shows some of the ways that agents are more powerful than chains. + +[[ workflowDemo("file:///advanced-ai/examples/agents_vs_chains.json") ]] + +## Key features + +This workflow uses: + +* [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md): start your workflow and respond to user chat interactions. The node provides a customizable chat interface. +* [Switch node](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md): directs your query to either the agent or chain, depending on which you specify in your query. If you say "agent" it sends it to the agent. If you say "chain" it sends it to the chain. +* [Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md): the Agent node interacts with other components of the workflow and makes decisions about what [tools](/glossary.md#ai-tool) to use. +* [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md): the Basic LLM Chain node supports chatting with a connected LLM, but doesn't support [memory](/glossary.md#ai-memory) or tools. + + +## Using the example + +--8<-- "_snippets/examples-color-key.md" + + +# advanced-ai/examples/api-workflow-tool.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +title: Call an API to fetch data +description: Use the n8n workflow tool to load data from an API using the HTTP Request node into your AI workflow. +--- + +# Call an API to fetch data + +Use n8n to bring data from any [API](/glossary.md#api) to your AI. This workflow uses the [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) to provide the chat interface, and the [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) to call a second workflow that calls the API. The second workflow uses AI functionality to refine the API request based on the user's query. + +[[ workflowDemo("file:///advanced-ai/examples/let_your_ai_call_an_api.json") ]] + +## Key features + +This workflow uses: + +* [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md): start your workflow and respond to user chat interactions. The node provides a customizable chat interface. +* [Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md): the key piece of the AI workflow. The Agent interacts with other components of the workflow and makes decisions about what tools to use. +* [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md): plug in n8n workflows as custom tools. In AI, a tool is an interface the AI can use to interact with the world (in this case, the data provided by your workflow). The AI model uses the tool to access information beyond its built-in dataset. +* A [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md) with an [Auto-fixing Output Parser](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserautofixing.md) and [Structured Output Parser](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/index.md) to read the user's query and set parameters for the API call based on the user input. + +## Using the example + +--8<-- "_snippets/examples-color-key.md" + + +# advanced-ai/examples/data-google-sheets.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +title: Chat with a Google Sheet using AI +description: Use the n8n workflow tool to load data from Google Sheets into your AI workflow. +--- + +# Chat with a Google Sheet using AI + +Use n8n to bring your own data to AI. This workflow uses the [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) to provide the chat interface, and the [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) to call a second workflow that queries Google Sheets. + +[[ workflowDemo("file:///advanced-ai/examples/chat_with_google_sheets_docs_version.json") ]] + +## Key features + +This workflow uses: + +* [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md): start your workflow and respond to user chat interactions. The node provides a customizable chat interface. +* [Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md): the key piece of the AI workflow. The Agent interacts with other components of the workflow and makes decisions about what tools to use. +* [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md): plug in n8n workflows as custom tools. In AI, a tool is an interface the AI can use to interact with the world (in this case, the data provided by your workflow). The AI model uses the tool to access information beyond its built-in dataset. + + +## Using the example + +--8<-- "_snippets/examples-color-key.md" + + +# advanced-ai/examples/human-fallback.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +title: Set a human fallback for AI workflows +description: Have a workflow that triggers a human answer when the AI can't help. +--- + +# Have a human fallback for AI workflows + +This is a workflow that tries to answer user queries using the standard GPT-4 model. If it can't answer, it sends a message to Slack to ask for human help. It prompts the user to supply an email address. + +This workflow uses the [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) to provide the chat interface, and the [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) to call a second workflow that handles checking for email addresses and sending the Slack message. + +[[ workflowDemo("file:///advanced-ai/examples/ask_a_human.json") ]] + +## Key features + +This workflow uses: + +* [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md): start your workflow and respond to user chat interactions. The node provides a customizable chat interface. +* [Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md): the key piece of the AI workflow. The Agent interacts with other components of the workflow and makes decisions about what tools to use. +* [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md): plug in n8n workflows as custom tools. In AI, a tool is an interface the AI can use to interact with the world (in this case, the data provided by your workflow). It allows the AI model to access information beyond its built-in dataset. + +## Using the example + +--8<-- "_snippets/examples-color-key.md" + + +# advanced-ai/examples/introduction.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +title: Advanced AI examples and concepts +description: Example workflows and use cases for building AI functionality using n8n. +hide: + - toc +--- + +# Advanced AI examples and concepts + +This section provides explanations of important AI concepts, and workflow templates that highlight those concepts, with explanations and configuration guides. The examples cover common use cases and highlight different features of advanced AI in n8n. + +
+ +- __Agents and chains__ + + Learn about [agents](/glossary.md#ai-agent) and [chains](/glossary.md#ai-chain) in AI, including exploring key differences using the example workflow. + + [:octicons-arrow-right-24: What's a chain in AI?](/advanced-ai/examples/understand-chains.md) + [:octicons-arrow-right-24: What's an agent in AI?](/advanced-ai/examples/understand-agents.md) + [:octicons-arrow-right-24: Demonstration of key differences between agents and chains](/advanced-ai/examples/agent-chain-comparison.md) + +- __Call n8n Workflow Tool__ + + Learn about [tools](/glossary.md#ai-tool) in AI, then explore examples that use n8n workflows as custom tools to give your AI workflow access to more data. + + [:octicons-arrow-right-24: What's a tool in AI?](/advanced-ai/examples/understand-tools.md) + [:octicons-arrow-right-24: Chat with Google Sheets](/advanced-ai/examples/data-google-sheets.md) + [:octicons-arrow-right-24: Call an API to fetch data](/advanced-ai/examples/api-workflow-tool.md) + [:octicons-arrow-right-24: Set up a human fallback](/advanced-ai/examples/human-fallback.md) + [:octicons-arrow-right-24: Let AI specify tool parameters with `$fromAI()`](/advanced-ai/examples/using-the-fromai-function.md) + +- __Vector databases__ + + Learn about [vector databases](/glossary.md#ai-vector-store) in AI, along with related concepts including [embeddings](/glossary.md#ai-embedding) and retrievers. + + [:octicons-arrow-right-24: What's a vector database?](/advanced-ai/examples/understand-vector-databases.md) + [:octicons-arrow-right-24: Populate a Pinecone vector database from a website](/advanced-ai/examples/vector-store-website.md) + +- __Memory__ + + Learn about [memory](/glossary.md#ai-memory) in AI. + + [:octicons-arrow-right-24: What's memory in AI?](/advanced-ai/examples/understand-memory.md) + +- __AI workflow templates__ + + You can browse AI templates, included community contributions, on the n8n website. + + [:octicons-arrow-right-24: Browse all AI templates](https://n8n.io/workflows/?categories=25){:target=_blank .external-link} + + + +
+ + +# advanced-ai/examples/understand-agents.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: What's an agent in AI? +description: Understand agents in the context of AI. Learn how n8n provides agents. +contentType: explanation +--- + +# What's an agent in AI? + +One way to think of an [agent](/glossary.md#ai-agent) is as a [chain](/advanced-ai/examples/understand-chains.md) that knows how to make decisions. Where a chain follows a predetermined sequence of calls to different AI components, an agent uses a language model to determine which actions to take. + +Agents are the part of AI that act as decision-makers. They can interact with other agents and [tools](/glossary.md#ai-tool). When you send a query to an agent, it tries to choose the best tools to use to answer. Agents adapt to your specific queries, as well as the prompts that configure their behavior. + +## Agents in n8n + +n8n provides one Agent node, which can act as different types of agent depending on the settings you choose. Refer to the [Agent node documentation](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for details on the available agent types. + +When execute a workflow containing an agent, the agent runs multiple times. For example, it may do an initial setup, followed by a run to call a tool, then another run to evaluate the tool response and respond to the user. + + +# advanced-ai/examples/understand-chains.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: What's a chain in AI? +description: Understand chains in the context of AI. Learn about chains in n8n. +contentType: explanation +--- + +# What's a chain in AI? + +[Chains](/glossary.md#ai-chain) bring together different components of AI to create a cohesive system. They set up a sequence of calls between the components. These components can include models and [memory](/glossary.md#ai-memory) (though note that in n8n chains can't use memory). + + +## Chains in n8n + +n8n provides three chain nodes: + +* [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md): use to interact with an LLM, without any additional components. +* [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md): can connect to a [vector store](/glossary.md#ai-vector-store) using a retriever, or to an n8n workflow using the Workflow Retriever node. Use this if you want to create a workflow that supports asking questions about specific documents. +* [Summarization Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainsummarization.md): takes an input and returns a summary. + +There's an important difference between chains in n8n and in other tools such as LangChain: none of the chain nodes support memory. This means they can't remember previous user queries. If you use LangChain to code an AI application, you can give your application memory. In n8n, if you need your workflow to support memory, use an agent. This is essential if you want users to be able to have a natural ongoing conversation with your app. + + +# advanced-ai/examples/understand-memory.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: What's memory in AI? +description: Understand memory in the context of AI. Learn what's special about memory in n8n. +contentType: explanation +--- + +# What's memory in AI? + +Memory is a key part of AI chat services. The [memory](/glossary.md#ai-memory) keeps a history of previous messages, allowing for an ongoing conversation with the AI, rather than every interaction starting fresh. + +## AI memory in n8n + +To add memory to your AI workflow you can use either: + +* [Simple Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md): stores a customizable length of chat history for the current session. This is the easiest to get started with. +* One of the memory services that n8n provides nodes for. These include: + * [Motorhead](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymotorhead.md) + * [Redis Chat Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryredischat.md) + * [Postgres Chat Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorypostgreschat.md) + * [Xata](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryxata.md) + * [Zep](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryzep.md) + +If you need to do advanced AI memory management in your workflows, use the [Chat Memory Manager](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymanager.md) node. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/chat-memory-manager-purpose.md" + + +# advanced-ai/examples/understand-tools.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: What's a tool in AI? +description: Understand tools in the context of AI. Learn what's special about tools in n8n. +contentType: explanation +--- + +# What's a tool in AI? + +In AI, 'tools' has a specific meaning. Tools act like addons that your AI can use to access extra context or resources. + +Here are a couple of other ways of expressing it: + +> Tools are interfaces that an agent can use to interact with the world ([source](https://langchain-ai.github.io/langgraphjs/how-tos/tool-calling/){:target=_blank .external-link}) + + + +> We can think of these tools as being almost like functions that your AI model can call ([source](https://www.udemy.com/course/chatgpt-and-langchain-the-complete-developers-masterclass/){:target=_blank .external-link}) + +## AI tools in n8n + +n8n provides tool [sub-nodes](/glossary.md#sub-node-n8n) that you can connect to your [AI agent](/glossary.md#ai-agent). As well as providing some popular tools, such as [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia.md) and [SerpAPI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi.md), n8n provides three especially powerful tools: + +* [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md): use this to load any n8n workflow as a tool. +* [Custom Code Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md): write code that your agent can run. +* [HTTP Request Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolhttprequest.md): make calls to fetch a website or data from an API. + +The next three examples highlight the Call n8n Workflow Tool: + +- [Chat with Google Sheets](/advanced-ai/examples/data-google-sheets.md) +- [Call an API to fetch data](/advanced-ai/examples/api-workflow-tool.md) +- [Set up a human fallback](/advanced-ai/examples/human-fallback.md) + +You can also learn how to [let AI dynamically specify parameters for tools with the `$fromAI()` function](/advanced-ai/examples/using-the-fromai-function.md). + + +# advanced-ai/examples/understand-vector-databases.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: What are vector databases? +description: Understand vector databases. Learn how n8n provides vector databases, along with the key components to work with them, including embeddings, retrievers, and document loaders. +contentType: explanation +--- + +# What are vector databases? + +Vector databases store information as numbers: + +> A vector database is a type of database that stores data as high-dimensional vectors, which are mathematical representations of features or attributes. ([source](https://learn.microsoft.com/en-us/semantic-kernel/memories/vector-db){:target=_blank .external-link}) + +This enables fast and accurate similarity searches. With a vector database, instead of using conventional database queries, you can search for relevant data based on semantic and contextual meaning. + +## A simplified example + +A vector database could store the sentence "n8n is a source-available automation tool that you can self-host", but instead of storing it as text, the vector database stores an array of dimensions (numbers between 0 and 1) that represent its features. This doesn't mean turning each letter in the sentence into a number. Instead, the vectors in the vector database describe the sentence. + +Suppose that in a vector store `0.1` represents `automation tool`, `0.2` represents `source available`, and `0.3` represents `can be self-hosted`. You could end up with the following vectors: + +| Sentence | Vector (array of dimensions) | +| -------- | ------ | +| n8n is a source-available automation tool that you can self-host | [0.1, 0.2, 0.3] | +| Zapier is an automation tool | [0.1] | +| Make is an automation tool | [0.1] | +| Confluence is a wiki tool that you can self-host | [0.3] | + +/// note | This example is very simplified +In practice, vectors are far more complex. A vector can range in size from tens to thousands of dimensions. The dimensions don't have a one-to-one relationship to a single feature, so you can't translate individual dimensions directly into single concepts. This example gives an approximate mental model, not a true technical understanding. +/// + + +## Demonstrating the power of similarity search + +Qdrant provides [vector search demos](https://qdrant.tech/demo/){:target=_blank .external-link} to help users understand the power of vector databases. The [food discovery demo](https://food-discovery.qdrant.tech/){:target=_blank .external-link} shows how a vector store can help match pictures based on visual similarities. + +> This demo uses data from Delivery Service. Users may like or dislike the photo of a dish, and the app will recommend more similar meals based on how they look. It's also possible to choose to view results from the restaurants within the delivery radius. ([source](https://qdrant.tech/demo/){:target=_blank .external-link}) + +For full technical details, refer to the [Qdrant demo-food-discovery GitHub repository](https://github.com/qdrant/demo-food-discovery){:target=_blank .external-link}. + +## Embeddings, retrievers, text splitters, and document loaders + +Vector databases require other tools to function: + +- Document loaders and text splitters: document loaders pull in documents and data, and prepare them for [embedding](/glossary.md#ai-embedding). Document loaders can use text splitters to break documents into chunks. +- Embeddings: these are the tools that turn the data (text, images, and so on) into vectors, and back into raw data. Note that n8n only supports text embeddings. +- Retrievers: retrievers fetch documents from vector databases. You need to pair them with an embedding to translate the vectors back into data. + + + + + + + +# advanced-ai/examples/using-the-fromai-function.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Let AI specify tool parameters +description: Understand how n8n's `$fromAI()` function works and how to use it to dynamically populate parameters for AI app tools, or use the built-in automation to complete them instead. +contentType: explanation +tags: + - $fromAI + - $fromAI() + - fromAI + - fromAI() +hide: + - tags +--- + +# Let AI specify the tool parameters + +When configuring [app node](/integrations/builtin/app-nodes/index.md) [tools](/glossary.md#ai-tool) connected to the Tools Agent, many parameters can be filled in by the AI model itself. The AI model will use the context from the task and information from other connected tools to fill in the appropriate details. + +There are two ways to do this, and you can switch between them. + +## Let the model fill in the parameter + +Each appropriate parameter field in the tool's editing dialog has an extra button at the end: + +![image showing stars icon to the right of parameter field](/_images/advanced-ai/ai-stars.png) + +On activating this button, the [AI Agent](/glossary.md#ai-agent) will fill in the expression for you, with no need for any further user input. +The field itself is filled in with a message indicating that the parameter has been defined automatically by the model. + +If you want to define the parameter yourself, click on the 'X' in this box to revert to user-defined values. Note that the 'expression' field will now contain the expression generated by this feature, though you can now edit it further to add extra details as described in the following section. + +/// warning +Activating this feature will overwrite any manual definition you may have already added. +/// + +## Use the `$fromAI()` function + +The `$fromAI()` function uses AI to dynamically fill in parameters for tools connected to the [Tools AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md). You can use the `$fromAI()` function in expressions within [app nodes](/integrations/builtin/app-nodes/index.md) (like [Gmail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md), [Notion](/integrations/builtin/app-nodes/n8n-nodes-base.notion/index.md), or [Slack](/integrations/builtin/app-nodes/n8n-nodes-base.slack.md)) which are connected to the **AI Agent** as tools. + +/// note | Only for the Node Tools +The `$fromAI()` function is only available for [app node](/integrations/builtin/app-nodes/index.md) tools connected to the Tools Agent. It isn't possible to use the `$fromAI()` function with the [Call n8n Workflow](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md), [Code](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md), [HTTP Request](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolhttprequest.md), or [other cluster sub-nodes](/integrations/builtin/cluster-nodes/sub-nodes/index.md). +/// + +To use the `$fromAI()` function, call it with the required `key` parameter: + +```javascript +{{ $fromAI('email') }} +``` + +The `key` parameter and other arguments to the `$fromAI()` function aren't references to existing values. Instead, think of these arguments as hints that the AI model will use to populate the right data. + +For instance, if you choose a key called `email`, the AI Model will look for an email address in its context, other tools, and input data. In chat workflows, it may ask the user for an email address if it can't find one elsewhere. You can optionally pass other parameters like `description` to give extra context to the AI model. + +### Parameters + +The `$fromAI()` function accepts the following parameters: + + + +| Parameter | Type | Required? | Description | +| --------- | ---- | --------- | ----------- | +| `key` | string | :white_check_mark: | A string representing the key or name of the argument. This must be between 1 and 64 characters in length and can only contain lowercase letters, uppercase letters, numbers, underscores, and hyphens. | +| `description` | string | :x: | A string describing the argument. | +| `type` | string | :x: | A string specifying the data type. Can be string, number, boolean, or json (defaults to string). | +| `defaultValue` | any | :x: | The default value to use for the argument. | + + + +### Examples + +As an example, you could use the following `$fromAI()` expression to dynamically populate a field with a name: + +```javascript +$fromAI("name", "The commenter's name", "string", "Jane Doe") +``` + +If you don't need the optional parameters, you could simplify this as: + +```javascript +$fromAI("name") +``` + +To dynamically populate the number of items you have in stock, you could use a `$fromAI()` expression like this: + +```javascript +$fromAI("numItemsInStock", "Number of items in stock", "number", 5) +``` + +If you only want to fill in parts of a field with a dynamic value from the model, you can use it in a normal expression as well. For example, if you want the model to fill out the `subject` parameter for an e-mail, but always pre-fix the generated value with the string 'Generated by AI:', you could use the following expression: + +```javascript +Generated by AI: {{ $fromAI("subject") }} +``` + +### Templates + +You can see the `$fromAI()` function in action in the following [templates](/glossary.md#template-n8n): + +* [Angie, Personal AI Assistant with Telegram Voice and Text](https://n8n.io/workflows/2462-angie-personal-ai-assistant-with-telegram-voice-and-text/) +* [Automate Customer Support Issue Resolution using AI Text Classifier](https://n8n.io/workflows/2468-automate-customer-support-issue-resolution-using-ai-text-classifier/) +* [Scale Deal Flow with a Pitch Deck AI Vision, Chatbot and QDrant Vector Store](https://n8n.io/workflows/2464-scale-deal-flow-with-a-pitch-deck-ai-vision-chatbot-and-qdrant-vector-store/) + + +# advanced-ai/examples/vector-store-website.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +title: Populate a Pinecone vector database from a website +description: Scrape a website, load the data into Pinecone, then query it using a chat workflow. +--- + +# Populate a Pinecone vector database from a website + +Use n8n to scrape a website, load the data into Pinecone, then query it using a chat workflow. This workflow uses the [HTTP node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to get website data, extracts the relevant content using the [HTML node](/integrations/builtin/core-nodes/n8n-nodes-base.html.md), then uses the [Pinecone Vector Store node](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md) to send it to Pinecone. + +[[ workflowDemo("file:///advanced-ai/examples/populate_a_pinecone_vector_database_from_a_website.json") ]] + +## Key features + +This workflow uses: + +* [HTTP node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md): fetches website data. +* [HTML node](/integrations/builtin/core-nodes/n8n-nodes-base.html.md): simplifies the data by extracting the main content from the page. +* [Pinecone Vector Store node](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md) and [Embeddings OpenAI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsopenai.md): transform the data into vectors and store it in Pinecone. +* [Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) and [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) to query the vector database. + + +## Using the example + +--8<-- "_snippets/examples-color-key.md" + + +# advanced-ai/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n Advanced AI Documentation and Guides +description: Use n8n's LangChain integrations to build AI-powered functionality within your workflows. Connect your LangChain functionality to other data sources and services. +contentType: overview +--- + +# Advanced AI + +Build AI functionality using n8n: from creating your own chat bot, to using AI to process documents and data from other sources. + +/// info | Feature availability +This feature is available on Cloud and self-hosted n8n, in version 1.19.4 and above. +/// + +
+ +- __Get started__ + + Work through the short tutorial to learn the basics of building AI workflows in n8n. + + [:octicons-arrow-right-24: Tutorial](/advanced-ai/intro-tutorial.md) + +- __Use a Starter Kit__ + + Try n8n's Self-hosted AI Starter Kit to quickly start building AI workflows. + + [:octicons-arrow-right-24: Self-hosted AI Starter Kit](/hosting/starter-kits/ai-starter-kit.md) + +- __Explore examples and concepts__ + + Browse examples and workflow templates to help you build. Includes explanations of important AI concepts. + + [:octicons-arrow-right-24: Examples](/advanced-ai/examples/introduction.md) + +- __How n8n uses LangChain__ + + Learn more about how n8n builds on LangChain. + + [:octicons-arrow-right-24: LangChain in n8n](/advanced-ai/langchain/overview.md) + +- __Browse AI templates__ + + Explore a wide range of AI workflow templates on the n8n website. + + [:octicons-arrow-right-24: AI workflows on n8n.io](https://n8n.io/workflows/?categories=25){:target=_blank .external-link} + +
+ +## Related resources + +Related documentation and tools. + +### Node types + +This feature uses [Cluster nodes](/integrations/builtin/cluster-nodes/index.md): groups of [root](/integrations/builtin/cluster-nodes/root-nodes/index.md) and [sub](/integrations/builtin/cluster-nodes/sub-nodes/index.md) nodes that work together. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" + +### Workflow templates + +You can browse [workflow templates](/glossary.md#template-n8n) in-app or on the n8n website [Workflows](https://n8n.io/workflows/?categories=25,26){:target=_blank .external-link} page. + +Refer to [Templates](/workflows/templates.md) for information on accessing templates in-app. + +### Chat trigger + +Use the [n8n Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) to trigger a workflow based on chat interactions. + +### Chatbot widget + +n8n 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){:target=_blank .external-link} for usage information. + + +# advanced-ai/intro-tutorial.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Learn how to build AI workflows with n8n +type: tutorial +--- + +# Build an AI chat agent with n8n + +Welcome to the introductory tutorial for building AI workflows with n8n. Whether you have used n8n before, or this is your first time, we will show you how the building blocks of AI workflows fit together and construct a working AI-powered chat agent which you can easily customize for your own purposes. + +!["Screenshot of the completed workflow"](/_images/advanced-ai/ai-intro01.png) + +Many people find it easier to take in new information in video format. This tutorial is based on one of n8n's popular videos, linked below. Watch the video or read the steps here, or both! + + + +### What you will need + +- **n8n**: For this tutorial we recommend using the [n8n cloud](/manage-cloud/overview.md) service - there is a free trial for new users! For a self hosted service, refer to the [installation pages](/hosting/installation/docker.md). +- **Credentials for a chat model**: This tutorial uses OpenAI, but you can easily use DeepSeek, Google Gemini, Groq, Azure, and others (see the [sub-nodes documentation](/integrations/builtin/cluster-nodes/sub-nodes/index.md) for more). + +### What you will learn + +- AI concepts in n8n +- How to use the AI Agent node +- Working with Chat input +- Connecting with AI models +- Customising input +- Observing the conversation +- Adding persistence + +## AI concepts in n8n + +If you're already familiar with AI, feel free to skip this section. This is a basic introduction to AI concepts and how they can be used in n8n workflows. + +An [AI agent](/glossary.md#ai-agent) builds on [Large Language Models (LLMs)](/glossary.md#large-language-model-llm), which generate text based +on input by predicting the next word. While LLMs only process input to produce +output, AI agents add goal-oriented functionality. They can use [tools](/glossary.md#ai-tool), process +their outputs, and make decisions to complete tasks and solve problems. + +In n8n, the AI agent is represented as a node with some extra connections. + +| Feature | LLM | AI Agent | +|---------------------|----------------------------|------------------------------------| +| Core Capability | Text generation | Goal-oriented task completion | +| Decision-Making | None | Yes | +| Uses Tools/APIs | No | Yes | +| Workflow Complexity | Single-step | Multi-step | +| Scope | Generates language | Performs complex, real-world tasks | +| Example | LLM generating a paragraph | An agent scheduling an appointment | + +By incorporating the AI agent as a node, n8n can combine AI-driven steps with traditional programming for efficient, real-world workflows. For instance, simpler tasks, like validating an email address, do not require AI, whereas a complex tasks, like processing the _content_ of an email or dealing with multimodal inputs (e.g., images, audio), are excellent uses of an AI agent. + +## 1. Create a new workflow + +--8<-- "_snippets/try-it-out/new-workflow.md" + +## 2. Add a trigger node + +Every workflow needs somewhere to start. In n8n these are called ['trigger nodes'](/glossary.md#trigger-node-n8n). For this workflow, we want to start with a chat node. + + 1. Select **Add first step** or press ++tab++ to open the node menu. + + 1. Search for **Chat Trigger**. n8n shows a list of nodes that match the search. + + 1. Select **Chat Trigger** to add the node to the canvas. n8n opens the node. + + 1. Close the node details view (Select **Back to canvas**) to return to the canvas. + +??? explanation "More about the Chat Trigger node..." + The trigger node generates output when there is an event causing it to trigger. In this case we want to be able to type in text to cause the workflow to run. In production, this trigger can be hooked up to a public chat interface as provided by n8n or embedded into another website. To start this simple workflow we will just use the built-in local chat interface to communicate, so no further setup is required. + +[[ workflowDemo("file:////advanced-ai/tutorials/chat_01.json") ]] + +## 3. Add an AI Agent Node + +The AI Agent node is the core of adding AI to your workflows. + + 1. Select the **Add node** ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} connector on the trigger node to bring up the node search. + + 1. Start typing "AI" and choose the **AI agent** node to add it. + + 1. The editing view of the **AI agent** will now be displayed. + + 1. There are some fields which can be changed. As we're using the **Chat Trigger** node, the default setting for the source and specification of the prompt don't need to be changed. + +[[ workflowDemo("file:////advanced-ai/tutorials/chat_02.json") ]] + +## 4. Configure the node + +AI agents require a chat model to be attached to process the incoming prompts. + +1. Add a chat model by clicking the plus ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} button underneath the **Chat Model** connection on the **AI Agent** node (it's the first connection along the bottom of the node). + +1. The search dialog will appear, filtered on 'Language Models'. These are the models with built-in support in n8n. For this tutorial we will use **OpenAI Chat Model**. + +1. Selecting the **OpenAI Chat model** from the list will attach it to the **AI Agent** node and open the node editor. One of the parameters which can be changed is the 'Model'. Note that for the basic OpenAI accounts, only the 'gpt-4o-mini' model is allowed. + +??? explanation "Which chat model?" + As mentioned earlier, the LLM is the component which generates the text according to a prompt it is given. LLMs have to be created and trained, usually an intensive process. Different LLMS may have different capabilities or specialties, depending on the data they were trained with. + +## 5. Add credentials (if needed) + +In order for n8n to communicate with the chat model, it will need some [credentials](/credentials/index.md) (login data giving it access to an account on a different online service). If you already have credentials set up for OpenAI, these should appear by default in the credentials selector. Otherwise you can use the Credentials selector to help you add a new credential. + +![image showing the credentials dialog for OpenAI](/_images/advanced-ai/ai-tutorial-credentials.png) + +1. To add a new credential, click on the text which says 'Select credential'. An option to add a new credential will appear + ![Screenshot showing create a new credential button](/_images/advanced-ai/ai-tutorial-create-credential.png) + +1. This credential just needs an API key. When adding credentials of any type, check the text to the right-hand side. In this case it has a handy link to take you straight to your OpenAI account to retrieve the API key. + +1. The API key is just one long string. That's all you need for this particular credential. Copy it from the OpenAI website and paste it into the **API key** section. + +??? explanation "Keeping your credentials safe" + Credentials 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. + +## 6. Test the node + +Now that the node is connected to the **Chat Trigger** and a chat model, we can test this part of the workflow. + +1. Click on the 'Chat' button near the bottom of the canvas. This opens up a local chat window on the left and the AI agent logs on the right. + +1. Type in a message and press ++enter++. You will now see the response from the chat model appear below your message. + +1. The log window displays the inputs to and outputs from the AI Agent. + ![image showing a chat session in progress](/_images/advanced-ai/ai-intro-chat.png) + +??? explanation "Accessing the logs..." + You can access the logs for the AI node even when you aren't using the chat interface. Open up the **AI Agent** node and click on the **Logs** tab in the right hand panel. + ![screenshot showing the Logs tab in the AIAgent](/_images/advanced-ai/ai-intro-logs.png) + +## 7. Changing the prompt + +The logs in the previous step reveal some extra data - the system prompt. This is the default message that the **AI Agent** primes the chat model with. From the log you can see this is set to "You are a helpful assistant". We can however change this prompt to alter the behavior of the chat model. + +1. Open the **AI Agent** node. In the bottom of the panel is a section labeled 'Options' and a selector labeled 'Add Option'. Use this to select 'System message' + +1. The system message is now displayed. This is the same priming prompt we noticed before in the logs. Change the prompt to something else to prime the chat model in a different way. You could try something like "You are a brilliant poet who always replies in rhyming couplets" for example. + +1. Close the node and return to the chat window. Repeat your message and notice how the output has changed. + ![image showing changed text for chat, now it rhymes; if you can believe that](/_images/advanced-ai/ai-intro-poet.png) + +## 8. Adding persistence + +The chat model is now giving us useful output, but there is something wrong with it which will become apparent when you try to have a conversation. + +1. Use the chat and tell the chat model your name, for example "Hi there, my name is Nick". + +1. Wait for the response, then type the message "What's my name?". The AI will not be able to tell you, however apologetic it may seem. The reason for this is we are not saving the context. The AI Agent has no [memory](/glossary.md#ai-memory). + ![image showing a conversation illustrating the above](/_images/advanced-ai/ai-intro-memory.png) + +1. In order to remember what has happened in the conversation, the AI Agent needs to preserve context. We can do this by adding memory to the **AI Agent** node. On the canvas click on the ![Add node icon](/_images/try-it-out/add-node-small.png){.off-glb} on the bottom of the **AI Agent** node labeled "Memory". + +1. From the panel which appears, select "Simple Memory". This will use the memory from the instance running n8n, and is usually sufficient for simple usage. The default value of 5 interactions should be sufficient here, but remember where this option is if you may want to change it later. + +1. Repeat the exercise of having a conversation above, and see that the AI Agent now remembers your name. + +## 9. Saving the workflow + +Before we leave the workflow editor, remember to save the workflow or all your changes will be lost. + +1. Click on the "Save" button in the top right of the editor window. Your workflow will now be saved and you can return to it later to chat again or add new features. + +## Congratulations! + +You have taken your first steps in building useful and effective workflows with AI. In this tutorial we have investigated the basic building blocks of an AI workflow, added an **AI Agent** and a chat model, and adjusted the prompt to get the kind of output we wanted. We also added memory so the chat could retain context between messages. + +[[ workflowDemo("file:////advanced-ai/tutorials/chat_complete.json") ]] + +## Next steps + +Now you have seen how to create a basic AI workflow, there are plenty of resources to build on that knowledge and plenty of examples to give you ideas of where to go next: + +* Learn more about AI concepts and view examples in [Examples and concepts](/advanced-ai/examples/introduction.md). +* Browse AI [Workflow templates](https://n8n.io/workflows/?categories=25){:target=_blank .external-link}. +* Find out how to [enhance the AI agent with tools](/advanced-ai/examples/understand-tools.md). + + +# advanced-ai/langchain/langchain-learning-resources.md + +--- +contentType: overview +title: LangChain learning resources +description: External resources to learn more about LangChain and AI. +--- + +# LangChain learning resources + +You don't need to know details about LangChain to use n8n, but it can be helpful to learn a few concepts. This pages lists some learning resources that people at n8n have found helpful. + +The [LangChain documentation](https://docs.langchain.com/docs/){:target=_blank .external-link} includes introductions to key concepts and possible use cases. Choose the [LangChain | Python](https://python.langchain.com/docs/get_started/introduction){:target=_blank .external-link} or [LangChain | JavaScript](https://js.langchain.com/docs/get_started/introduction/){:target=_blank .external-link} documentation for quickstarts, code examples, and API documentation. LangChain also provide [code templates](https://github.com/langchain-ai/langchain/tree/master/cookbook){:target=_blank .external-link} (Python only), offering ideas for potential use cases and common patterns. + +[What Product People Need To Know About LangChain](https://www.commandbar.com/blog/langchain-guide){:target=_blank .external-link} provides a list of terminology and concepts, explained with helpful metaphors. Aimed at a wide audience. + +If you prefer video, this [YouTube series by Greg Kamradt](https://youtu.be/_v_fgW2SkkQ?si=8Z2tfAoXnN3lXU9s){:target=_blank .external-link} works through the LangChain documentation, providing code examples as it goes. + +n8n offers space to discuss LangChain on the [Discord](https://discord.gg/bAt54txhHg){:target=_blank .external-link}. Join to share your projects and discuss ideas with the community. + + +# advanced-ai/langchain/langchain-n8n.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +title: LangChain concepts in n8n +description: How LangChain concepts map to n8n, and which n8n nodes to use. +--- + +# LangChain concepts in n8n + +This page explains how LangChain concepts and features map to n8n nodes. + +This page includes lists of the LangChain-focused nodes in n8n. You can use any n8n node in a workflow where you interact with LangChain, to link LangChain to other services. The LangChain features uses n8n's [Cluster nodes](/integrations/builtin/cluster-nodes/index.md). + + +/// note | n8n implements LangChain JS +This feature is n8n's implementation of [LangChain's JavaScript framework](https://js.langchain.com/docs/get_started/introduction){:target=_blank .external-link}. +/// +## Trigger nodes + +[Chat Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/index.md) + +## Cluster nodes + +--8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" + +### Root nodes + +Each cluster starts with one [root node](/glossary.md#root-node-n8n). + +#### Chains + +A [chain](/glossary.md#ai-chain) is a series of LLMs, and related tools, linked together to support functionality that can't be provided by a single LLM alone. + +Available nodes: + +* [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md) +* [Retrieval Q&A Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) +* [Summarization Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainsummarization.md) +* [Sentiment Analysis](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.sentimentanalysis.md) +* [Text Classifier](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.text-classifier.md) + +Learn more about [chaining in LangChain](https://js.langchain.com/docs/concepts/lcel){:target=_blank .external-link}. + +#### Agents + +> An [agent](/glossary.md#ai-agent){ data-preview} has access to a suite of tools, and determines which ones to use depending on the user input. Agents can use multiple tools, and use the output of one tool as the input to the next. [Source](https://github.com/langchain-ai/langchainjs/blob/def3a26c054575e1ed40b9062087e8c0a8899633/docs/core_docs/docs/modules/agents/index.mdx){:target=_blank .external-link} + +Available nodes: + +* [Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) + +Learn more about [Agents in LangChain](https://js.langchain.com/docs/concepts/agents){:target=_blank .external-link}. + +#### Vector stores + +[Vector stores](/glossary.md#ai-vector-store) store embedded data, and perform vector searches on it. + +* [Simple Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreinmemory.md) +* [PGVector Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md) +* [Pinecone Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md) +* [Qdrant Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreqdrant.md) +* [Supabase Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md) +* [Zep Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorezep.md) + +Learn more about [Vector stores in LangChain](https://js.langchain.com/docs/concepts/vectorstores/){:target=_blank .external-link}. + +#### Miscellaneous + +Utility nodes. + +[LangChain Code](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.code.md): import LangChain. This means if there is functionality you need that n8n hasn't created a node for, you can still use it. + +### Sub-nodes + +Each root node can have one or more [sub-nodes](/glossary.md#sub-node-n8n) attached to it. + +#### Document loaders + +Document loaders add data to your chain as documents. The data source can be a file or web service. + +Available nodes: + +* [Default Document Loader](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentdefaultdataloader.md) +* [GitHub Document Loader](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentgithubloader.md) + +Learn more about [Document loaders in LangChain](https://js.langchain.com/docs/concepts/document_loaders){:target=_blank .external-link}. + +#### Language models + +[LLMs (large language models)](/glossary.md#large-language-model-llm) are programs that analyze datasets. They're the key element of working with AI. + +Available nodes: + +* [Anthropic Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatanthropic.md) +* [AWS Bedrock Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatawsbedrock.md) +* [Cohere Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmcohere.md) +* [Hugging Face Inference Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmopenhuggingfaceinference.md) +* [Mistral Cloud Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatmistralcloud.md) +* [Ollama Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatollama/index.md) +* [Ollama Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmollama/index.md) +* [OpenAI Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md) + +Learn more about [Language models in LangChain](https://js.langchain.com/docs/concepts/chat_models){:target=_blank .external-link}. + +#### Memory + +[Memory](/glossary.md#ai-memory) retains information about previous queries in a series of queries. For example, when a user interacts with a chat model, it's useful if your application can remember and call on the full conversation, not just the most recent query entered by the user. + +Available nodes: + +* [Motorhead](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymotorhead.md) +* [Redis Chat Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryredischat.md) +* [Postgres Chat Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorypostgreschat.md) +* [Simple Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md) +* [Xata](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryxata.md) +* [Zep](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryzep.md) + +Learn more about [Memory in LangChain](https://langchain-ai.github.io/langgraphjs/concepts/memory/){:target=_blank .external-link}. + +#### Output parsers + +Output parsers take the text generated by an LLM and format it to match the structure you require. + +Available nodes: + +* [Auto-fixing Output Parser](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserautofixing.md) +* [Item List Output Parser](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparseritemlist.md) +* [Structured Output Parser](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/index.md) + +Learn more about [Output parsers in LangChain](https://js.langchain.com/docs/concepts/output_parsers/){:target=_blank .external-link}. + +#### Retrievers + + +* [Contextual Compression Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievercontextualcompression.md) +* [MultiQuery Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievermultiquery.md) +* [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) +* [Workflow Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrieverworkflow.md) + + +#### Text splitters + +Text splitters break down data (documents), making it easier for the LLM to process the information and return accurate results. + +Available nodes: + +* [Character Text Splitter](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.textsplittercharactertextsplitter.md) +* [Recursive Character Text Splitter](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.textsplitterrecursivecharactertextsplitter.md) +* [Token Splitter](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.textsplittertokensplitter.md) + +n8n's text splitter nodes implements parts of [LangChain's text_splitter API](https://js.langchain.com/docs/concepts/text_splitters/){:target=_blank .external-link}. + +#### Tools + +Utility [tools](/glossary.md#ai-tool). + +* [Calculator](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcalculator.md) +* [Code Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md) +* [SerpAPI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi.md) +* [Think Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolthink.md) +* [Vector Store Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) +* [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia.md) +* [Wolfram|Alpha](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwolframalpha.md) +* [Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) + +#### Embeddings + +> [Embeddings](/glossary.md#ai-embedding) capture the "relatedness" of text, images, video, or other types of information. ([source](https://supabase.com/docs/guides/ai/concepts){:target=_blank .external-link}) + +Available nodes: + + +* [Embeddings AWS Bedrock](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsawsbedrock.md) +* [Embeddings Cohere](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingscohere.md) +* [Embeddings Google PaLM](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsgooglepalm.md) +* [Embeddings Hugging Face Inference](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingshuggingfaceinference.md) +* [Embeddings Mistral Cloud](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsmistralcloud.md) +* [Embeddings Ollama](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsollama.md) +* [Embeddings OpenAI](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsopenai.md) + +Learn more about [Text embeddings in LangChain](https://js.langchain.com/docs/concepts/embedding_models/){:target=_blank .external-link}. + + +#### Miscellaneous + +* [Chat Memory Manager](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymanager.md) + + + + + +# advanced-ai/langchain/langsmith.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +title: Use LangSmith with n8n +description: How to enable LangSmith for your self-hosted n8n instance. +--- + +# Use LangSmith with n8n + +[LangSmith](https://www.langchain.com/langsmith){:target=_blank .external-link} is a developer platform created by the LangChain team. You can connect your n8n instance to LangSmith to record and monitor runs in n8n, just as you can in a LangChain application. + +/// info | Feature availability +Self-hosted n8n only. +/// + +## Connect your n8n instance to LangSmith + +1. [Log in to LangSmith](https://smith.langchain.com/settings){:target=_blank .external-link} and get your API key. +1. Set the LangSmith environment variables: + + | Variable | Value | + | -------- | ----- | + | LANGCHAIN_ENDPOINT | `"https://api.smith.langchain.com"` | + | LANGCHAIN_TRACING_V2 | `true` | + | LANGCHAIN_API_KEY | Set this to your API key | + + Set the variables so that they're available globally in the environment where you host your n8n instance. You can do this in the same way as the rest of your general configuration. These aren't n8n environment variables, so don't try to set them using the [n8n configuration file](/hosting/configuration/configuration-methods.md#set-environment-variables-using-a-file). + +1. Restart n8n. + +For information on using LangSmith, refer to [LangSmith's documentation](https://docs.smith.langchain.com/){:target=_blank .external-link}. + + +# advanced-ai/langchain/overview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +title: LangChain in n8n +description: Understand how n8n uses LangChain to provide advanced AI functionality. +hide: + - toc +--- + +# LangChain in n8n + +n8n provides a collection of nodes that implement LangChain's functionality. The LangChain nodes are configurable, meaning you can choose your preferred agent, LLM, memory, and so on. Alongside the LangChain nodes, you can connect any n8n node as normal: this means you can integrate your LangChain logic with other data sources and services. + +* [Learning resources](/advanced-ai/langchain/langchain-learning-resources.md): n8n's documentation for LangChain assumes you're familiar with AI and LangChain concepts. This page provides links to learning resources. +* [LangChain concepts and features in n8n](/advanced-ai/langchain/langchain-n8n.md): how n8n represents LangChain concepts and features. diff --git a/llms/api.md b/llms/api.md new file mode 100644 index 00000000000..d22a05e10df --- /dev/null +++ b/llms/api.md @@ -0,0 +1,243 @@ + + +# api/api-reference.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +template: api.html +hide: + - toc + - navigation +description: API reference for n8n's public REST API. +contentType: reference +--- + + + + + + +# api/authentication.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Authentication for n8n's public REST API. +contentType: howto +--- + +# API authentication + +n8n uses API keys to authenticate API calls. + +/// info | Feature availability +The n8n API isn't available during the free trial. Please upgrade to access this feature. +/// + +## API Scopes + +Users of [enterprise instances](https://n8n.io/enterprise/) can limit which resources and actions a key can access with scopes. API key scopes allow you specify the exact level of access a key needs for its intended purpose. + +Non-enterprise API keys have full access to all the account's resources and capabilities. + +## Create an API key + +1. Log in to n8n. +1. Go to **Settings** > **n8n API**. +1. Select **Create an API key**. +1. Choose a **Label** and set an **Expiration** time for the key. +1. If on an enterprise plan, choose the **Scopes** to give the key. +1. Copy **My API Key** and use this key to authenticate your calls. + +## Call the API using your key + +Send the API key in your API call as a header named `X-N8N-API-KEY`. + +For example, say you want to get all active workflows. Your curl request will look like this: + +```shell +# For a self-hosted n8n instance +curl -X 'GET' \ + '://api/v/workflows?active=true' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' + +# For n8n Cloud +curl -X 'GET' \ + '/api/v/workflows?active=true' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' +``` + +## Delete an API key + +1. Log in to n8n. +2. Go to **Settings** > **n8n API**. +3. Select **Delete** next to the key you want to delete. +4. Confirm the delete by selecting **Delete Forever**. + + +# api/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n public REST API Documentation and Guides +description: Access n8n public REST API documentation and guides. Find comprehensive resources to programmatically perform tasks with the public API instead of the GUI. +contentType: overview +search: + boost: 5 +--- + +# n8n public REST API + +/// info | Feature availability +The n8n API isn't available during the free trial. Please upgrade to access this feature. +/// + +Using n8n's public [API](/glossary.md#api), you can programmatically perform many of the same tasks as you can in the GUI. This section introduces n8n's REST API, including: + +* How to [authenticate](/api/authentication.md) +* [Paginating](/api/pagination.md) results +* Using the [built-in API playground](/api/using-api-playground.md) (self-hosted n8n only) +* [Endpoint reference](/api/api-reference.md) + +n8n provides an [n8n API node](/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md) to access the API in your workflows. + +## Learn about REST APIs + +The API documentation assumes you are familiar with REST APIs. If you're not, these resources may be helpful: + +* [KnowledgeOwl's guide to working with APIs](https://support.knowledgeowl.com/help/working-with-apis){:target=_blank .external-link}: a basic introduction, including examples of how to call REST APIs. +* [IBM Cloud Learn Hub - What is an Application Programming Interface (API)](https://www.ibm.com/cloud/learn/api){:target=_blank .external-link}: this gives a general, but technical, introduction to APIs. +* [IBM Cloud Learn Hub - What is a REST API?](https://www.ibm.com/cloud/learn/rest-apis){:target=_blank .external-link}: more detailed information about REST APIs. +* [MDN web docs - An overview of HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview){:target=_blank .external-link}: REST APIs work over HTTP and use HTTP verbs, or methods, to specify the action to perform. + +/// tip | Use the API playground (self-hosted n8n only) +Trying out the API in the [playground](/api/using-api-playground.md) 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. +/// + + +# api/pagination.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Pagination in n8n's public REST API. +contentType: howto +--- + +# API pagination + +The default page size is 100 results. You can change the page size limit. The maximum permitted size is 250. + +When a response contains more than one page, it includes a cursor, which you can use to request the next pages. + +For example, say you want to get all active workflows, 150 at a time. + +Get the first page: + +```shell +# For a self-hosted n8n instance +curl -X 'GET' \ + '://api/v/workflows?active=true&limit=150' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' + +# For n8n Cloud +curl -X 'GET' \ + '/api/v/workflows?active=true&limit=150' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' +``` + +The response is in JSON format, and includes a `nextCursor` value. This is an example response. + +```js +{ + "data": [ + // The response contains an object for each workflow + { + // Workflow data + } + ], + "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA" +} +``` + +Then to request the next page: + +```bash +# For a self-hosted n8n instance +curl -X 'GET' \ + '://api/v/workflows?active=true&limit=150&cursor=MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA' \ + -H 'accept: application/json' + +# For n8n Cloud +curl -X 'GET' \ + '/api/v/workflows?active=true&limit=150&cursor=MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA' \ + -H 'accept: application/json' +``` + + +# api/using-api-playground.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: How to use the API playground to try out n8n's public REST API. +contentType: howto +--- + +# Using the API playground + +/// info | Feature availability +The API playground isn't available on Cloud. It's available for all self-hosted pricing tiers. +/// + +The n8n API comes with a built-in Swagger UI playground in self-hosted versions. This provides interactive documentation, where you can try out requests. The path to access the playground depends on your hosting. + +n8n constructs the path from values set in your environment variables: + +```shell +N8N_HOST:N8N_PORT/N8N_PATH/api/v/docs +``` + +The API version number is `1`. There may be multiple versions available in the future. + +/// warning | Real data +If you select **Authorize** and enter your API key in the API playground, you have access to your live data. This is useful for trying out requests. Be aware you can change or delete real data. +/// +The API includes built-in documentation about credential formats. This is available using the `credentials` endpoint: + +```shell +N8N_HOST:N8N_PORT/N8N_PATH/api/v/credentials/schema/{credentialTypeName} +``` + +/// note | How to find `credentialTypeName` +To find the type, download your workflow as JSON and examine it. For example, for a Google Drive node the `{credentialTypeName}` is `googleDriveOAuth2Api`: +```json +{ + ..., + "credentials": { + "googleDriveOAuth2Api": { + "id": "9", + "name": "Google Drive" + } + } +} +``` +/// diff --git a/llms/code.md b/llms/code.md new file mode 100644 index 00000000000..824f6304565 --- /dev/null +++ b/llms/code.md @@ -0,0 +1,2405 @@ + + +# code/ai-code.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AI coding +description: Use GPT to generate code in the Code node. +contentType: explanation +--- + +# AI coding with GPT + +Not available on self-hosted. + +Python isn't supported. +/// + +## Use AI in the Code node + +--8<-- "_snippets/code/ai-how-to.md" + +## Usage limits + +During the trial phase there are no usage limits. If n8n makes the feature permanent, there may be usage limits as part of your pricing tier. + +## Feature limits + +The ChatGPT implementation in n8n has the following limitations: + +* The AI writes code that manipulates data from the n8n workflow. You can't ask it to pull in data from other sources. +* The AI doesn't know your data, just the schema, so you need to tell it things like how to find the data you want to extract, or how to check for null. +* Nodes before the Code node must execute and deliver data to the Code node before you run your AI query. +* Doesn't work with large incoming data schemas. +* May have issues if there are a lot of nodes before the code node. + +## Writing good prompts + + + +Writing good prompts increases the chance of getting useful code back. + +Some general tips: + +* Provide examples: if possible, give a sample expected output. This helps the AI to better understand the transformation or logic you’re aiming for. +* Describe the processing steps: if there are specific processing steps or logic that should apply to the data, list them in sequence. For example: "First, filter out all users under 18. Then, sort the remaining users by their last name." +* Avoid ambiguities: while the AI understands various instructions, being clear and direct ensures you get the most accurate code. Instead of saying "Get the older users," you might say "Filter users who are 60 years and above." +* Be clear about what you expect as the output. Do you want the data transformed, filtered, aggregated, or sorted? Provide as much detail as possible. + +And some n8n-specific guidance: + +* Think about the input data: make sure ChatGPT knows which pieces of the data you want to access, and what the incoming data represents. You may need to tell ChatGPT about the availability of n8n's built-in methods and variables. +* Declare interactions between nodes: if your logic involves data from multiple nodes, specify how they should interact. "Merge the output of 'Node A' with 'Node B' based on the 'userID' property". if you prefer data to come from certain nodes or to ignore others, be clear: "Only consider data from the 'Purchases' node and ignore the 'Refunds' node." +* Ensure the output is compatible with n8n. Refer to [Data structure](/data/data-structure.md) for more information on the data structure n8n requires. + +### Example prompts + +These examples show a range of possible prompts and tasks. + +#### Example 1: Find a piece of data inside a second dataset + +To try the example yourself, [download the example workflow](/_workflows/ai-code/find-a-piece-of-data.json) and import it into n8n. + +In the third Code node, enter this prompt: + +> The slack data contains only one item. The input data represents all Notion users. Sometimes the person property that holds the email can be null. I want to find the notionId of the Slack user and return it. + +Take a look at the code the AI generates. + +This is the JavaScript you need: + +```js +const slackUser = $("Mock Slack").all()[0]; +const notionUsers = $input.all(); +const slackUserEmail = slackUser.json.email; + +const notionUser = notionUsers.find( + (user) => user.json.person && user.json.person.email === slackUserEmail +); + +return notionUser ? [{ json: { notionId: notionUser.json.id } }] : []; +``` + +#### Example 2: Data transformation + +To try the example yourself, [download the example workflow](/_workflows/ai-code/data-transformation.json) and import it into n8n. + +In the **Join items** Code node, enter this prompt: + +> Return a single line of text that has all usernames listed with a comma. Each username should be enquoted with a double quotation mark. + +Take a look at the code the AI generates. + +This is the JavaScript you need: + +```js +const items = $input.all(); +const usernames = items.map((item) => `"${item.json.username}"`); +const result = usernames.join(", "); +return [{ json: { usernames: result } }]; +``` + +#### Example 3: Summarize data and create a Slack message + +To try the example yourself, [download the example workflow](/_workflows/ai-code/summarize-data.json) and import it into n8n. + +In the **Summarize** Code node, enter this prompt: + +> Create a markdown text for Slack that counts how many ideas, features and bugs have been submitted. The type of submission is saved in the property_type field. A feature has the property "Feature", a bug has the property "Bug" and an idea has the property "Bug". Also, list the five top submissions by vote in that message. Use "" as markdown for links. + +Take a look at the code the AI generates. + +This is the JavaScript you need: + +```js +const submissions = $input.all(); + +// Count the number of ideas, features, and bugs +let ideaCount = 0; +let featureCount = 0; +let bugCount = 0; + +submissions.forEach((submission) => { + switch (submission.json.property_type[0]) { + case "Idea": + ideaCount++; + break; + case "Feature": + featureCount++; + break; + case "Bug": + bugCount++; + break; + } +}); + +// Sort submissions by votes and take the top 5 +const topSubmissions = submissions + .sort((a, b) => b.json.property_votes - a.json.property_votes) + .slice(0, 5); + +let topSubmissionText = ""; +topSubmissions.forEach((submission) => { + topSubmissionText += `<${submission.json.url}|${submission.json.name}> with ${submission.json.property_votes} votes\n`; +}); + +// Construct the Slack message +const slackMessage = `*Summary of Submissions*\n +Ideas: ${ideaCount}\n +Features: ${featureCount}\n +Bugs: ${bugCount}\n +Top 5 Submissions:\n +${topSubmissionText}`; + +return [{ json: { slackMessage } }]; +``` + + + +### Reference incoming node data explicitly + +If your incoming data contains nested fields, using dot notation to reference them can help the AI understand what data you want. + +!["Screenshot of an n8n code node, highlighting how to reference data with dot notation in an AI query"](/_images/code/ai-code/reference-data-dot-notation.png) + +To try the example yourself, [download the example workflow](/_workflows/ai-code/reference-incoming-data-explicitly.json) and import it into n8n. + +In the second Code node, enter this prompt: + +> The data in "Mock data" represents a list of people. For each person, return a new item containing personal_info.first_name and work_info.job_title. + +This is the JavaScript you need: + +```js +const items = $input.all(); +const newItems = items.map((item) => { + const firstName = item.json.personal_info.first_name; + const jobTitle = item.json.work_info.job_title; + return { + json: { + firstName, + jobTitle, + }, + }; +}); +return newItems; +``` + +### Related resources + +Pluralsight offer a short guide on [How to use ChatGPT to write code](https://www.pluralsight.com/blog/software-development/how-use-chatgpt-programming-coding){:target=_blank .external-link}, which includes example prompts. + + + +## Fixing the code + +The AI-generated code may work without any changes, but you may have to edit it. You need to be aware of n8n's [Data structure](/data/data-structure.md). You may also find n8n's built-in methods and variables useful. + + +# code/builtin/convenience.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: n8n provides these methods to make it easier to perform common tasks in expressions. +contentType: reference +hide: + - toc +--- + +# Convenience methods + +n8n provides these methods to make it easier to perform common tasks in [expressions](/glossary.md#expression-n8n). + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// + +=== "JavaScript" + | Method | Description | Available in Code node? | + | ------ | ----------- | :---------------------: | + | `$evaluateExpression(expression: string, itemIndex?: number)` | Evaluates a string as an expression. If you don't provide `itemIndex`, n8n uses the data from item 0 in the Code node. | :white_check_mark: | + | `$ifEmpty(value, defaultValue)` | The `$ifEmpty()` function takes two parameters, tests the first to check if it's empty, then returns either the parameter (if not empty) or the second parameter (if the first is empty). The first parameter is empty if it's:
  • `undefined`
  • `null`
  • An empty string `''`
  • An array where `value.length` returns `false`
  • An object where `Object.keys(value).length` returns `false`
| :white_check_mark: | + | `$if()` | The `$if()` function takes three parameters: a condition, the value to return if true, and the value to return if false. | :x: | + | `$max()` | Returns the highest of the provided numbers. | :x: | + | `$min()` | Returns the lowest of the provided numbers. | :x: | +=== "Python" + | Method | Description | + | ------ | ----------- | + | `_evaluateExpression(expression: string, itemIndex?: number)` | Evaluates a string as an expression. If you don't provide `itemIndex`, n8n uses the data from item 0 in the Code node. | + | `_ifEmpty(value, defaultValue)` | The `_ifEmpty()` function takes two parameters, tests the first to check if it's empty, then returns either the parameter (if not empty) or the second parameter (if the first is empty). The first parameter is empty if it's:
  • `undefined`
  • `null`
  • An empty string `''`
  • An array where `value.length` returns `false`
  • An object where `Object.keys(value).length` returns `false`
| :white_check_mark: | + + +# code/builtin/current-node-input.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Methods for working with the input of the current node. +contentType: reference +hide: + - toc +--- + +# Current node input + +Methods for working with the input of the current node. Some methods and variables aren't available in the Code node. + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// +=== "JavaScript" + | Method | Description | Available in Code node? | + | ------ | ----------- | :-------------------------: | + | `$binary` | Shorthand for `$input.item.binary`. Incoming binary data from a node | :x: | + | `$input.item` | The input item of the current node that's being processed. Refer to [Item linking](/data/data-mapping/data-item-linking/index.md) for more information on paired items and item linking. | :white_check_mark: | + | `$input.all()` | All input items in current node. | :white_check_mark: | + | `$input.first()` | First input item in current node. | :white_check_mark: | + | `$input.last()` | Last input item in current node. | :white_check_mark: | + | `$input.params` | Object containing the query settings of the previous node. This includes data such as the operation it ran, result limits, and so on. | :white_check_mark: | + | `$json` | Shorthand for `$input.item.json`. Incoming JSON data from a node. Refer to [Data structure](/data/data-structure.md) for information on item structure. | :white_check_mark: (when running once for each item) | + | `$input.context.noItemsLeft` | Boolean. Only available when working with the Loop Over Items node. Provides information about what's happening in the node. Use this to determine whether the node is still processing items. | :white_check_mark: | +=== "Python" + | Method | Description | + | ------ | ----------- | + | `_input.item` | The input item of the current node that's being processed. Refer to [Item linking](/data/data-mapping/data-item-linking/index.md) for more information on paired items and item linking. | + | `_input.all()` | All input items in current node. | + | `_input.first()` | First input item in current node. | + | `_input.last()` | Last input item in current node. | + | `_input.params` | Object containing the query settings of the previous node. This includes data such as the operation it ran, result limits, and so on. | + | `_json` | Shorthand for `_input.item.json`. Incoming JSON data from a node. Refer to [Data structure](/data/data-structure.md) for information on item structure. Available when you set **Mode** to **Run Once for Each Item**. | + | `_input.context.noItemsLeft` | Boolean. Only available when working with the Loop Over Items node. Provides information about what's happening in the node. Use this to determine whether the node is still processing items. | + + +# code/builtin/data-transformation-functions/arrays.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions for arrays +description: A reference document listing built-in convenience functions to support data transformation in expressions for arrays. +contentType: reference +--- + +# Arrays + +A reference document listing built-in convenience functions to support data transformation in [expressions](/glossary.md#expression-n8n) for arrays. + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +[[% import "_macros/data-functions.html" as dataFunctions %]] + +[[% for func in df_array %]] +[[ dataFunctions.dataFunctions("array", func.funcName, func.returns, func.description, func.args, func.examples ) ]] +[[% endfor %]] + + +# code/builtin/data-transformation-functions/booleans.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions for booleans +description: A reference document listing built-in convenience functions to support data transformation in expressions for booleans. +contentType: reference +--- + +# Booleans + +A reference document listing built-in convenience functions to support data transformation in [expressions](/glossary.md#expression-n8n) for arrays. + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +[[% import "_macros/data-functions.html" as dataFunctions %]] + +[[% for func in df_boolean %]] +[[ dataFunctions.dataFunctions("boolean", func.funcName, func.returns, func.description, func.args, func.examples ) ]] +[[% endfor %]] + + +# code/builtin/data-transformation-functions/dates.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions for dates +description: A reference document listing built-in convenience functions to support data transformation in expressions for dates. +contentType: reference +--- + +# Dates + +A reference document listing built-in convenience functions to support data transformation in [expressions](/glossary.md#expression-n8n) for dates. + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +[[% import "_macros/data-functions.html" as dataFunctions %]] + +[[% for func in df_date %]] +[[ dataFunctions.dataFunctions("date", func.funcName, func.returns, func.description, func.args, func.examples ) ]] +[[% endfor %]] + + +# code/builtin/data-transformation-functions/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions +description: Introduction to data transformation functions for expressions. +contentType: overview +--- + +# Data transformation functions + +Data transformation functions are helper functions to make data transformation easier in [expressions](/glossary.md#expression-n8n). + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +For a list of available functions, refer to the page for your data type: + +* [Arrays](/code/builtin/data-transformation-functions/arrays.md) +* [Dates](/code/builtin/data-transformation-functions/dates.md) +* [Numbers](/code/builtin/data-transformation-functions/numbers.md) +* [Objects](/code/builtin/data-transformation-functions/objects.md) +* [Strings](/code/builtin/data-transformation-functions/strings.md) + +## Usage + +Data transformation functions are available in the expressions editor. + +The syntax is: + +```js +{{ dataItem.function() }} +``` + +For example, to check if a string is an email: + +```js +{{ "example@example.com".isEmail() }} + +// Returns true +``` + + +# code/builtin/data-transformation-functions/numbers.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions for numbers +description: A reference document listing built-in convenience functions to support data transformation in expressions for numbers. +contentType: reference +--- + +# Numbers + +A reference document listing built-in convenience functions to support data transformation in [expressions](/glossary.md#expression-n8n) for numbers. + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +[[% import "_macros/data-functions.html" as dataFunctions %]] + +[[% for func in df_number %]] +[[ dataFunctions.dataFunctions("number", func.funcName, func.returns, func.description, func.args, func.examples ) ]] +[[% endfor %]] + + +# code/builtin/data-transformation-functions/objects.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions for objects +description: A reference document listing built-in convenience functions to support data transformation in expressions for objects. +contentType: reference +--- + +# Objects + +A reference document listing built-in convenience functions to support data transformation in expressions for objects. + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +[[% import "_macros/data-functions.html" as dataFunctions %]] + +[[% for func in df_object %]] +[[ dataFunctions.dataFunctions("object", func.funcName, func.returns, func.description, func.args, func.examples ) ]] +[[% endfor %]] + + +# code/builtin/data-transformation-functions/strings.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data transformation functions for strings +description: A reference document listing built-in convenience functions to support data transformation in expressions for strings. +contentType: reference +--- + +# Strings + +A reference document listing built-in convenience functions to support data transformation in [expressions](/glossary.md#expression-n8n) for strings. + +/// note | JavaScript in expressions +You can use any JavaScript in expressions. Refer to [Expressions](/code/expressions.md) for more information. +/// +[[% import "_macros/data-functions.html" as dataFunctions %]] + +[[% for func in df_string %]] +[[ dataFunctions.dataFunctions("string", func.funcName, func.returns, func.description, func.args, func.examples ) ]] +[[% endfor %]] + + +# code/builtin/date-time.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Methods for working with date and time. +contentType: reference +hide: + - toc +--- + +# Built-in date and time methods + +Methods for working with date and time. + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// +=== "JavaScript" + | Method | Description | Available in Code node? | + | ------ | ----------- | :-------------------------: | + | `$now` | A Luxon object containing the current timestamp. Equivalent to `DateTime.now()`. | :white_check_mark: | + | `$today` | A Luxon object containing the current timestamp, rounded down to the day. Equivalent to `DateTime.now().set({ hour: 0, minute: 0, second: 0, millisecond: 0 })`. | :white_check_mark: | +=== "Python" + | Method | Description | + | ------ | ----------- | + | `_now` | A Luxon object containing the current timestamp. Equivalent to `DateTime.now()`. | + | `_today` | A Luxon object containing the current timestamp, rounded down to the day. Equivalent to `DateTime.now().set({ hour: 0, minute: 0, second: 0, millisecond: 0 })`. | + +n8n passes dates between nodes as strings, so you need to parse them. Luxon helps you do this. Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information. + +n8n provides built-in convenience functions to support data transformation in expressions for dates. Refer to [Data transformation functions | Dates](/code/builtin/data-transformation-functions/dates.md) for more information. + + +# code/builtin/http-node-variables.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: n8n provides these methods to make it easier to perform common tasks in expressions. +contentType: reference +hide: + - toc +--- + +# HTTP node variables + +Variables for working with HTTP node requests and responses when using pagination. + +Refer to [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) for guidance on using the HTTP node, including configuring pagination. + +Refer to [HTTP Request node cookbook | Pagination](/code/cookbook/http-node/pagination.md) for example pagination configurations. + +/// note | HTTP node only +These variables are for use in expressions in the HTTP node. You can't use them in other nodes. +/// +--8<-- "_snippets/integrations/builtin/core-nodes/http/pagination-variables.md" + + +# code/builtin/jmespath.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: A method for working with the JMESPath library in n8n. +contentType: reference +hide: + - toc +--- + +# JMESPath method + +This is an n8n-provided method for working with the [JMESPath](/code/cookbook/jmespath.md) library. + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// +=== "JavaScript" + | Method | Description | Available in Code node? | + | ------ | ----------- | :-------------------------: | + | `$jmespath()` | Perform a search on a JSON object using JMESPath. | :white_check_mark: | +=== "Python" + | Method | Description | + | ------ | ----------- | + | `_jmespath()` | Perform a search on a JSON object using JMESPath. | + + +# code/builtin/langchain-methods.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: n8n provides these methods to make it easier to perform common tasks in the LangChain Code node. +contentType: reference +hide: + - toc +--- +# LangChain Code node methods + +n8n provides these methods to make it easier to perform common tasks in the [LangChain Code node](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.code.md). + +/// note | LangChain Code node only +These variables are for use in expressions in the LangChain Code node. You can't use them in other nodes. +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/langchaincode/builtin-methods.md" + + +# code/builtin/n8n-metadata.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Methods for working with n8n metadata. +contentType: reference +hide: + - toc +--- + +# n8n metadata + +Methods for working with n8n metadata. + +This includes: + +* Access to n8n environment variables for self-hosted n8n. +* Metadata about workflows, executions, and nodes. +* Information about instance [Variables](/code/variables.md) and [External secrets](/external-secrets.md). + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// +=== "JavaScript" + | Method | Description | Available in Code node? | + | ------ | ----------- | :-------------------------: | + | `$env` | Contains n8n instance configuration [environment variables](/hosting/configuration/environment-variables/index.md). | :white_check_mark: | + | `$execution.customData` | Set and get custom execution data. Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information. | :white_check_mark: | + | `$execution.id` | The unique ID of the current workflow execution. | :white_check_mark: | + | `$execution.mode` | Whether the execution was triggered automatically, or by manually running the workflow. Possible values are `test` and `production`. | :white_check_mark: | + | `$execution.resumeUrl` | The webhook URL to call to resume a workflow waiting at a [Wait node](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md). | :white_check_mark: | + | `$getWorkflowStaticData(type)` | View an [example](/code/cookbook/builtin/get-workflow-static-data.md). Static data doesn't persist when testing workflows. The workflow must be active and called by a trigger or webhook to save static data. This gives access to the static workflow data. | :white_check_mark: | + | `$("").isExecuted` | Check whether a node has already executed. | :white_check_mark: | + | `$itemIndex` | The index of an item in a list of items. | :x: | + | `$nodeVersion` | Get the version of the current node. | :white_check_mark: | + | `$prevNode.name` | The name of the node that the current input came from. When using the Merge node, note that `$prevNode` always uses the first input connector. | :white_check_mark: | + | `$prevNode.outputIndex` | The index of the output connector that the current input came from. Use this when the previous node had multiple outputs (such as an If or Switch node). When using the Merge node, note that `$prevNode` always uses the first input connector. | :white_check_mark: | + | `$prevNode.runIndex` | The run of the previous node that generated the current input. When using the Merge node, note that `$prevNode` always uses the first input connector. | :white_check_mark: | + | `$runIndex` | How many times n8n has executed the current node. Zero-based (the first run is 0, the second is 1, and so on). | :white_check_mark: | + | `$secrets` | Contains information about your [External secrets](/external-secrets.md) setup. | :white_check_mark: | + | `$vars` | Contains the [Variables](/code/variables.md) available in the active environment. | :white_check_mark: | + | `$version` | The node version. | :x: | + | `$workflow.active` | Whether the workflow is active (true) or not (false). | :white_check_mark: | + | `$workflow.id` | The workflow ID. | :white_check_mark: | + | `$workflow.name` | The workflow name. | :white_check_mark: | +=== "Python" + | Method | Description | + | ------ | ----------- | + | `_env` | Contains n8n instance configuration [environment variables](/hosting/configuration/environment-variables/index.md). | + | `_execution.customData` | Set and get custom execution data. Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information. | + | `_execution.id` | The unique ID of the current workflow execution. | + | `_execution.mode` | Whether the execution was triggered automatically, or by manually running the workflow. Possible values are `test` and `production`. | + | `_execution.resumeUrl` | The webhook URL to call to resume a workflow waiting at a [Wait node](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md). | + | `_getWorkflowStaticData(type)` | View an [example](/code/cookbook/builtin/get-workflow-static-data.md). Static data doesn't persist when testing workflows. The workflow must be active and called by a trigger or webhook to save static data. This gives access to the static workflow data. | + | `_("").isExecuted` | Check whether a node has already executed. | + | `_nodeVersion` | Get the version of the current node. | :white_check_mark: | + | `_prevNode.name` | The name of the node that the current input came from. When using the Merge node, note that `_prevNode` always uses the first input connector. | + | `_prevNode.outputIndex` | The index of the output connector that the current input came from. Use this when the previous node had multiple outputs (such as an If or Switch node). When using the Merge node, note that `_prevNode` always uses the first input connector. | + | `_prevNode.runIndex` | The run of the previous node that generated the current input. When using the Merge node, note that `_prevNode` always uses the first input connector. | + | `_runIndex` | How many times n8n has executed the current node. Zero-based (the first run is 0, the second is 1, and so on). | + | `_secrets` | Contains information about your [External secrets](/external-secrets.md) setup. | + | `_vars` | Contains the [Variables](/code/variables.md) available in the active environment. | + | `_workflow.active` | Whether the workflow is active (true) or not (false). | + | `_workflow.id` | The workflow ID. | + | `_workflow.name` | The workflow name. | + + +# code/builtin/output-other-nodes.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Methods for working with the output of other nodes. +contentType: reference +hide: + - toc +--- + +# Output of other nodes + +Methods for working with the output of other nodes. Some methods and variables aren't available in the Code node. + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// +=== "JavaScript" + | Method | Description | Available in Code node? | + | ------ | ----------- | :-------------------------: | + | `$("").all(branchIndex?, runIndex?)` | Returns all items from a given node. If `branchIndex` isn't given it will default to the output that connects `node-name` with the node where you use the expression or code. | :white_check_mark: | + | `$("").first(branchIndex?, runIndex?)` | The first item output by the given node. If `branchIndex` isn't given it will default to the output that connects `node-name` with the node where you use the expression or code. | :white_check_mark: | + | `$("").last(branchIndex?, runIndex?)` | The last item output by the given node. If `branchIndex` isn't given it will default to the output that connects `node-name` with the node where you use the expression or code. | :white_check_mark: | + | `$("").item` | The linked item. This is the item in the specified node used to produce the current item. Refer to [Item linking](/data/data-mapping/data-item-linking/index.md) for more information on item linking. | :x: | + | `$("").params` | Object containing the query settings of the given node. This includes data such as the operation it ran, result limits, and so on. | :white_check_mark: | + | `$("").context` | Boolean. Only available when working with the Loop Over Items node. Provides information about what's happening in the node. Use this to determine whether the node is still processing items. | :white_check_mark: | + | `$("").itemMatching(currentNodeInputIndex)` | Use instead of `$("").item` in the Code node if you need to trace back from an input item. | :white_check_mark: | +=== "Python" + | Method | Description | Available in Code node? | + | ------ | ----------- | :-------------------------: | + | `_("").all(branchIndex?, runIndex?)` | Returns all items from a given node. If `branchIndex` isn't given it will default to the output that connects`node-name` with the node where you use the expression or code. | :white_check_mark: | + | `_("").first(branchIndex?, runIndex?)` | The first item output by the given node. If `branchIndex` isn't given it will default to the output that connects`node-name` with the node where you use the expression or code. | :white_check_mark: | + | `_("").last(branchIndex?, runIndex?)` | The last item output by the given node. If `branchIndex` isn't given it will default to the output that connects`node-name` with the node where you use the expression or code. | :white_check_mark: | + | `_("").item` | The linked item. This is the item in the specified node used to produce the current item. Refer to [Item linking](/data/data-mapping/data-item-linking/index.md) for more information on item linking. | :x: | + | `_("").params` | Object containing the query settings of the given node. This includes data such as the operation it ran, result limits, and so on. | :white_check_mark: | + | `_("").context` | Boolean. Only available when working with the Loop Over Items node. Provides information about what's happening in the node. Use this to determine whether the node is still processing items. | :white_check_mark: | + | `_("").itemMatching(currentNodeInputIndex)` | Use instead of `_("").item` in the Code node if you need to trace back from an input item. Refer to [Retrieve linked items from earlier in the workflow](/code/cookbook/builtin/itemmatching.md) for an example. | :white_check_mark: | + + +# code/builtin/overview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: n8n's built-in custom methods and variables. +contentType: overview +--- + +# Built-in methods and variables + +n8n provides built-in methods and variables for working with data and accessing n8n data. This section provides a reference of available methods and variables for use in [expressions](/glossary.md#expression-n8n), with a short description. + +/// note | Availability in the expressions editor and the Code node +Some methods and variables aren't available in the Code node. These aren't in the documentation. + +All data transformation functions are only available in the expressions editor. +/// + + +The [Cookbook](/code/index.md) contains examples for some common tasks, including some [Code node only](/code/cookbook/code-node/index.md) functions. + +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + + +# code/code-node.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: [integration, reference] +tags: + - code node + - code +hide: + - tags +--- + +# Using the Code node + +--8<-- "_snippets/integrations/builtin/core-nodes/code-node.md" + + +# code/cookbook/builtin/all.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# `("").all(branchIndex?: number, runIndex?: number)` + +This gives access to all the items of the current or parent nodes. If you don't supply any parameters, it returns all the items of the current node. + +## Getting items + +=== "JavaScript" + ```js + // Returns all the items of the given node and current run + let allItems = $("").all(); + + // Returns all items the node "IF" outputs (index: 0 which is Output "true" of its most recent run) + let allItems = $("IF").all(); + + // Returns all items the node "IF" outputs (index: 0 which is Output "true" of the same run as current node) + let allItems = $("IF").all(0, $runIndex); + + // Returns all items the node "IF" outputs (index: 1 which is Output "false" of run 0 which is the first run) + let allItems = $("IF").all(1, 0); + ``` +=== "Python" + ```python + # Returns all the items of the given node and current run + allItems = _("").all(); + + # Returns all items the node "IF" outputs (index: 0 which is Output "true" of its most recent run) + allItems = _("IF").all(); + + # Returns all items the node "IF" outputs (index: 0 which is Output "true" of the same run as current node) + allItems = _("IF").all(0, _runIndex); + + # Returns all items the node "IF" outputs (index: 1 which is Output "false" of run 0 which is the first run) + allItems = _("IF").all(1, 0); + ``` + +## Accessing item data + +Get all items output by a previous node, and log out the data they contain: + +=== "JavaScript" + ```typescript + previousNodeData = $("").all(); + for(let i=0; i").all(); + for item in previousNodeData: + # item is of type + # You need to convert it to a Dict + itemDict = item.json.to_py() + print(itemDict) + ``` + + +# code/cookbook/builtin/execution.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# `execution` + +## `execution.id` + +Contains the unique ID of the current workflow execution. + +=== "JavaScript" + ```js + let executionId = $execution.id; + ``` +=== "Python" + ```python + executionId = _execution.id + ``` + +## `execution.resumeUrl` + +The webhook URL to call to resume a [waiting](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md) workflow. + +See the [Wait > On webhook call](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md#on-webhook-call) documentation to learn more. + +## `execution.customData` + +This is only available in the Code node. + +=== "JavaScript" + ```js + // Set a single piece of custom execution data + $execution.customData.set("key", "value"); + + // Set the custom execution data object + $execution.customData.setAll({"key1": "value1", "key2": "value2"}) + + // Access the current state of the object during the execution + var customData = $execution.customData.getAll() + + // Access a specific value set during this execution + var customData = $execution.customData.get("key") + ``` +=== "Python" + ```python + # Set a single piece of custom execution data + _execution.customData.set("key", "value"); + + # Set the custom execution data object + _execution.customData.setAll({"key1": "value1", "key2": "value2"}) + + # 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") + ``` + +Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information. + + +# code/cookbook/builtin/get-workflow-static-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +tags: + - "static data" + - "global variables" +hide: + - tags +contentType: reference +--- + +# `getWorkflowStaticData(type)` + +This gives access to the static workflow data. + +/// note | Experimental feature +- Static data isn't available when testing workflows. The workflow must be active and called by a [trigger](/glossary.md#trigger-node-n8n) or webhook to save static data. +- This feature may behave unreliably under high-frequency workflow executions. +/// +You can save data directly in the workflow. This data should be small. + +As an example: you can save a timestamp of the last item processed from +an RSS feed or database. It will always return an object. Properties can then read, delete or +set on that object. When the workflow execution succeeds, n8n checks automatically if the data +has changed and saves it, if necessary. + +There are two types of static data, global and node. Global static data is the +same in the whole workflow. Every node in the workflow can access it. The node static data is unique to the node. Only the node that set it can retrieve it again. + +Example with global data: + +=== "JavaScript" + ```javascript + // Get the global workflow static data + const workflowStaticData = $getWorkflowStaticData('global'); + + // Access its data + const lastExecution = workflowStaticData.lastExecution; + + // Update its data + workflowStaticData.lastExecution = new Date().getTime(); + + // Delete data + delete workflowStaticData.lastExecution; + ``` +=== "Python" + ```python + # Get the global workflow static data + workflowStaticData = _getWorkflowStaticData('global') + + # Access its data + lastExecution = workflowStaticData.lastExecution + + # Update its data + workflowStaticData.lastExecution = new Date().getTime() + + # Delete data + delete workflowStaticData.lastExecution + ``` + +Example with node data: + +=== "JavaScript" + ```js + // Get the static data of the node + const nodeStaticData = $getWorkflowStaticData('node'); + + // Access its data + const lastExecution = nodeStaticData.lastExecution; + + // Update its data + nodeStaticData.lastExecution = new Date().getTime(); + + // Delete data + delete nodeStaticData.lastExecution; + ``` +=== "Python" + ```python + # Get the static data of the node + nodeStaticData = _getWorkflowStaticData('node') + + # Access its data + lastExecution = nodeStaticData.lastExecution + + # Update its data + nodeStaticData.lastExecution = new Date().getTime() + + # Delete data + delete nodeStaticData.lastExecution + ``` + +## Templates and examples + + +[[ workflowDemo("https://api.n8n.io/workflows/templates/2538") ]] + + +# code/cookbook/builtin/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Examples using n8n's built-in methods and variables + +n8n provides built-in methods and variables for working with data and accessing n8n data. This section provides usage examples. + +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + +## Related resources + +* [Built-in methods and variables reference](/code/builtin/overview.md) +* [Expressions](/code/expressions.md) +* [Code node](/code/code-node.md) + + +# code/cookbook/builtin/itemmatching.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: How to use `("").itemMatching(currentNodeinputIndex)` +contentType: howto +--- + +# Retrieve linked items from earlier in the workflow + +Every item in a node's input data links back to the items used in previous nodes to generate it. This is useful if you need to retrieve linked items from further back than the immediate previous node. + +To access the linked items from earlier in the workflow, use `("").itemMatching(currentNodeinputIndex)`. + + +For example, consider a workflow that does the following: + +1. The Customer Datastore node generates example data: + ```json + [ + { + "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" + }, + ... + ] + ``` +2. The Edit Fields node simplifies this data: + ```json + [ + { + "name": "Jay Gatsby" + }, + { + "name": "José Arcadio Buendía" + }, + ... + ] + ``` +3. The Code node restore the email address to the correct person: + ```json + [ + { + "name": "Jay Gatsby", + "restoreEmail": "gatsby@west-egg.com" + }, + { + "name": "José Arcadio Buendía", + "restoreEmail": "jab@macondo.co" + }, + ... + ] + ``` + +The Code node does this using the following code: + +=== "JavaScript" + ```js + for(let i=0; i<$input.all().length; i++) { + $input.all()[i].json.restoreEmail = $('Customer Datastore (n8n training)').itemMatching(i).json.email; + } + return $input.all(); + ``` +=== "Python" + ```python + for i,item in enumerate(_input.all()): + _input.all()[i].json.restoreEmail = _('Customer Datastore (n8n training)').itemMatching(i).json.email + + return _input.all(); + ``` + +You can view and download the example workflow from [n8n website | itemMatchin usage example ](https://n8n.io/workflows/1966-itemmatching-usage-example/){:target=_blank .external-link}. + + +# code/cookbook/builtin/vars.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Access your environment's custom variables. +contentType: reference +--- + +# `vars` + +/// info | Feature availability +* Available on Self-hosted Enterprise and Pro and Enterprise Cloud plans. +* You need access to the n8n instance owner account to create variables. +/// + +`vars` contains all [Variables](/code/variables.md) for the active environment. It's read-only: you can access variables using `vars`, but must set them using the UI. + +=== "JavaScript" + ```js + // Access a variable + $vars. + ``` +=== "Python" + ```python + # Access a variable + _vars. + ``` + +/// note | `vars` and `env` +`vars` gives access to user-created variables. It's part of the [Environments](/source-control-environments/index.md) feature. `env` gives access to the [configuration environment variables](/hosting/configuration/environment-variables/index.md) for your n8n instance. +/// + + +# code/cookbook/code-node/console-log.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: How to use console.log() or print() +contentType: howto +--- + +# Output to the browser console with `console.log()` or `print()` in the Code node + +You can use `console.log()` or `print()` in the Code node to help when writing and debugging your code. + +For help opening your browser console, refer to [this guide by Balsamiq](https://balsamiq.com/support/faqs/browserconsole/){:target=_blank .external-link}. + +## console.log (JavaScript) + +For technical information on `console.log()`, refer to the [MDN developer docs](https://developer.mozilla.org/en-US/docs/Web/API/Console/log){:target=_blank .external-link}. + +For example, copy the following code into a Code node, then open your console and run the node: + +```js +let a = "apple"; +console.log(a); +``` + +## print (Python) + +For technical information on `print()`, refer to the [Real Python's guide](https://realpython.com/python-print/){:target=_blank .external-link}. + +For example, set your Code node **Language** to **Python**, copy the following code into the node, then open your console and run the node: + +```python +a = "apple" +print(a) +``` + +### Handling an output of `[object Object]` + +If the console displays `[object Object]` when you print, check the data type, then convert it as needed. + +To check the data type: + +```python +print(type(myData)) +``` + +#### JsProxy + +If `type()` outputs ``, you need to convert the JsProxy to a native Python object using `to_py()`. This occurs when working with data in the n8n node data structure, such as node inputs and outputs. For example, if you want to print the data from a previous node in the workflow: + +```python +previousNodeData = _("").all(); +for item in previousNodeData: + # item is of type + # You need to convert it to a Dict + itemDict = item.json.to_py() + print(itemDict) +``` + +Refer to the Pyodide documentation on [JsProxy](https://pyodide.org/en/stable/usage/api/python-api/ffi.html#pyodide.ffi.JsProxy){:target=_blank .external-link} for more information on this class. + + + + + + + + + + +# code/cookbook/code-node/get-binary-data-buffer.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Get the binary data buffer + +The binary data buffer contains all the binary file data processed by a workflow. You need to access it if you want to perform operations on the binary data, such as: + +* Manipulating the data: for example, adding column headers to a CSV file. +* Using the data in calculations: for example, calculating a hash value based on it. +* Complex HTTP requests: for example, combining file upload with sending other data formats. + +/// note | Not available in Python +`getBinaryDataBuffer()` isn't supported when using Python. +/// +You can access the buffer using n8n's `getBinaryDataBuffer()` function: + + +```js +/* +* itemIndex: number. The index of the item in the input data. +* binaryPropertyName: string. The name of the binary property. +* The default in the Read/Write File From Disk node is 'data'. +*/ +let binaryDataBufferItem = await this.helpers.getBinaryDataBuffer(itemIndex, binaryPropertyName); +``` + +For example: + +```js +let binaryDataBufferItem = await this.helpers.getBinaryDataBuffer(0, 'data'); +// Returns the data in the binary buffer for the first input item +``` + + +You should always use the `getBinaryDataBuffer()` function, and avoid using older methods of directly accessing the buffer, such as targeting it with expressions like `items[0].binary.data.data`. + + +# code/cookbook/code-node/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Code examples you can use in the Code node. +contentType: overview +--- + +# Code node cookbook + +This section contains examples and recipes for tasks you can do with the Code node. + +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + +## Related resources + +* [Built-in methods and variables reference](/code/builtin/overview.md) +* [Code node](/code/code-node.md) + + +# code/cookbook/code-node/number-items-last-node.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Get number of items returned by the previous node + +To get the number of items returned by the previous node: + +=== "JavaScript" + + ```js + if (Object.keys(items[0].json).length === 0) { + return [ + { + json: { + results: 0, + } + } + ] + } + return [ + { + json: { + results: items.length, + } + } + ]; + ``` + + The output will be similar to the following. + + ```json + [ + { + "results": 8 + } + ] + ``` +=== "Python" + ```python + if len(items[0].json) == 0: + return [ + { + "json": { + "results": 0, + } + } + ] + else: + return [ + { + "json": { + "results": items.length, + } + } + ] + ``` + The output will be similar to the following. + + ```json + [ + { + "results": 8 + } + ] + ``` + + +# code/cookbook/expressions/check-incoming-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Check incoming data + +At times, you may want to check the incoming data. If the incoming data doesn't match a condition, you may want to return a different value. For example, you want to check if a variable from the previous node is empty and return a string if it's empty. Use the following code snippet to return `not found` if the variable is empty. + +```javascript +{{$json["variable_name"]? $json["variable_name"] :"not found"}} +``` + +The above expression uses the ternary operator. You can learn more about the ternary operator [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Conditional_Operator). + +As an alternative, you can use the [nullish coalescing operator (??)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing) or the [logical or operator (||)](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Logical_OR): + +```javascript +{{ $x ?? "default value" }} +{{ $x || "default value" }} +``` + +In either of the above two cases, the value of `$x` will be used if it's set to a non-null, non-false value. The string `default value` is the fallback value. + + +# code/cookbook/expressions/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Expressions common issues +description: Documentation for common issues and questions related to expressions in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: howto +--- + +# Expressions common issues + +Here are some common errors and issues related to [expressions](/code/expressions.md) and steps to resolve or troubleshoot them. + +## The 'JSON Output' in item 0 contains invalid JSON + +This error occurs when you use JSON mode but don't provide a valid JSON object. Depending on the problem with the JSON object, the error sometimes display as `The 'JSON Output' in item 0 does not contain a valid JSON object`. + +To resolve this, make sure that the code you provide is valid JSON: + +- Check the JSON with a [JSON validator](https://jsonlint.com/). +- Check that your JSON object doesn't reference undefined input data. This may occur if the incoming data doesn't always include the same fields. + +## Can't get data for expression + +This error occurs when n8n can't retrieve the data referenced by an expression. Often, this happens when the preceding node hasn't been run yet. + +Another variation of this may appear as `Referenced node is unexecuted`. In that case, the full text of this error will tell you the exact node that isn't executing in this format: + +> An expression references the node '<node-name>', but it hasn’t been executed yet. Either change the expression, or re-wire your workflow to make sure that node executes first. +> + +To begin troubleshooting, test the workflow up to the named node. + +For nodes that use JavaScript or other custom code, you can check if a previous node has executed before trying to use its value by checking the following: + +```javascript +$("").isExecuted +``` + +As an example, this JSON references the parameters of the input data. This error will display if you test this step without connecting it to another node: + +```javascript +{ + "my_field_1": {{ $input.params }} +} +``` + +## Invalid syntax + +This error occurs when you use an expression that has a syntax error. + +For example, the expression in this JSON includes a trailing period, which results in an invalid syntax error: + +```jsx +{ + "my_field_1": "value", + "my_field_2": {{ $('If').item.json. }} +} + +``` + +To resolve this error, check your [expression syntax](https://www.notion.so/code/expressions/) to make sure they follow the expected format. + + +# code/cookbook/expressions/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Code examples you can use in expressions. +contentType: overview +--- + +# Expressions cookbook + +This section contains examples and recipes for tasks you can do with [expressions](/glossary.md#expression-n8n). + +/// note | Python support +You can use Python in the Code node. It isn't available in expressions. +/// +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + +## Related resources + +* [Built-in methods and variables reference](/code/builtin/overview.md) +* [Expressions](/code/expressions.md) + + +# code/cookbook/http-node/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Examples using n8n's HTTP Request node + +The HTTP Request node is one of the most versatile nodes in n8n. Use this node to make HTTP requests to query data from any app or service with a REST API. + +Refer to [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) for information on node settings. + +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + +## Related resources + +* [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) +* [Built-in methods and variables reference](/code/builtin/overview.md) +* [Expressions](/code/expressions.md) + + +# code/cookbook/http-node/pagination.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Pagination examples for the HTTP Request node. +contentType: howto +--- + +# Pagination in the HTTP Request node + +The HTTP Request node supports pagination. This page provides some example configurations, including using the [HTTP node variables](/code/builtin/http-node-variables.md). + +Refer to [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) for more information on the node. + +--8<-- "_snippets/integrations/builtin/core-nodes/http/pagination-api-differences.md" + + +## Enable pagination + +In the HTTP Request node, select **Add Option** > **Pagination**. + +## Use a URL from the response to get the next page using `$response` + +If the API returns the URL of the next page in its response: + +1. Set **Pagination Mode** to **Response Contains Next URL**. n8n displays the parameters for this option. +1. In **Next URL**, use an [expression](/glossary.md#expression-n8n) to set the URL. The exact expression depends on the data returned by your API. For example, if the API includes a parameter called `next-page` in the response body: + ```javascript + {{ $response.body["next-page"] }} + ``` + +## Get the next page by number using `$pageCount` + +If the API you're using supports targeting a specific page by number: + +1. Set **Pagination Mode** to **Update a Parameter in Each Request**. +1. Set **Type** to **Query**. +1. Enter the **Name** of the query parameter. This depends on your API and is usually described in its documentation. For example, some APIs use a query parameter named `page` to set the page. So **Name** would be `page`. +1. Hover over **Value** and toggle **Expression** on. +1. Enter `{{ $pageCount + 1 }}` + +`$pageCount` is the number of pages the HTTP Request node has fetched. It starts at zero. Most API pagination counts from one (the first page is page one). This means that adding `+1` to `$pageCount` means the node fetches page one on its first loop, page two on its second, and so on. + +## Navigate pagination through body parameters + +If the API you're using allows you to paginate through the body parameters: + +1. Set the HTTP Request Method to **POST** +1. Set **Pagination Mode** to **Update a Parameter in Each Request**. +1. Select **Body** in the **Type** parameter. +1. Enter the **Name** of the body parameter. This depends on the API you're using. `page` is a common key name. +1. Hover over **Value** and toggle **Expression** on. +1. Enter `{{ $pageCount + 1 }}` + +## Set the page size in the query + +If the API you're using supports choosing the page size in the query: + +1. Select **Send Query Parameters** in main node parameters (this is the parameters you see when you first open the node, not the settings within options). +1. Enter the **Name** of the query parameter. This depends on your API. For example, a lot of APIs use a query parameter named `limit` to set page size. So **Name** would be `limit`. +1. In **Value**, enter your page size. + + + + +# code/cookbook/jmespath.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Query JSON with JMESPath +description: n8n supports the JMESPath library, to simplify working with JSON formatted data. +contentType: howto +--- + +# Query JSON with JMESPath + +[JMESPath](https://jmespath.org/){:target=_blank .external-link} is a query language for JSON that you can use to extract and transform elements from a JSON document. For full details of how to use JMESPath, refer to the [JMESPath documentation](https://jmespath.org/tutorial.html){:target=_blank .external-link}. + + +## The `jmespath()` method + +n8n provides a custom method, `jmespath()`. Use this method to perform a search on a JSON object using the JMESPath query language. + +The basic syntax is: + +=== "JavaScript" + ```js + $jmespath(object, searchString) + ``` +=== "Python" + ```python + _jmespath(object, searchString) + ``` + + +To help understand what the method does, here is the equivalent longer JavaScript: + + +```js +var jmespath = require('jmespath'); +jmespath.search(object, searchString); +``` + +/// note | Expressions must be single-line +The longer code example doesn't work in Expressions, as they must be single-line. +/// + +`object` is a JSON object, such as the output of a previous node. `searchString` is an expression written in the JMESPath query language. The [JMESPath Specification](https://jmespath.org/specification.html#jmespath-specification){:target=_blank .external-link} provides a list of supported expressions, while their [Tutorial](https://jmespath.org/tutorial.html) and [Examples](https://jmespath.org/examples.html){:target=_blank .external-link} provide interactive examples. + +/// warning | Search parameter order +The examples in the [JMESPath Specification](https://jmespath.org/specification.html#jmespath-specification){:target=_blank .external-link} follow the pattern `search(searchString, object)`. The [JMESPath JavaScript library](https://github.com/jmespath/jmespath.js/){:target=_blank .external-link}, which n8n uses, supports `search(object, searchString)` instead. This means that when using examples from the JMESPath documentation, you may need to change the order of the search function parameters. +/// + +## Common tasks + +This section provides examples for some common operations. More examples, and detailed guidance, are available in [JMESPath's own documentation](https://jmespath.org/tutorial.html){:target=_blank .external-link}. + +When trying out these examples, you need to set the Code node **Mode** to **Run Once for Each Item**. + +### Apply a JMESPath expression to a collection of elements with projections + +From the [JMESPath projections documentation](https://jmespath.org/tutorial.html#projections){:target=_blank .external-link}: + +> Projections are one of the key features of JMESPath. Use it to apply an expression to a collection of elements. JMESPath supports five kinds of projections: +> +> * List Projections +> * Slice Projections +> * Object Projections +> * Flatten Projections +> * Filter Projections + +The following example shows basic usage of list, slice, and object projections. Refer to the [JMESPath projections documentation](https://jmespath.org/tutorial.html#projections){:target=_blank .external-link} for detailed explanations of each projection type, and more examples. + +Given this JSON from a webhook node: + + +```js +[ + { + "headers": { + "host": "n8n.instance.address", + ... + }, + "params": {}, + "query": {}, + "body": { + "people": [ + { + "first": "James", + "last": "Green" + }, + { + "first": "Jacob", + "last": "Jones" + }, + { + "first": "Jayden", + "last": "Smith" + } + ], + "dogs": { + "Fido": { + "color": "brown", + "age": 7 + }, + "Spot": { + "color": "black and white", + "age": 5 + } + } + } + } +] + +``` + + +Retrieve a [list](https://jmespath.org/tutorial.html#list-and-slice-projections){:target=_blank .external-link} of all the people's first names: + +=== "Expressions (JavaScript)" + + ```js + {{$jmespath($json.body.people, "[*].first" )}} + // Returns ["James", "Jacob", "Jayden"] + ``` + +=== "Code node (JavaScript)" + + ```js + let firstNames = $jmespath($json.body.people, "[*].first" ) + return {firstNames}; + /* Returns: + [ + { + "firstNames": [ + "James", + "Jacob", + "Jayden" + ] + } + ] + */ + ``` +=== "Code node (Python)" + ```python + firstNames = _jmespath(_json.body.people, "[*].first" ) + return {"firstNames":firstNames} + """ + Returns: + [ + { + "firstNames": [ + "James", + "Jacob", + "Jayden" + ] + } + ] + """ + ``` + +Get a [slice](https://jmespath.org/tutorial.html#list-and-slice-projections){:target=_blank .external-link} of the first names: + +=== "Expressions (JavaScript)" + + ```js + {{$jmespath($json.body.people, "[:2].first")}} + // Returns ["James", "Jacob"] + ``` + +=== "Code node (JavaScript)" + ```js + let firstTwoNames = $jmespath($json.body.people, "[:2].first"); + return {firstTwoNames}; + /* Returns: + [ + { + "firstNames": [ + "James", + "Jacob", + "Jayden" + ] + } + ] + */ + ``` +=== "Code node (Python)" + ```python + firstTwoNames = _jmespath(_json.body.people, "[:2].first" ) + return {"firstTwoNames":firstTwoNames} + """ + Returns: + [ + { + "firstTwoNames": [ + "James", + "Jacob" + ] + } + ] + """ + ``` + +Get a list of the dogs' ages using [object projections](https://jmespath.org/tutorial.html#object-projections){:target=_blank .external-link}: + +=== "Expressions (JavaScript)" + + ```js + {{$jmespath($json.body.dogs, "*.age")}} + // Returns [7,5] + ``` + +=== "Code node (JavaScript)" + ```js + let dogsAges = $jmespath($json.body.dogs, "*.age"); + return {dogsAges}; + /* Returns: + [ + { + "dogsAges": [ + 7, + 5 + ] + } + ] + */ + ``` +=== "Code node (Python)" + ```python + dogsAges = _jmespath(_json.body.dogs, "*.age") + return {"dogsAges": dogsAges} + """ + Returns: + [ + { + "dogsAges": [ + 7, + 5 + ] + } + ] + """ + ``` + +### Select multiple elements and create a new list or object + +Use [Multiselect](https://jmespath.org/tutorial.html#multiselect){:target=_blank .external-link} to select elements from a JSON object and combine them into a new list or object. + +Given this JSON from a webhook node: + + +```js +[ + { + "headers": { + "host": "n8n.instance.address", + ... + }, + "params": {}, + "query": {}, + "body": { + "people": [ + { + "first": "James", + "last": "Green" + }, + { + "first": "Jacob", + "last": "Jones" + }, + { + "first": "Jayden", + "last": "Smith" + } + ], + "dogs": { + "Fido": { + "color": "brown", + "age": 7 + }, + "Spot": { + "color": "black and white", + "age": 5 + } + } + } + } +] + +``` + + +Use multiselect list to get the first and last names and create new lists containing both names: + +=== "Expressions (JavaScript)" + + [[% raw %]] + ```js + {{$jmespath($json.body.people, "[].[first, last]")}} + // Returns [["James","Green"],["Jacob","Jones"],["Jayden","Smith"]] + ``` + [[% endraw %]] + +=== "Code node (JavaScript)" + + ```js + let newList = $jmespath($json.body.people, "[].[first, last]"); + return {newList}; + /* Returns: + [ + { + "newList": [ + [ + "James", + "Green" + ], + [ + "Jacob", + "Jones" + ], + [ + "Jayden", + "Smith" + ] + ] + } + ] + */ + ``` +=== "Code node (Python)" + ```python + newList = _jmespath(_json.body.people, "[].[first, last]") + return {"newList":newList} + """ + Returns: + [ + { + "newList": [ + [ + "James", + "Green" + ], + [ + "Jacob", + "Jones" + ], + [ + "Jayden", + "Smith" + ] + ] + } + ] + """ + ``` + +### An alternative to arrow functions in expressions + +For example, generate some input data by returning the below code from the Code node: + +```js +return[ + { + "json": { + "num_categories": "0", + "num_products": "45", + "category_id": 5529735, + "parent_id": 1407340, + "pos_enabled": 1, + "pos_favorite": 0, + "name": "HP", + "description": "", + "image": "" + } + }, + { + "json": { + "num_categories": "0", + "num_products": "86", + "category_id": 5529740, + "parent_id": 1407340, + "pos_enabled": 1, + "pos_favorite": 0, + "name": "Lenovo", + "description": "", + "image": "" + } + } +] +``` + +You could do a search like "find the item with the name Lenovo and tell me their category ID." + +```js +{{ $jmespath($("Code").all(), "[?json.name=='Lenovo'].json.category_id") }} +``` + + +# code/cookbook/luxon.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Date and time with Luxon +description: Use Luxon to work with date and time in n8n. +contentType: howto +--- + +# Date and time with Luxon + +[Luxon](https://github.com/moment/luxon/){:target=_blank .external-link} is a JavaScript library that makes it easier to work with date and time. For full details of how to use Luxon, refer to [Luxon's documentation](https://moment.github.io/luxon/#/?id=luxon){:target=_blank .external-link}. + +n8n passes dates between nodes as strings, so you need to parse them. Luxon makes this easier. + +/// note | Python support +Luxon is a JavaScript library. The two convenience [variables](#variables) created by n8n are available when using Python in the Code node, but their functionality is limited: + +* You can't perform Luxon operations on these variables. For example, there is no Python equivalent for `$today.minus(...)`. +* The generic Luxon functionality, such as [Convert date string to Luxon](#convert-date-string-to-luxon), isn't available for Python users. +/// + + +## Variables + +n8n uses Luxon to provide two custom variables: + +- `now`: a Luxon object containing the current timestamp. Equivalent to `DateTime.now()`. +- `today`: a Luxon object containing the current timestamp, rounded down to the day. Equivalent to `DateTime.now().set({ hour: 0, minute: 0, second: 0, millisecond: 0 })`. + +Note that these variables can return different time formats when cast as a string. This is the same behavior as Luxon's `DateTime.now()`. + +=== "Expressions (JavaScript)" + + ``` js + {{$now}} + // n8n displays the ISO formatted timestamp + // For example 2022-03-09T14:02:37.065+00:00 + {{"Today's date is " + $now}} + // n8n displays "Today's date is " + // For example "Today's date is 1646834498755" + ``` + +=== "Code node (JavaScript)" + + ``` js + $now + // n8n displays + // For example 2022-03-09T14:00:25.058+00:00 + let rightNow = "Today's date is " + $now + // n8n displays "Today's date is " + // For example "Today's date is 1646834498755" + ``` +=== "Code node (Python)" + ``` python + _now + # n8n displays + # For example 2022-03-09T14:00:25.058+00:00 + rightNow = "Today's date is " + str(_now) + # n8n displays "Today's date is " + # For example "Today's date is 1646834498755" + ``` + +n8n provides built-in convenience functions to support data transformation in expressions for dates. Refer to [Data transformation functions | Dates](/code/builtin/data-transformation-functions/dates.md) for more information. + +## Date and time behavior in n8n + +Be aware of the following: + +* In a workflow, n8n converts dates and times to strings between nodes. Keep this in mind when doing arithmetic on dates and times from other nodes. +* With vanilla JavaScript, you can convert a string to a date with `new Date('2019-06-23')`. In Luxon, you must use a function explicitly stating the format, such as `DateTime.fromISO('2019-06-23')` or `DateTime.fromFormat("23-06-2019", "dd-MM-yyyy")`. + +## Setting the timezone in n8n + +Luxon uses the n8n timezone. This value is either: + +* Default: `America/New York` +* A custom timezone for your n8n instance, set using the `GENERIC_TIMEZONE` environment variable. +* A custom timezone for an individual workflow, configured in workflow settings. + +## Common tasks + +This section provides examples for some common operations. More examples, and detailed guidance, are available in [Luxon's own documentation](https://moment.github.io/luxon/#/?id=luxon){:target="_blank" .external-link}. + + +### Convert date string to Luxon + +You can convert date strings and other date formats to a Luxon DateTime object. You can convert from standard formats and from arbitrary strings. + +/// note | A difference between Luxon DateTime and JavaScript Date +With vanilla JavaScript, you can convert a string to a date with `new Date('2019-06-23')`. In Luxon, you must use a function explicitly stating the format, such as `DateTime.fromISO('2019-06-23')` or `DateTime.fromFormat("23-06-2019", "dd-MM-yyyy")`. +/// +#### If you have a date in a supported standard technical format: + +Most dates use `fromISO()`. This creates a Luxon DateTime from an ISO 8601 string. For example: + +=== "Expressions (JavaScript)" + + ```js + {{DateTime.fromISO('2019-06-23T00:00:00.00')}} + ``` + +=== "Code node (JavaScript)" + + ```js + let luxonDateTime = DateTime.fromISO('2019-06-23T00:00:00.00') + ``` + + +Luxon's API documentation has more information on [fromISO](https://moment.github.io/luxon/api-docs/index.html#datetimefromiso){:target="_blank" .external-link}. + +Luxon provides functions to handle conversions for a range of formats. Refer to Luxon's guide to [Parsing technical formats](https://moment.github.io/luxon/#/parsing?id=parsing-technical-formats) for details. + +#### If you have a date as a string that doesn't use a standard format: + +Use Luxon's [Ad-hoc parsing](https://moment.github.io/luxon/#/parsing?id=ad-hoc-parsing){:target="_blank" .external-link}. To do this, use the `fromFormat()` function, providing the string and a set of [tokens](https://moment.github.io/luxon/#/parsing?id=table-of-tokens){:target="_blank" .external-link} that describe the format. + +For example, you have n8n's founding date, 23rd June 2019, formatted as `23-06-2019`. You want to turn this into a Luxon object: + +=== "Expressions (JavaScript)" + + ```js + {{DateTime.fromFormat("23-06-2019", "dd-MM-yyyy")}} + ``` + +=== "Code node (JavaScript)" + + ```js + let newFormat = DateTime.fromFormat("23-06-2019", "dd-MM-yyyy") + ``` + +When using ad-hoc parsing, note Luxon's warning about [Limitations](https://moment.github.io/luxon/#/parsing?id=limitations){:target="_blank" .external-link}. If you see unexpected results, try their [Debugging](https://moment.github.io/luxon/#/parsing?id=debugging){:target="_blank" .external-link} guide. + +### Get n days from today + +Get a number of days before or after today. + +=== "Expressions (JavaScript)" + + For example, you want to set a field to always show the date seven days before the current date. + + In the expressions editor, enter: + + + ``` js + {{$today.minus({days: 7})}} + ``` + + On the 23rd June 2019, this returns `[Object: "2019-06-16T00:00:00.000+00:00"]`. + + This example uses n8n's custom variable `$today` for convenience. It's the equivalent of `DateTime.now().set({ hour: 0, minute: 0, second: 0, millisecond: 0 }).minus({days: 7})`. + +=== "Code node (JavaScript)" + + For example, you want a variable containing the date seven days before the current date. + + In the code editor, enter: + + ``` js + let sevenDaysAgo = $today.minus({days: 7}) + ``` + + On the 23rd June 2019, this returns `[Object: "2019-06-16T00:00:00.000+00:00"]`. + + This example uses n8n's custom variable `$today` for convenience. It's the equivalent of `DateTime.now().set({ hour: 0, minute: 0, second: 0, millisecond: 0 }).minus({days: 7})`. + +For more detailed information and examples, refer to: + +* Luxon's [guide to math](https://moment.github.io/luxon/#/math) +* Their API documentation on [DateTime plus](https://moment.github.io/luxon/api-docs/index.html#datetimeplus) and [DateTime minus](https://moment.github.io/luxon/api-docs/index.html#datetimeminus) + +### Create human-readable dates + +In [Get n days from today](#get-n-days-from-today), the example gets the date seven days before the current date, and returns it as `[Object: "yyyy-mm-dd-T00:00:00.000+00:00"]` (for expressions) or `yyyy-mm-dd-T00:00:00.000+00:00` (in the Code node). To make this more readable, you can use Luxon's formatting functions. + +For example, you want the field containing the date to be formatted as DD/MM/YYYY, so that on the 23rd June 2019, it returns `23/06/2019`. + +This expression gets the date seven days before today, and converts it to the DD/MM/YYYY format. + +=== "Expressions (JavaScript)" + + ```js + {{$today.minus({days: 7}).toLocaleString()}} + ``` + +=== "Code node (JavaScript)" + + ```js + let readableSevenDaysAgo = $today.minus({days: 7}).toLocaleString() + ``` + +You can alter the format. For example: + +=== "Expressions (JavaScript)" + + ```js + {{$today.minus({days: 7}).toLocaleString({month: 'long', day: 'numeric', year: 'numeric'})}} + ``` + + On 23rd June 2019, this returns "16 June 2019". + +=== "Code node (JavaScript)" + + ```js + let readableSevenDaysAgo = $today.minus({days: 7}).toLocaleString({month: 'long', day: 'numeric', year: 'numeric'}) + ``` + + On 23rd June 2019, this returns "16 June 2019". + +Refer to Luxon's guide on [toLocaleString (strings for humans)](https://moment.github.io/luxon/#/formatting?id=tolocalestring-strings-for-humans){:target="_blank" .external-link} for more information. + + +### Get the time between two dates + +To get the time between two dates, use Luxon's diffs feature. This subtracts one date from another and returns a duration. + +For example, get the number of months between two dates: + +=== "Expressions (JavaScript)" + + ```js + {{DateTime.fromISO('2019-06-23').diff(DateTime.fromISO('2019-05-23'), 'months').toObject()}} + ``` + + This returns `[Object: {"months":1}]`. + +=== "Code node (JavaScript)" + + ```js + let monthsBetweenDates = DateTime.fromISO('2019-06-23').diff(DateTime.fromISO('2019-05-23'), 'months').toObject() + ``` + + This returns `{"months":1}`. + +Refer to Luxon's [Diffs](https://moment.github.io/luxon/#/math?id=diffs){:target=_blank .external-link} for more information. + +### A longer example: How many days to Christmas? + +This example brings together several Luxon features, uses JMESPath, and does some basic string manipulation. + +The scenario: you want a countdown to 25th December. Every day, it should tell you the number of days remaining to Christmas. You don't want to update it for next year - it needs to seamlessly work for every year. + +=== "Expressions (JavaScript)" + + ```js + {{"There are " + $today.diff(DateTime.fromISO($today.year + '-12-25'), 'days').toObject().days.toString().substring(1) + " days to Christmas!"}} + ``` + + This outputs `"There are days to Christmas!"`. For example, on 9th March, it outputs "There are 291 days to Christmas!". + + A detailed explanation of what the expression does: + + * `{{`: indicates the start of the expression. + * `"There are "`: a string. + * `+`: used to join two strings. + * `$today.diff()`: This is similar to the example in [Get the time between two dates](#get-the-time-between-two-dates), but it uses n8n's custom `$today` variable. + * `DateTime.fromISO($today.year + '-12-25'), 'days'`: this part gets the current year using `$today.year`, turns it into an ISO string along with the month and date, and then takes the whole ISO string and converts it to a Luxon DateTime data structure. It also tells Luxon that you want the duration in days. + * `toObject()` turns the result of diff() into a more usable object. At this point, the expression returns `[Object: {"days":-}]`. For example, on 9th March, `[Object: {"days":-291}]`. + * `.days` uses JMESPath syntax to retrieve just the number of days from the object. For more information on using JMESPath with n8n, refer to our [JMESpath](/code/cookbook/jmespath.md) documentation. This gives you the number of days to Christmas, as a negative number. + * `.toString().substring(1)` turns the number into a string and removes the `-`. + * `+ " days to Christmas!"`: another string, with a `+` to join it to the previous string. + * `}}`: indicates the end of the expression. + +=== "Code node (JavaScript)" + + ```js + let daysToChristmas = "There are " + $today.diff(DateTime.fromISO($today.year + '-12-25'), 'days').toObject().days.toString().substring(1) + " days to Christmas!"; + ``` + + This outputs `"There are days to Christmas!"`. For example, on 9th March, it outputs "There are 291 days to Christmas!". + + A detailed explanation of what the code does: + + * `"There are "`: a string. + * `+`: used to join two strings. + * `$today.diff()`: This is similar to the example in [Get the time between two dates](#get-the-time-between-two-dates), but it uses n8n's custom `$today` variable. + * `DateTime.fromISO($today.year + '-12-25'), 'days'`: this part gets the current year using `$today.year`, turns it into an ISO string along with the month and date, and then takes the whole ISO string and converts it to a Luxon DateTime data structure. It also tells Luxon that you want the duration in days. + * `toObject()` turns the result of diff() into a more usable object. At this point, the expression returns `[Object: {"days":-}]`. For example, on 9th March, `[Object: {"days":-291}]`. + * `.days` uses JMESPath syntax to retrieve just the number of days from the object. For more information on using JMESPath with n8n, refer to our [JMESpath](/code/cookbook/jmespath.md) documentation. This gives you the number of days to Christmas, as a negative number. + * `.toString().substring(1)` turns the number into a string and removes the `-`. + * `+ " days to Christmas!"`: another string, with a `+` to join it to the previous string. + + +# code/expressions.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Expressions + +Expressions are a powerful feature implemented in all n8n nodes. They allow node parameters to be set dynamically based on data from: + +- Previous node executions +- The workflow +- Your n8n environment + +You can also execute JavaScript within an expression, making this a convenient and easy way to manipulate data into useful parameter values without writing extensive extra code. + +n8n created and uses a templating language called [Tournament](https://github.com/n8n-io/tournament){:target=_blank .external-link}, and extends it with [custom methods and variables](/code/builtin/overview.md) and [data transformation functions](/code/builtin/data-transformation-functions/index.md). These features make it easier to perform common tasks like getting data from other nodes or accessing workflow metadata. + +n8n additionally supports two libraries: + +- [Luxon](https://github.com/moment/luxon/){:target=_blank .external-link}, for working with dates and time. +- [JMESPath](https://jmespath.org/){:target=_blank .external-link}, for querying JSON. + +/// note | Data in n8n +When writing expressions, it's helpful to understand data structure and behavior in n8n. Refer to [Data](/data/index.md) for more information on working with data in your workflows. +/// + +## Writing expressions + +To use an expression to set a parameter value: + +1. Hover over the parameter where you want to use an expression. +2. Select **Expressions** in the **Fixed/Expression** toggle. +3. Write your expression in the parameter, or select **Open expression editor** ![Open expressions editor icon](/_images/common-icons/open-expression-editor.png){.off-glb} to open the expressions editor. If you use the expressions editor, you can browse the available data in the **Variable selector**. All expressions have the format `{{ your expression here }}`. + + +### Example: Get data from webhook body + +Consider the following scenario: you have a webhook trigger that receives data through the webhook body. You want to extract some of that data for use in the workflow. + +Your webhook data looks similar to this: + + +```json +[ + { + "headers": { + "host": "n8n.instance.address", + ... + }, + "params": {}, + "query": {}, + "body": { + "name": "Jim", + "age": 30, + "city": "New York" + } + } +] +``` + + +In the next node in the workflow, you want to get just the value of `city`. You can use the following expression: + + +```js +{{$json.body.city}} +``` + +This expression: + +1. Accesses the incoming JSON-formatted data using n8n's custom `$json` variable. +2. Finds the value of `city` (in this example, "New York"). Note that this example uses JMESPath syntax to query the JSON data. You can also write this expression as `{{$json['body']['city']}}`. + + +### Example: Writing longer JavaScript + +An expression contains one line of JavaScript. This means you cannot do things like variable assignments or multiple standalone operations. + +To understand the limitations of JavaScript in expressions, and start thinking about workarounds, look at the following two pieces of code. Both code examples use the Luxon date and time library to find the time between two dates in months, and encloses the code in handlebar brackets, like an expression. + +However, the first example isn't a valid n8n expression: + +```js +// This example is split over multiple lines for readability +// It's still invalid when formatted as a single line +{{ + function example() { + let end = DateTime.fromISO('2017-03-13'); + let start = DateTime.fromISO('2017-02-13'); + let diffInMonths = end.diff(start, 'months'); + return diffInMonths.toObject(); + } + example(); +}} +``` + +While the second example is valid: + +```js +{{DateTime.fromISO('2017-03-13').diff(DateTime.fromISO('2017-02-13'), 'months').toObject()}} +``` + +## Common issues + +For common errors or issues with expressions and suggested resolution steps, refer to [Common Issues](/code/cookbook/expressions/common-issues.md). + + +# code/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Code in n8n Documentation and Guides +description: Access documentation and guides on using code and expressions in n8n and other developer resources. +contentType: overview +--- + +# Code in n8n + +n8n is a low-code tool. This means you can do a lot without code, then add code when needed. + +## Code in your workflows + +There are two places in your workflows where you can use code: + +
+ +- __Expressions__ + + Use [expressions](/glossary.md#expression-n8n) to transform [data](/data/index.md) in your nodes. You can use JavaScript in expressions, as well as n8n's [Built-in methods and variables](/code/builtin/overview.md) and [Data transformation functions](/code/builtin/data-transformation-functions/index.md). + + [:octicons-arrow-right-24: Expressions](/code/expressions.md) + +- __Code node__ + + Use the Code node to add JavaScript or Python to your workflow. + + [:octicons-arrow-right-24: Code node](/code/code-node.md) + +
+ + +## Other technical resources + +These are features that are relevant to technical users. + +### Technical nodes + +n8n provides core nodes, which simplify adding key functionality such as API requests, webhooks, scheduling, and file handling. + +
+ +- __Write a backend__ + + The [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md), [Webhook](/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md), and [Code](/code/code-node.md) nodes help you make API calls, respond to webhooks, and write any JavaScript in your workflow. + + Use this do things like [Create an API endpoint](https://n8n.io/workflows/1750-creating-an-api-endpoint/){:target=_blank .external-link}. + + [:octicons-arrow-right-24: Core nodes](/integrations/builtin/core-nodes/index.md) + +- __Represent complex logic__ + + You can build complex flows, using nodes like [If](/integrations/builtin/core-nodes/n8n-nodes-base.if.md), [Switch](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md), and [Merge](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md) nodes. + + [:octicons-arrow-right-24: Flow logic](/flow-logic/index.md) + +
+ +### Other developer resources + +
+ +- __The n8n API__ + + 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](/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md) to access the API in your workflows. + + [:octicons-arrow-right-24: API](/api/index.md) + +- __Self-host__ + + You can self-host n8n. This keeps your data on your own infrastructure. + + [:octicons-arrow-right-24: Hosting](/hosting/index.md) + +- __Build your own nodes__ + + You can build custom nodes, install them on your n8n instance, and publish them to [npm](https://www.npmjs.com/){:target=_blank .external-link}. + + [:octicons-arrow-right-24: Creating nodes](/integrations/creating-nodes/overview.md) + +
+ + +# code/variables.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 + +description: Custom variables allow you to store and reuse values in n8n workflows. +contentType: howto +--- + +# Custom variables + +/// info | Feature availability +* Available on Self-hosted Enterprise and Pro Cloud plans. +* You need access to the n8n instance owner account to create and edit variables. All users can use existing variables. + +Available in version 0.225.0 and above. +/// + +Custom variables are read-only variables that you can use to store and reuse values in n8n workflows. + +/// warning | Variables are shared +When you create a variable, it's available to everyone on your n8n instance. +/// + +## Create variables + +To create a new variable: + +1. On the **Variables** page, select **Add Variable**. +2. Enter a **Key** and **Value**. The maximum key length is 50 characters, and the maximum value length is 220 characters. n8n limits the characters you can use in the key and value to lowercase and uppercase letters, numbers, and underscores (`A-Z`, `a-z`, `0-9`, `_`). +3. Select **Save**. The variable is now available for use in all workflows in the n8n instance. + +## Edit and delete variables + +To edit or delete a variable: + +1. On the **Variables** page, hover over the variable you want to change. +2. Select **Edit** or **Delete**. + +## Use variables in workflows + +You can access variables in the Code node and in [expressions](/glossary.md#expression-n8n): + +```javascript +// Access a variable +$vars. +``` + +All variables are strings. + +During workflow execution, n8n replaces the variables with the variable value. If the variable has no value, n8n treats its value as `undefined`. Workflows don't automatically fail in this case. + +Variables are read-only. You must use the UI to change the values. If you need to set and access custom data within your workflow, use [Workflow static data](/code/cookbook/builtin/get-workflow-static-data.md). diff --git a/llms/courses.md b/llms/courses.md new file mode 100644 index 00000000000..454b9d6a1fe --- /dev/null +++ b/llms/courses.md @@ -0,0 +1,3413 @@ + + +# courses/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Text courses +description: Access n8n text courses. Find beginner and intermediate courses to learn how to build automation workflows using n8n. +contentType: overview +--- + +# Text courses + +If 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. + +Whatever 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. + +These 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. + +## Available courses + +- [Level 1: Beginner course](/courses/level-one/index.md) +- [Level 2: Intermediate course](/courses/level-two/index.md) + + +# courses/level-one/chapter-1.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# Navigating the Editor UI + +In this lesson you will learn how to navigate the [Editor UI](/glossary.md#editor-n8n). We will walk through the [canvas](/glossary.md#canvas-n8n) and show you what each icon means and where to find things you will need while building workflows in n8n. + +/// warning | n8n version +This 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. +/// + +## Getting started + +Begin by setting up n8n. + +We recommend starting with [n8n Cloud](https://app.n8n.cloud/register), a hosted solution that doesn't require installation and includes a free trial. + +/// note | Alternative set up +If n8n Cloud isn't a good option for you, you can [self-host with Docker](/hosting/installation/docker.md). This is an advanced option recommended only for technical users familiar with hosting services, Docker, and the command line. +/// + +For more details on the different ways to set up n8n, see our [platforms documentation](/choose-n8n.md#platforms). + +Once 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. + +It should look like this: + +
Editor UI
Editor UI
+ +## Editor UI settings + +The editor UI is the web interface where you build [workflows](/workflows/index.md). You can access all your workflows and [credentials](/glossary.md#credential-n8n), as well as support pages, from the Editor UI. + +### Left-side panel + +On 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. + +The panel contains the following sections: + +- **Overview**: Contains all the workflows and credentials you have access to. During this course, create new workflows here. +- **Projects**: (Not available on Community edition) Projects group workflows and credentials. You can assign [roles](/user-management/rbac/role-types.md) to users in a project to control what they can do in a project. A **Personal** project is available by default. +- **Admin Panel**: n8n Cloud only. Access your n8n instance usage, billing, and version settings. +- **Templates**: A collection of pre-made workflows. Great place to get started with common use cases. +- **Variables**: Used to store and access fixed data across your workflows. This feature is available on the Pro and Enterprise Plans. +- **All executions**: Contains information about your workflow executions. +- **Help**: Contains resources around n8n product and community. +- **Update**: (When updates are available) Indicator for any recent product updates. +- **Settings**: Under the ellipsis (`...`) menu by your username. Manage users and access settings for a variety of features. + +
Editor UI left-side menu
Editor UI left-side menu
+ +### Top bar + +The top bar of the **Editor UI** contains the following information: + +- **Workflow Name**: By default, n8n names a new workflow as "My workflow", but you can edit the name at any time. +- **+ Add Tag**: Tags help you organise your workflows by category, use case, or whatever is relevant for you. Tags are optional. +- **Inactive/active toggle**: This button activates or deactivates the current workflow. By default, workflows are deactivated. +- **Share**: You can share and collaborate with others on workflows on the Starter, Pro, and Enterprise plans. +- **Save**: This button saves the current workflow. +- **History**: Once you save your workflow, you can view previous versions here. + +
Editor UI top bar
Editor UI top bar
+ +### Canvas + +The **canvas** is the gray dotted grid background in the Editor UI. It displays several icons and a node with different functionalities: + +- Buttons to zoom the canvas to fit the screen, zoom in or out of the canvas, and tidy up the nodes on screen. +- 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. +- A button with a **+** sign inside. This button opens the nodes panel. +- A button with a note icon inside. This button adds a [sticky note](/workflows/components/sticky-notes.md) to the canvas (visible when hovering on the top right + icon). +- A dotted square with the text "Add first step." This is where you add your first node. + +
Workflow canvas
Workflow canvas
+ +/// note | Moving the canvas +You can move the workflow canvas around in three ways: + +- Select ++ctrl+left-button++ on the canvas and move it around. +- Select ++middle-button++ on the canvas and move it around. +- Place two fingers on your touchpad and slide. +/// + + +Don't worry about workflow execution and activation for now; we'll explain these concepts later on in the course. + +## Nodes + +You can think of nodes as building blocks that serve different functions that, when put together, make up a functioning machine: an automated workflow. + +/// note | Node +A node is an individual step in your workflow: one that either (a) loads, (b) processes, or (c) sends data. +/// + +Based on their function, n8n classifies nodes into four types: + +- **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](/integrations/builtin/app-nodes/index.md) for a full list of these nodes. +- **Trigger Nodes** start a workflow and supply the initial data. Refer to the [Trigger nodes library](/integrations/builtin/trigger-nodes/index.md) for a list of trigger nodes. +- **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](/integrations/builtin/core-nodes/index.md) for a full list of core nodes. +- **Cluster Nodes** are node groups that work together to provide functionality in a workflow, primarily for AI workflows. Refer to [Cluster nodes](/integrations/builtin/cluster-nodes/index.md) for more information. + +/// note | Learn more +Refer to [Node types](/integrations/builtin/node-types.md) for a more detailed explanation of all node types. +/// + +### Finding nodes + +You 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: + +- Click the **+** icon in the top right corner of the canvas. +- Click the **+** icon on the right side of an existing node on the canvas (the node to which you want to add another one). +- Click the ++tab++ key on your keyboard. + +
Nodes panel
Nodes panel
+ +In 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. + +If you want to find a specific node, use the search input at the top of the nodes panel. + + +### Adding nodes + +There are two ways to add nodes to your canvas: + +- Select the node you want in the nodes panel. The new node will automatically connect to the selected node on the canvas. +- Drag and drop the node from the nodes panel to the canvas. + +### Node buttons + +If you hover on a node, you'll notice that three icons appear on top: + +- Execute the node (Play icon) +- Deactivate/Activate the node (Power icon) +- Delete the node (Trash icon) + +There will also be an ellipsis icon, which opens a context menu containing other [node options](/workflows/components/nodes.md#node-controls). + +/// note | Moving a workflow +To 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. +/// + +## Summary + +In 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. + +In the next lesson, you will build a mini-workflow to put into practice what you've learned so far. + + +# courses/level-one/chapter-2.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# Building a Mini-workflow + +In this lesson, you will build a small [workflow](/glossary.md#workflow-n8n) that gets 10 articles about automation from Hacker News. The process consists of five steps: + +1. [Add a Manual Trigger node](#1-add-a-manual-trigger-node) +2. [Add the Hacker News node](#2-add-the-hacker-news-node) +3. [Configure the Hacker News node](#3-configure-the-hacker-news-node) +4. [Execute the node](#4-execute-the-node) +5. [Save the workflow](#5-save-the-workflow) + +The finished workflow will look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-2.json") ]] + +## 1. Add a Manual Trigger node + +Open the nodes panel (reminder: you can open this by selecting the **+** icon in the top right corner of the [canvas](/glossary.md#canvas-n8n) or selecting ++tab++ on your keyboard). + +Then: + +1. Search for the **Manual Trigger** node. +2. Select it when it appears in the search. + +This will add the [Manual Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md) node to your canvas, which allows you to run the workflow at any time by selecting the **Execute workflow** button. + +/// note | Manual triggers +For 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. + +In a real-world scenario, you would probably want to set up a schedule or some other [trigger](/glossary.md#trigger-node-n8n) to run the workflow. +/// + +## 2. Add the Hacker News node + +Select the **+** icon to the right of the Manual Trigger node to open the nodes panel. + +Then: + +1. Search for the **Hacker News** node. +2. Select it when it appears in the search. +3. In the **Actions** section, select **Get many items**. + +n8n adds the node to your canvas and the node window opens to display its configuration details. + +## 3. Configure the Hacker News node + +When 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: + +- **Parameters**: Adjust parameters to refine and control the node's functionality. +- **Settings**: Adjust settings to control the node's design and executions. +- **Docs**: Open the n8n documentation for this node in a new window. + + +/// note | Parameters vs. Settings +* **Parameters** are different for each node, depending on its functionality. +* **Settings** are the same for all nodes. +/// + + +### Parameters + +We need to configure several parameters for the Hacker News node to make it work: + +- **Resource**: All
+This resource selects all data records (articles). +- **Operation**: Get Many
+This operation fetches all the selected articles. +- **Limit**: 10
+This parameter sets a limit to the number of results the Get Many operation returns. +- **Additional Fields** > **Add Field** > **Keyword**: automation
+**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."
+ +The configuration of the parameters for the Hacker News node should now look like this: + +
Hacker News node parameters
Hacker News node parameters
+ +### Settings + +The **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. + +In the Hacker News node Settings, edit: + +- **Notes**: Get the 10 latest articles. + + /// note | Node notes + 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! + /// + +- **Display note in flow?**: toggle to true
+This option will display the Note under the node in the canvas. + +The configuration of the settings for the Hacker News node should now look like this: + +
Hacker News node settings
Hacker News node settings
+ + +/// note | Renaming a node +You can rename the node with a name that's more descriptive for your use case. There are three ways to do this: + +- Select the node you want to rename and at the same time press the F2 key on your keyboard. +- 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. +- Right-click on the node and select the **Rename** option, or select the node and press F2 on your keyboard. + +
Renaming a node
Renaming a node from the keyboard
+ +To 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. +/// + +## 4. Execute the node + +Select the **Execute step** button in the node details window. You should see 10 results in the Output **Table** view. + + +
Results in Table view for the Hacker News node
Results in Table view for the Hacker News node
+ +### Node executions + +/// note | Node execution +A node execution represents a run of that node to retrieve or process the specified data. +/// + +If a node executes successfully, a small green checkmark appears on top of the node in the canvas + +
Successfully executed workflow
Successfully executed workflow
+ +If 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. + +/// note | Table vs JSON views +The **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. +/// + +Here's our Hacker News output in JSON view: + +
Results in JSON view for the Hacker News node
Results in JSON view for the Hacker News node
+ +The node window displays more information about the node execution: + +- 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: + - **Start Time**: When the node execution started. + - **Execution Time**: How long it took for the node to return the results from the moment it started executing. +- 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. + + +/// warning | Error in nodes +A 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. +/// +
Error in nodes
Error in nodes
+ +## 5. Save the workflow + +Once you're finished editing the node, select **Back to canvas** to return to the main canvas. + +By default, your workflow is automatically saved as "My workflow." + +For this lesson, rename the workflow to be "Hacker News workflow." + +/// note | Reminder +You can rename a workflow by clicking on the workflow's name at the top of the Editor UI. +/// + +Once you've renamed the workflow, be sure to save it. + +There are two ways in which you can save a workflow: + +- From the Canvas in Editor UI, click **Ctrl + S** or **Cmd + S** on your keyboard. +- 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. + +If you see a grey **Saved** text instead of the **Save** button, your workflow was automatically saved. + +## Summary + +Congratulations, 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. + +In 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. + + +# courses/level-one/chapter-3.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + +# Automating a (Real-world) Use Case + +Meet 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. + +Some 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. + +## Understanding the scenario + +**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? + +**Nathan 🙋:** Thanks for coming in! The most annoying one's gotta be the weekly sales reporting. + +I 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. + +This 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. + +**You 👩‍🔧:** Oh no! Doesn't the data warehouse have a way to export the data? + +**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. + +**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! + + +# courses/level-one/chapter-4.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# Designing the Workflow + +Now that we know what Nathan wants to automate, let's consider the steps he needs to take to achieve his goals: + +1. Get the relevant data (order id, order status, order value, employee name) from the data warehouse +2. Filter the orders by their status (Processing or Booked) +3. Calculate the total value of all the Booked orders +4. Notify the team members about the Booked orders in the company's Discord channel +5. Insert the details about the Processing orders in Airtable for follow-up +6. Schedule this workflow to run every Monday morning + +Nathan's workflow involves sending data from the company's data warehouse to two external services: + +- Discord +- Airtable + +Before that, the data has to be wrangled with general functions (conditional filtering, calculation, scheduling). + +n8n provides integrations for all these steps, so Nathan's workflow in n8n would look like this: + +[[ workflowDemo("file:////courses/level-one/finished.json") ]] + +You will build this workflow in eight steps: + +1. [Getting data from the data warehouse](/courses/level-one/chapter-5/chapter-5.1.md) +2. [Inserting data into Airtable](/courses/level-one/chapter-5/chapter-5.2.md) +3. [Filtering orders](/courses/level-one/chapter-5/chapter-5.3.md) +4. [Setting values for processing orders](/courses/level-one/chapter-5/chapter-5.4.md) +5. [Calculating booked orders](/courses/level-one/chapter-5/chapter-5.5.md) +6. [Notifying the team](/courses/level-one/chapter-5/chapter-5.6.md) +7. [Scheduling the workflow](/courses/level-one/chapter-5/chapter-5.7.md) +8. [Activating and examining the workflow](/courses/level-one/chapter-5/chapter-5.8.md) + +To 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){:target="_blank" .external-link}. If you haven't received a confirmation email after signing up, [contact us](mailto:help@n8n.io). + +[Start building!](/courses/level-one/chapter-5/chapter-5.1.md){ .md-button } + + +# courses/level-one/chapter-5/chapter-5.1.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 1. Getting data from the data warehouse + +In this part of the workflow, you will learn how to get data by making HTTP requests with the [**HTTP Request**](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node. + +After completing this section, your workflow will look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.1.json") ]] + +First, let's set the scene for building Nathan's workflow. + +## Create new workflow + +Open your Editor UI and create a new workflow with one of the two possible commands: + +- Select ++ctrl+alt+n++ or ++cmd+option+n++ on your keyboard. +- Open the left menu, navigate to **Workflows**, and select **Add workflow**. + +Name this new workflow "Nathan's workflow." + +The first thing you need to do is get data from ABCorp's old data warehouse. + +In 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. + +Though 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](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node in n8n. + +/// note | No node for that service? +The 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. +/// + +## Add an HTTP Request node + +Now, in your Editor UI, add an HTTP Request node like you learned in the lesson [Adding nodes](/courses/level-one/chapter-1.md#adding-nodes). The node window will open, where you need to configure some parameters. + +
HTTP Request node
HTTP Request node
+ +This node will use credentials. + +/// note | Credentials +[Credentials](/glossary.md#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. +/// + +In 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){:target="_blank" .external-link}. + +In the **Parameters** of the HTTP Request node, make the following adjustments: + +- **Method**: This should default to GET. Make sure it's set to GET. +- **URL**: Add the **Dataset URL** you received in the email when you signed up for this course. +- **Send Headers**: Toggle this control to true. In **Specify Headers**, ensure **Using Fields Below** is selected. + - **Header Parameters** > **Name**: Enter `unique_id`. + - **Header Parameters** > **Value**: The Unique ID you received in the email when you signed up for this course. +- **Authentication**: Select **Generic Credential Type**. This option requires credentials before allowing you to access the data. + - **Generic Auth Type**: Select **Header Auth**. (This field will appear after you select the Generic Credential Type for the Authentication.) + - **Credential for Header Auth**: To add your credentials, select **+ Create new credential**. This will open the Credentials window. + - In the Credentials window, set **Name** to be the **Header Auth name** you received in the email when you signed up for this course. + - In the Credentials window, set **Value** to be the **Header Auth value** you received in the email when you signed up for this course. + - Select the **Save** button in the Credentials window to save your credentials. Your **Credentials Connection** window should look like this: +
HTTP Request node credentials
HTTP Request node credentials
+ +/// note | Credentials naming +New 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. +/// + +Once you save, exit out of the Credentials window to return to the HTTP Request node. + +## Get the data + +Select the **Execute step** button in the HTTP Request node window. The table view of the HTTP request results should look like this: + +
HTTP Request node output
HTTP Request node output
+ +This view should be familiar to you from the [Building a mini-workflow](/courses/level-one/chapter-2.md) page. + +This 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: + +- `orderID`: The unique id of each order. +- `customerID`: The unique id of each customer. +- `employeeName`: The name of Nathan's colleague responsible for the customer. +- `orderPrice`: The total price of the customer's order. +- `orderStatus`: Whether the customer's order status is `booked` or still in `processing`. + +## What's next? + +**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. + +**You 👩‍🔧**: Exactly! In the next step, I'll help you one step further and insert the data you retrieved into Airtable. + + +# courses/level-one/chapter-5/chapter-5.2.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 2. Inserting data into Airtable + +In 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](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md). + +/// note | Spreadsheet nodes +You can replace the Airtable node with another spreadsheet app/service. For example, n8n also has a node for [**Google Sheets**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md). +/// + +After this step, your workflow should look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.2.json") ]] + +## Configure your table + +If we're going to insert data into Airtable, we first need to set up a table there. To do this: + +1. [Create an Airtable account](https://airtable.com/signup){:target="_blank" .external}. +2. In your Airtable workspace add a new base from scratch and name it, for example, *beginner course*. + +
Create an Airtable base
Create an Airtable base
+ +3. 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: + + * Rename the table from **Table 1** to **orders** to make it easier to identify. + * Delete the 3 blank records created by default. + * Delete the `Notes`, `Assignee`, and `Status` fields. + * Edit the `Name` field (the primary field) to read `orderID`, with the **Number** field type. + * Add the rest of the fields, and their field types, using the table below as a reference: + + | Field name | Field type | + |----------------|------------------| + | `orderID` | Number | + | `customerID` | Number | + | `employeeName` | Single line text | + | `orderPrice` | Number | + | `orderStatus` | Single line text | + + +Now your table should look like this: + +
Orders table in Airtable
Orders table in Airtable
+ +Now that the table is ready, let's return to the workflow in the n8n Editor UI. + +## Add an Airtable node to the HTTP Request node + +Add an Airtable node connected to the HTTP Request node. + +///note | Remember +You can add a node connected to an existing node by selecting the **+** icon next to the existing node. +/// + +In the node panel: + +1. Search for Airtable. +2. Select **Create a record** from the **Record Actions** search results. + +This will add the Airtable node to your canvas and open the node details window. + +In the Airtable node window, configure the following parameters: + +- **Credential to connect with**: + - Select **Create new credential**. + - Keep the default option **Connect using: Access Token** selected. + - **Access token**: Follow the instructions from the [Airtable credential](/integrations/builtin/credentials/airtable.md) 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. +- **Resource**: Record. +- **Operation**: Create. This operation will create new records in the table. +- **Base**: You can pick your base from a list (for example, beginner course). +- **Table**: orders. +- **Mapping Column Mode**: Map automatically. In this mode, the incoming data fields must have the same as the columns in Airtable. + +## Test the Airtable node + +Once 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. + +Your results should look like this: + +
Airtable node results
Airtable node results
+ +All 30 data records will now appear in the orders table in Airtable: + +
Imported records in the orders table
Imported records in the orders table
+ +## What's next? + +**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? + +**You 👩‍🔧**: Sure, no problem. As a next step, I'll use a new node to filter the orders based on their status. + + +# courses/level-one/chapter-5/chapter-5.3.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 3. Filtering Orders + +In 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](/integrations/builtin/core-nodes/n8n-nodes-base.if.md). + +After this step, your workflow should look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.3.json") ]] + +To 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`). + +This if-then-else command is conditional logic. In n8n workflows, you can add conditional logic with the [If node](/integrations/builtin/core-nodes/n8n-nodes-base.if.md), which splits a workflow conditionally based on comparison operations. + +/// note | If vs. Switch +If you need to filter data on more than boolean values (true and false), use the [Switch node](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md). The Switch node is similar to the If node, but supports multiple output connectors. +/// + +## Add If node before the Airtable node + +First, let's add an If node between the connection from the HTTP Request node to the Airtable node: + +1. Hover over the arrow connection the **HTTP Request** node and the **Airtable** node. +2. Select the **+** sign between the HTTP Request node and the Airtable node. + +## Configure the If node + +Selecting 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: + +1. Search for the If node. +2. Select it when it appears in the search. + +For the If node, we'll use an expression. + +/// note | Expressions +An [expression](/glossary.md#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. +/// + +In the If node window, configure the parameters: + +- Set the `value1` placeholder to `{{ $json.orderStatus }}` with the following steps: + 1. Hover over the value1 field. + 2. Select the **Expression** tab on the right side of the `value1` field. + 3. Next, open the expression editor by selecting the link icon: +
Opening the Expression Editor
Opening the Expression Editor
+ 4. Use the left-side panel to select **HTTP Request** > **orderStatus** and drag it into the **Expression** field in the center of the window. +
Expression Editor in the IF node
Expression Editor in the If node
+ 6. Once you add the expression, close the **Edit Expression** dialog. + +- **Operation**: Select **String** > **is equal to** +- Set the `value2` placeholder to `processing`. + +/// warning | Data Type +Make sure to select the correct data type (boolean, date & time, number, or string) when you select the **Operation**. +/// + +Select **Execute step** to test the If node. + +Your results should look like this: + +
If node output
If node output
+ +Note 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. + +Close the If node detail view when you're finished. + +## Insert data into Airtable + +Next, we want to insert this data into Airtable. Remember what Nathan said at the end of the [Inserting data into Airtable](/courses/level-one/chapter-5/chapter-5.2.md) lesson? + +> I actually need to insert only processing orders in the table... + +Since Nathan only needs the `processing` orders in the table, we'll connect the Airtable node to the If node's `true` connector. + +In this case, since the Airtable node is already on our canvas, select the **If node** `true` connector and drag it to the Airtable node. + +It'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**. + +Review 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. + +At this stage, your workflow should look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.3.json") ]] + +## What's next? + +**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. + +**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. + +**Nathan 🙋**: Oh, that's good to know. Can you select only two fields from the processing orders? + +**You 👩‍🔧**: Sure, I'll do that in the next step. + + +# courses/level-one/chapter-5/chapter-5.4.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 4. Setting Values for Processing Orders + +In 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: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.4.json") ]] + +The next step in Nathan's workflow is to filter the data to only insert the `employeeName` and `orderID` of all `processing` orders into Airtable. + +For this, you need to use the [Edit Fields (Set) node](/integrations/builtin/core-nodes/n8n-nodes-base.set.md), which allows you to select and set the data you want to transfer from one node to another. + +/// note | Edit Fields node +The 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. +/// + +## Add another node before the Airtable node + +In your workflow, add another node before the **Airtable node** from the **If node** in the same way we did it in the [Filtering Orders](/courses/level-one/chapter-5/chapter-5.3.md#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. + +## Configure the Edit Fields node + +Now search for the **Edit Fields (Set) node** after you've selected the **+** sign coming off the If node's `true` connector. + +With the Edit Fields node window open, configure these parameters: + +- Ensure **Mode** is set to **Manual Mapping**. +- While you can use the **Expression editor** we used in the [Filtering Orders](/courses/level-one/chapter-5/chapter-5.3.md) lesson, this time, let's drag the fields from the **Input** into the **Fields to Set**: + - Drag **If** > **orderID** as the first field. + - Drag **If** > **employeeName** as the second field. +- Ensure that **Include Other Input Fields** is set to false. + +Select **Execute step**. You should see the following results: + +
Edit Fields (Set) node
Edit Fields (Set) node
+ +## Add data to Airtable + +Next, let's insert these values into Airtable: + +1. Go to your Airtable base. +2. Add a new table called `processingOrders`. +3. Replace the existing columns with two new columns: + - `orderID` (primary field): Number + - `employeeName`: Single line text + + ///note | Reminder + If you get stuck, refer to the [Inserting data into Airtable](/courses/level-one/chapter-5/chapter-5.2.md) lesson. + /// + +4. Delete the three empty rows in the new table. +5. In n8n, connect the Edit Fields node** connector to the **Airtable node**. +6. Update the Airtable node configuration to point to the new `processingOrders` table instead of the `orders` table. +7. Test your Airtable node to be sure it inserts records into the new `processingOrders` table. + +At this stage, your workflow should now look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.4.json") ]] + +## What's next? + +**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? + +**You 👩‍🔧**: Yes! In the next step, I'll use some JavaScript code in a node to calculate the booked orders. + + +# courses/level-one/chapter-5/chapter-5.5.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 5. Calculating Booked Orders + +In 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: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.5.json") ]] + +The next step in Nathan's workflow is to calculate two values from the booked orders: + +- The total number of booked orders +- The total value of all booked orders + +To calculate data and add more functionality to your workflows you can use the Code node, which lets you write custom JavaScript code. + +## About the Code node + +/// warning | Code node modes +The Code node has two operational **modes**, depending on how you want to process items: + +* **Run Once for All Items** allows you to write code to process all input items at once, as a group. +* **Run Once for Each Item** executes your code once for each input item. + +Learn more about how to use the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). +/// + +In n8n, the data that's passed between nodes is an array of objects with the following JSON structure: + +```json +[ + { + "json": { // (1)! + "apple": "beets", + "carrot": { + "dill": 1 + } + }, + "binary": { // (2)! + "apple-picture": { // (3)! + "data": "....", // (4)! + "mimeType": "image/png", // (5)! + "fileExtension": "png", // (6)! + "fileName": "example.png", // (7)! + } + } + }, + ... +] +``` + +1. (required) n8n stores the actual data within a nested `json` key. This property is required, but can be set to anything from an empty object (like `{}`) to arrays and deeply nested data. The code node automatically wraps the data in a `json` object and parent array (`[]`) if it's missing. +2. (optional) Binary data of item. Most items in n8n don't contain binary data. +3. (required) Arbitrary key name for the binary data. +4. (required) Base64-encoded binary data. +5. (optional) Should set if possible. +6. (optional) Should set if possible. +7. (optional) Should set if possible. + +You can learn more about the expected format on the [n8n data structure](/data/data-structure.md) page. + +## Configure the Code node + +Now let's see how to accomplish Nathan's task using the Code node. + +In your workflow, add a **Code node** connected to the `false` branch of the **If node**. + +With the Code node window open, configure these parameters: + +- **Mode**: Select **Run Once for All Items**. +- **Language**: Select **JavaScript**. + + /// note | Using Python in code nodes + While we use JavaScript below, you can also use Python in the Code node. To learn more, refer to the [Code node](/code/code-node.md) documentation. + /// + +- Copy the Code below and paste it into the **Code** box to replace the existing code: + + ```javascript + 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} }]; + ``` + +Notice the format in which we return the results of the calculation: + +```javascript +return [{ json: {totalBooked, bookedSum} }] +``` + +/// warning | Data structure error +If you don't use the correct data structure, you will get an error message: `Error: Always an Array of items has to be returned!` +/// + +Now select **Execute step** and you should see the following results: + +
Code node output
Code node output
+ +## What's next? + +**Nathan 🙋**: Wow, the Code node is powerful! This means that if I have some basic JavaScript skills I can power up my workflows. + +**You 👩‍🔧**: Yes! You can progress from no-code to low-code! + +**Nathan 🙋**: Now, how do I send the calculations for the booked orders to my team's Discord channel? + +**You 👩‍🔧**: There's an n8n node for that. I'll set it up in the next step. + + +# courses/level-one/chapter-5/chapter-5.6.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 6. Notifying the Team + +In this step of the workflow, you will learn how to send messages to a Discord channel using the [Discord node](/integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md). After this step, your workflow should look like this: + +[[ workflowDemo("file:////courses/level-one/chapter-5/chapter-5.6.json") ]] + +Now 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. + +Before 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. + +/// note | Communication app nodes +You can replace the Discord node with another communication app. For example, n8n also has nodes for [Slack](/integrations/builtin/app-nodes/n8n-nodes-base.slack.md) and [Mattermost](/integrations/builtin/app-nodes/n8n-nodes-base.mattermost.md). +/// + +In your workflow, add a Discord node connected to the Code node. + +When you search for the Discord node, look for **Message Actions** and select **Send a message** to add the node. + +In the Discord node window, configure these parameters: + +- **Connection Type**: Select **Webhook**. +- **Credential for Discord Webhook**: Select **- Create New Credential -**. + - 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. + - Select **Save** and then close the credentials dialog. +- **Operation**: Select **Send a Message**. +- **Message**: + - Select the **Expression** tab on the right side of the Message field. + - Copy the text below and paste it into the **Expression** window, or construct it manually using the **Expression Editor**. + ``` + 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"] }} + ``` + +Now select **Execute step** in the Discord node. If all works well, you should see this output in n8n: + +
Discord node output
Discord node output
+ +And your message should appear in the Discord channel #course-level-1: + +
Discord message
Discord message
+ +## What's next? + +**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. + +**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. + + +# courses/level-one/chapter-5/chapter-5.7.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 7. Scheduling the Workflow + +In 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: + +[[ workflowDemo("file:////courses/level-one/finished.json") ]] + +The workflow you've built so far executes only when you click on **Test Workflow**. But Nathan needs it to run automatically every Monday morning. You can do this with the [Schedule Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md), which allows you to schedule workflows to run periodically at fixed dates, times, or intervals. + +To achieve this, we'll remove the Manual Trigger node we started with and replace it with a Schedule Trigger node instead. + +## Remove the Manual Trigger node + +First, let's remove the Manual Trigger node: + +1. Select the Manual Trigger node connected to your HTTP Request node. +2. Select the trash can icon to delete. + +This removes the Manual Trigger node and you'll see an "Add first step" option. + +## Add the Schedule Trigger node + +1. Open the nodes panel and search for **Schedule Trigger**. +2. Select it when it appears in the search results. + +In the Schedule Trigger node window, configure these parameters: + +- **Trigger Interval**: Select **Weeks**. +- **Weeks Between Triggers**: Enter `1`. +- **Trigger on weekdays**: Select **Monday** (and remove **Sunday** if added by default). +- **Trigger at Hour**: Select **9am**. +- **Trigger at Minute**: Enter `0`. + +Your Schedule Trigger node should look like this: + +
Schedule Trigger Node
Schedule Trigger Node
+ +/// warning | Keep in mind +To ensure accurate scheduling with the Schedule Trigger node, be sure to set the correct timezone for your [n8n instance](/manage-cloud/set-cloud-timezone.md) or the [workflow's settings](/workflows/settings.md). 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. +/// + +## Connect the Schedule Trigger node + +Return 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. + +Your full workflow should look like this: + +[[ workflowDemo("file:////courses/level-one/finished.json") ]] + +## What's next? + +**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. + +**Nathan 🙋**: This is just what I needed! My workflow will run automatically every Monday morning, correct? + +**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. + + + +# courses/level-one/chapter-5/chapter-5.8.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# 8. Activating and Examining the Workflow + +In this step of the workflow, you will learn how to activate your workflow and change the default workflow settings. + +Activating 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. + +To 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: + +
Activated workflow
Activated workflow
+ +## Workflow Executions + +An 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. + +To 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. + +To 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. + +
Execution List
Execution List
+ +The **Executions** window displays a table with the following information: + +- **Name**: The name of the workflow +- **Started At**: The date and time when the workflow started +- **Status**: The status of the workflow (Waiting, Running, Succeeded, Cancelled, or Failed) and the amount of time it took the workflow to execute +- **Execution ID**: The ID of this workflow execution + +/// note | Workflow execution status +You 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**](/workflows/settings.md). +/// + + +## Workflow Settings + +You can customize your workflows and executions, or overwrite some global default settings in [**Workflow Settings**](/workflows/settings.md). + +Access 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**. + +
Workflow Settings
Workflow Settings
+ +In the **Workflow Settings** window you can configure the following settings: + +- **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. +- [**Error Workflow**](/flow-logic/error-handling.md): A workflow to run if the execution of the current workflow fails. +- **This workflow can be called by**: Workflows allowed to call this workflow using the [Execute Sub-workflow node](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md). +- **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](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md), as you want to make sure that the workflow gets executed at the right time. +- **Save failed production executions**: If n8n should save the Execution data of the workflow when it fails. Default is to save. +- **Save successful production executions**: If n8n should save the Execution data of the workflow when it succeeds. Default is to save. +- **Save manual executions**: If n8n should save executions started from the Editor UI. Default is to save. +- **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. +- **Timeout Workflow**: Whether to cancel a workflow execution after a specific period of time. Default is to not timeout. + + +## What's next? + +**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. + +**Nathan 🙋**: This workflow is incredibly helpful, thank you! Now, what's next for you? + +**You 👩‍🔧**: I'd like to build more workflows, share them with others, and use some workflows built by other people. + + +# courses/level-one/chapter-6.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# Exporting and importing workflows + +In this chapter, you will learn how to export and import workflows. + +## Exporting and importing workflows + +You 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. + +--8<-- "_snippets/workflows/sharing-credentials.md" + +
Import/Export menu
Import & Export workflows menu
+ +You can export and import workflows in three ways: + +* From the **Editor UI** menu: + * 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. + * 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). +* From the **Editor UI** canvas: + * 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. + * Import: You can paste a copied workflow JSON directly into the canvas with ++ctrl+v++. +* From the command line: + * Export: See the [full list of commands ](/hosting/cli-commands.md) for exporting workflows or credentials. + * Import: See the [full list of commands ](/hosting/cli-commands.md#import-workflows-and-credentials) for importing workflows or credentials. + + +# courses/level-one/chapter-7.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + + + +# Test your knowledge + +Congratulations, you finished the n8n Course Level 1! + +You've learned a lot about workflow automation and built your first business workflow. Why not showcase your skills? + +You can test your knowledge by taking a **quiz**, which consists of questions about the theoretical concepts and workflows covered in this course. + +- You need to have at least 80% correct answers in each part to pass the quiz. +- You can take the quiz as many times as you want. +- There's no time limit on answering the quiz questions. + +
+[Take the quiz!](https://n8n-community.typeform.com/to/JMoBXeGA){ .md-button } + + +## What's next? + +* 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). +* Take the n8n [Course Level 2](/courses/level-two/index.md). + + + +# courses/level-one/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + + + +# Level one: Introduction + +Welcome to the **n8n Course Level 1**! + +## Is this course right for me? + +This course introduces you to the fundamental concepts within n8n and develops your low-code automation expertise. + +This course is for you if you: + +- Are starting to use n8n for the first time. +- Are looking for some extra help creating your first workflow. +- Want to automate processes in your personal or working life. + +This 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](/try-it-out/tutorial-first-workflow.md). + +## What will I learn in this course? + +We 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. + +By the end of this course you will know: + +- How to set up n8n and navigate the Editor UI. +- How n8n structures data. +- How to configure different node parameters and add credentials. +- When and how to use conditional logic in workflows. +- How to schedule and control workflows. +- How to import, download, and share workflows with others. + +You will build two workflows: + +- A two-node workflow to get articles from Hacker News +- 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 + +## What do I need to get started? + +1. **n8n set up**: You can use [n8n Cloud](/manage-cloud/overview.md) (or the [self-hosted version](/hosting/installation/docker.md) if you have experience hosting services). +2. **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. +3. 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. +4. An [account on the n8n community forum](https://community.n8n.io/) if you wish to receive a profile badge and avatar upon successful completion. + +## How long does the course take? + +Completing 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. + +## How do I complete the course? + +There are two milestones in this course that test your knowledge of what you have learned in the lessons: + +- [x] Building the [main workflow](/courses/level-one/chapter-5/chapter-5.1.md) +- [x] Passing the [quiz](https://n8n-community.typeform.com/to/JMoBXeGA) at the end of the course + +/// note | Check your progress +You can always **check your progress** throughout the course by entering your unique ID [here](https://internal.users.n8n.cloud/webhook/course-level-1/verify). +/// + +If 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. + +[Let's get started!](/courses/level-one/chapter-1.md){ .md-button } + + +# courses/level-two/chapter-1.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Understanding the data structure + +In this chapter, you will learn about the data structure of n8n and how to use the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md){:target="_blank"} to transform data and simulate node outputs. + + +## Data structure of n8n + +In 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. + +The 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. + +/// note | About array of objects +An 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. + +An 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`): + +```json +{ + name: 'Michelangelo', + color: 'blue', +} +``` + +An array of objects is an array that contains one or more objects. For example, the array `turtles` below contains four objects: + +```javascript +var turtles = [ + { + name: 'Michelangelo', + color: 'orange', + }, + { + name: 'Donatello', + color: 'purple', + }, + { + name: 'Raphael', + color: 'red', + }, + { + name: 'Leonardo', + color: 'blue', + } +]; +``` + +You 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. +/// + + +Data sent from one node to another is sent as an array of JSON objects. The elements in this collection are called items. + +
Items
+ +An n8n node performs its action on each item of incoming data. + +
Items in the Customer Datastore node
+ + +## Creating data sets with the Code node + +Now 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](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md){:target="_blank"} to write JavaScript code defining your array of objects with the following structure: + +```javascript +return [ + { + json: { + apple: 'beets', + } + } +]; +``` + +For example, the array of objects representing the Ninja turtles would look like this in the Code node: + +
Array of objects in the Code node
+ +/// warning | JSON objects +Notice 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`. + +
Illustration of data structure in n8n
+ +It'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. +/// + +You 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 `{}`. + +/// note | n8n data structure video +[This talk](https://www.youtube.com/watch?v=mQHT3Unn4tY) offers a more detailed explanation of data structure in n8n. + + +/// + + +### Exercise + +In 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`. + +??? note "Show me the solution" + + In the **Code node**, in the JavaScript Code field you have to write the following code: + + ```javascript + var myContacts = [ + { + json: { + name: 'Alice', + email: { + personal: 'alice@home.com', + work: 'alice@wonderland.org' + }, + } + }, + { + json: { + name: 'Bob', + email: { + personal: 'bob@mail.com', + work: 'contact@thebuilder.com' + }, + } + }, + ]; + + return myContacts; + ``` + + When you execute the **Code node**, the result should look like this: + +
Result of Code node
+ + + +## Referencing node data with the Code node + +Just like you can use [expressions](/code/expressions.md) to reference data from other nodes, you can also use some [methods and variables](/code/builtin/overview.md) in the **Code node**. + +Please make sure you read these pages before continuing to the next exercise. + +### Exercise + +Let'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. + +??? note "Show me the solution" + In the **Code node**, in the JavaScript Code field you have to write the following code: + + ```javascript + let items = $input.all(); + items[0].json.workEmail = items[0].json.email['work']; + return items; + ``` + + When you execute the **Code node**, the result should look like this: + +
Code node reference
+ + +## Transforming data + +The 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](/data/transforming-data.md){:target="_blank" .external}, so that each item can be processed individually. + +The two most common operations for data transformation are: + +- Creating multiple items from one item +- Creating a single item from multiple items + +There are several ways to transform data for the purposes mentioned above: + +- Use n8n's [data transformation nodes](/data/index.md#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**: + - Use the [**Split Out node**](/integrations/builtin/core-nodes/n8n-nodes-base.splitout.md) to separate a single data item containing a list into multiple items. + - Use the [**Aggregate node**](/integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md) to take separate items, or portions of them, and group them together into individual items. +- Use the **Code node** to write JavaScript functions to modify the data structure of incoming data using the **Run Once for All Items** mode: + - 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": [{}, {}, ...] }]`: + ```javascript + return $input.first().json.data.map(item => { + return { + json: item + } + }); + ``` + - To create a single item from multiple items, you can use this JavaScript code: + ```javascript + return [ + { + json: { + data_object: $input.all().map(item => item.json) + } + } + ]; + ``` + +These 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: +```javascript +let items = $input.all(); +return items[0].json.workEmail.map(item => { + return { + json: item + } +}); +``` + +### Exercise + +1. 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). +2. Transform the data in the `results` field with the **Split Out node**. +3. Transform the data in the `results` field with the **Code node**. + + +??? note "Show me the solution" + + 1. To get the pokemon from the PokéAPI, execute the **HTTP Request node** with the following parameters: + - **Authentication**: None + - **Request Method**: GET + - **URL**: https://pokeapi.co/api/v2/pokemon + 2. To transform the data with the **Split Out node**, connect this node to the **HTTP Request node** and set the following parameters: + - **Field To Split Out**: results + - **Include**: No Other Fields + 3. 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: + ```javascript + let items = $input.all(); + return items[0].json.results.map(item => { + return { + json: item + } + }); + ``` + + +# courses/level-two/chapter-2.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Processing different data types + +In this chapter, you will learn how to process different types of data using [n8n core nodes](/workflows/components/nodes.md). + + +## HTML and XML data + +You're most likely familiar with HTML and XML. + +/// note | HTML vs. XML +HTML 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. +/// +If you need to process HTML or XML data in your n8n workflows, use the [**HTML node**](/integrations/builtin/core-nodes/n8n-nodes-base.html.md) or the [**XML node**](/integrations/builtin/core-nodes/n8n-nodes-base.xml.md). + +Use 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). + +### HTML Exercise + +Let's get the title of the latest n8n blog post: + +1. Use the **HTTP Request node** to make a GET request to the URL `https://blog.n8n.io/` (this endpoint requires no authentication). +2. Connect an **HTML node** and configure it to extract the title of the first blog post on the page. + - Hint: If you're not familiar with CSS selectors or reading HTML, the CSS selector `.post .item-title a` should help! + +??? note "Show me the solution" + + 1. Configure the HTTP Request node with the following parameters: + - **Authentication**: None + - **Request Method**: GET + - **URL**: https://blog.n8n.io/ + The result should look like this: + +
Result of HTTP Request node
Result of HTTP Request node
+ + 2. Connect an **HTML node** to the **HTTP Request node** and configure the former's parameters: + - **Operation**: Extract HTML Content + - **Source Data**: JSON + - **JSON Property**: data + - **Extraction Values**: + - **Key**: title + - **CSS Selector**: `.post .item-title a` + - **Return Value**: HTML + + You can add more values to extract more data. + + The result should look like this: + +
Result of HTML Extract node
Result of HTML Extract node
+ + +Use 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. + +### XML Exercise + +In the [final exercise of Chapter 1](/courses/level-two/chapter-1.md#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: + +1. Add an **HTTP Request node** that makes the same request to the PokéAPI at `https://pokeapi.co/api/v2/pokemon`. +2. Use the XML node to convert the JSON output to XML. + +??? note "Show me the solution" + + 1. To get the pokemon from the PokéAPI, execute the **HTTP Request node** with the following parameters: + - **Authentication**: None + - **Request Method**: GET + - **URL**: https://pokeapi.co/api/v2/pokemon + 2. Connect an **XML node** to it with the following parameters: + - **Mode**: JSON to XML + - **Property name**: data + + The result should look like this: + +
Table view of XML Node (JSON to XML)
XML node (JSON to XML) – Table View
+ + To transform data the other way around, select the mode **XML to JSON**. + + +## Date, time, and interval data + +Date and time data types include `DATE`, `TIME`, `DATETIME`, `TIMESTAMP`, and `YEAR`. The dates and times can be passed in different formats, for example: + +- `DATE`: March 29 2022, 29-03-2022, 2022/03/29 +- `TIME`: 08:30:00, 8:30, 20:30 +- `DATETIME`: 2022/03/29 08:30:00 +- `TIMESTAMP`: 1616108400 (Unix timestamp), 1616108400000 (Unix ms timestamp) +- `YEAR`: 2022, 22 + +There are a few ways you can work with dates and times: + +- Use the [**Date & Time node**](/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md) to convert date and time data to different formats and calculate dates. +- Use [**Schedule Trigger node**](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md) to schedule workflows to run at a specific time, interval, or duration. + +Sometimes, 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. + +If you run into situations like this, use the [**Wait node**](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md) after the node that you want to delay. The **Wait node** pauses the workflow execution and will resume execution: + +- At a specific time. +- After a specified time interval. +- On a webhook call. + + + +### Date Exercise + +Build 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](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) the calculated date as a value. The workflow should be triggered every 30 minutes. + + +To begin: + +1. Add the **Customer Datastore (n8n training) node** with the **Get All People** action selected. Return All. +2. 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. +3. Add the **If node** to check if that new rounded date is after `1960-01-01 00:00:00`. +4. Add the **Wait node** to the True output of that node and set it to wait for one minute. +5. Add the **Edit Fields (Set) node** to set a new field called outputValue to a String containing new-date. Include all input fields. +6. Add the **Schedule Trigger node** at the beginning of the workflow to trigger it every 30 minutes. (You can keep the [Manual Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.manualworkflowtrigger.md) for testing!) + +??? note "Show me the solution" + + 1. Add the **Customer Datastore (n8n training) node** with the **Get All People** action selected. + - Select the option to **Return All**. + 2. Add a **Date & Time node** connected to the Customer Datastore node. Select the option to **Round a Date**. + - Add the `created` date as the **Date** to round. + - Select `Round Up` as the **Mode** and `End of Month` as the **To**. + - Set the **Output Field Name** as `new-date`. + - In **Options**, select **Add Option** and use the control to **Include Input Fields** + 3. Add an **If node** connected to the **Date & Time node**. + - Add the new-date field as the first part of the condition. + - Set the comparison to **Date &Time > is after** + - 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) + 4. Add a **Wait node** to the True output of the **If node**. + - Set **Resume** to `After Time interval`. + - Set **Wait Amount** to `1.00`. + - Set **Wait Unit** to `Minutes`. + 5. Add an **Edit Fields (Set) node** to the **Wait node**. + - Use either JSON or Manual Mapping **Mode**. + - Set a new field called `outputValue` to be the value of the new-date field. + - Select the option to **Include Other Input Fields** and include **All** fields. + 6. Add a **Schedule Trigger node** at the beginning of the workflow. + - Set the **Trigger Interval** to use `Minutes`. + - Set the **Minutes Between Triggers** to 30. + - To test your schedule, be sure to activate the workflow. + - Be sure to connect this node to the **Customer Datastore (n8n training) node** you began with! + + The workflow should look like this: + +
Workflow for transforming dates
Workflow for transforming dates
+ + To 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](/workflows/export-import.md) for more information. + + ```json + { + "name": "Course 2, Ch 2, Date exercise", + "nodes": [ + { + "parameters": {}, + "id": "6bf64d5c-4b00-43cf-8439-3cbf5e5f203b", + "name": "When clicking \"Execute workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 620, + 280 + ] + }, + { + "parameters": { + "operation": "getAllPeople", + "returnAll": true + }, + "id": "a08a8157-99ee-4d50-8fe4-b6d7e16e858e", + "name": "Customer Datastore (n8n training)", + "type": "n8n-nodes-base.n8nTrainingCustomerDatastore", + "typeVersion": 1, + "position": [ + 840, + 360 + ] + }, + { + "parameters": { + "operation": "roundDate", + "date": "={{ $json.created }}", + "mode": "roundUp", + "outputFieldName": "new-date", + "options": { + "includeInputFields": true + } + }, + "id": "f66a4356-2584-44b6-a4e9-1e3b5de53e71", + "name": "Date & Time", + "type": "n8n-nodes-base.dateTime", + "typeVersion": 2, + "position": [ + 1080, + 360 + ] + }, + { + "parameters": { + "conditions": { + "options": { + "caseSensitive": true, + "leftValue": "", + "typeValidation": "strict" + }, + "conditions": [ + { + "id": "7c82823a-e603-4166-8866-493f643ba354", + "leftValue": "={{ $json['new-date'] }}", + "rightValue": "1960-01-01T00:00:00", + "operator": { + "type": "dateTime", + "operation": "after" + } + } + ], + "combinator": "and" + }, + "options": {} + }, + "id": "cea39877-6183-4ea0-9400-e80523636912", + "name": "If", + "type": "n8n-nodes-base.if", + "typeVersion": 2, + "position": [ + 1280, + 360 + ] + }, + { + "parameters": { + "amount": 1, + "unit": "minutes" + }, + "id": "5aa860b7-c73c-4df0-ad63-215850166f13", + "name": "Wait", + "type": "n8n-nodes-base.wait", + "typeVersion": 1.1, + "position": [ + 1480, + 260 + ], + "webhookId": "be78732e-787d-463e-9210-2c7e8239761e" + }, + { + "parameters": { + "assignments": { + "assignments": [ + { + "id": "e058832a-2461-4c6d-b584-043ecc036427", + "name": "outputValue", + "value": "={{ $json['new-date'] }}", + "type": "string" + } + ] + }, + "includeOtherFields": true, + "options": {} + }, + "id": "be034e9e-3cf1-4264-9d15-b6760ce28f91", + "name": "Edit Fields", + "type": "n8n-nodes-base.set", + "typeVersion": 3.3, + "position": [ + 1700, + 260 + ] + }, + { + "parameters": { + "rule": { + "interval": [ + { + "field": "minutes", + "minutesInterval": 30 + } + ] + } + }, + "id": "6e8e4308-d0e0-4d0d-bc29-5131b57cf061", + "name": "Schedule Trigger", + "type": "n8n-nodes-base.scheduleTrigger", + "typeVersion": 1.1, + "position": [ + 620, + 480 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute workflow\"": { + "main": [ + [ + { + "node": "Customer Datastore (n8n training)", + "type": "main", + "index": 0 + } + ] + ] + }, + "Customer Datastore (n8n training)": { + "main": [ + [ + { + "node": "Date & Time", + "type": "main", + "index": 0 + } + ] + ] + }, + "Date & Time": { + "main": [ + [ + { + "node": "If", + "type": "main", + "index": 0 + } + ] + ] + }, + "If": { + "main": [ + [ + { + "node": "Wait", + "type": "main", + "index": 0 + } + ] + ] + }, + "Wait": { + "main": [ + [ + { + "node": "Edit Fields", + "type": "main", + "index": 0 + } + ] + ] + }, + "Schedule Trigger": { + "main": [ + [ + { + "node": "Customer Datastore (n8n training)", + "type": "main", + "index": 0 + } + ] + ] + } + } + } + ``` + + +## Binary data + +Up 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. + +In n8n, you can process binary data with the following nodes: + +- [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to request and send files from/to web resources and APIs. +- [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) to read and write files from/to the machine where n8n is running. +- [Convert to File](/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md) to take input data and output it as a file. +- [Extract From File](/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md) to get data from a binary format and convert it to JSON. + +/// note | Reading and writing files is only available on self-hosted n8n +Reading 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. +/// + +To 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). + +/// warning | Naming the right path +The file path looks slightly different depending on how you are running n8n: + +- npm: `~/my_file.json` +- n8n cloud / Docker: `/tmp/my_file.json` +/// + + + +### Binary Exercise 1 + +For our first binary exercise, let's convert a PDF file to JSON: + +1. Make an HTTP request to get this PDF file: `https://media.kaspersky.com/pdf/Kaspersky_Lab_Whitepaper_Anti_blocker.pdf.` +2. Use the **Extract From File node** to convert the file from binary to JSON. + +??? note "Show me the solution" + + In the **HTTP Request node**, you should see the PDF file, like this: + +
HTTP Request node to get PDF
HTTP Request node to get PDF
+ + When you convert the PDF from binary to JSON using the **Extract From File node**, the result should look like this: + +
Extract From File node
Extract From File node
+ + To check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI: + + ```json + { + "name": "Binary to JSON", + "nodes": [ + { + "parameters": {}, + "id": "78639a25-b69a-4b9c-84e0-69e045bed1a3", + "name": "When clicking \"Execute Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 480, + 520 + ] + }, + { + "parameters": { + "url": "https://media.kaspersky.com/pdf/Kaspersky_Lab_Whitepaper_Anti_blocker.pdf", + "options": {} + }, + "id": "a11310df-1287-4e9a-b993-baa6bd4265a6", + "name": "HTTP Request", + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.1, + "position": [ + 700, + 520 + ] + }, + { + "parameters": { + "operation": "pdf", + "options": {} + }, + "id": "88697b6b-fb02-4c3d-a715-750d60413e9f", + "name": "Extract From File", + "type": "n8n-nodes-base.extractFromFile", + "typeVersion": 1, + "position": [ + 920, + 520 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute Workflow\"": { + "main": [ + [ + { + "node": "HTTP Request", + "type": "main", + "index": 0 + } + ] + ] + }, + "HTTP Request": { + "main": [ + [ + { + "node": "Extract From File", + "type": "main", + "index": 0 + } + ] + ] + } + } + } + ``` + + + +### Binary Exercise 2 + +For our second binary exercise, let's convert some JSON data to binary: + +1. Make an HTTP request to the Poetry DB API `https://poetrydb.org/random/1`. +2. Convert the returned data from JSON to binary using the **Convert to File node**. +3. Write the new binary file data to the machine where n8n is running using the **Read/Write Files From Disk node**. +4. To check that it worked out, use the **Read/Write Files From Disk node** to read the generated binary file. + +??? note "Show me the solution" + + The workflow for this exercise looks like this: + +
Workflow for moving JSON to binary data
Workflow for moving JSON to binary data
+ + To check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI: + + ```json + { + "name": "JSON to file and Read-Write", + "nodes": [ + { + "parameters": {}, + "id": "78639a25-b69a-4b9c-84e0-69e045bed1a3", + "name": "When clicking \"Execute Workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 480, + 520 + ] + }, + { + "parameters": { + "url": "https://poetrydb.org/random/1", + "options": {} + }, + "id": "a11310df-1287-4e9a-b993-baa6bd4265a6", + "name": "HTTP Request", + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 4.1, + "position": [ + 680, + 520 + ] + }, + { + "parameters": { + "operation": "toJson", + "options": {} + }, + "id": "06be18f6-f193-48e2-a8d9-35f4779d8324", + "name": "Convert to File", + "type": "n8n-nodes-base.convertToFile", + "typeVersion": 1, + "position": [ + 880, + 520 + ] + }, + { + "parameters": { + "operation": "write", + "fileName": "/tmp/poetrydb.json", + "options": {} + }, + "id": "f2048e5d-fa8f-4708-b15a-d07de359f2e5", + "name": "Read/Write Files from Disk", + "type": "n8n-nodes-base.readWriteFile", + "typeVersion": 1, + "position": [ + 1080, + 520 + ] + }, + { + "parameters": { + "fileSelector": "={{ $json.fileName }}", + "options": {} + }, + "id": "d630906c-09d4-49f4-ba14-416c0f4de1c8", + "name": "Read/Write Files from Disk1", + "type": "n8n-nodes-base.readWriteFile", + "typeVersion": 1, + "position": [ + 1280, + 520 + ] + } + ], + "pinData": {}, + "connections": { + "When clicking \"Execute Workflow\"": { + "main": [ + [ + { + "node": "HTTP Request", + "type": "main", + "index": 0 + } + ] + ] + }, + "HTTP Request": { + "main": [ + [ + { + "node": "Convert to File", + "type": "main", + "index": 0 + } + ] + ] + }, + "Convert to File": { + "main": [ + [ + { + "node": "Read/Write Files from Disk", + "type": "main", + "index": 0 + } + ] + ] + }, + "Read/Write Files from Disk": { + "main": [ + [ + { + "node": "Read/Write Files from Disk1", + "type": "main", + "index": 0 + } + ] + ] + } + } + } + ``` + + +# courses/level-two/chapter-3.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Merging and splitting data + +In this chapter, you will learn how to merge and split data, and in what cases it might be useful to perform these operations. + + +## Merging data + +In some cases, you might need to merge (combine) and process data from different sources. + +Merging data can involve: + +- Creating one data set from multiple sources. +- Synchronizing data between multiple systems. This could include removing duplicate data or updating data in one system when it changes in another. + +/// note | One-way vs. two-way sync +In 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. + +In 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. + +[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. +/// + + +In n8n, you can merge data from two different nodes using the [Merge node](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md){:target="_blank"}, which provides several merging options: + +- [Append](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md#append){:target="_blank"} +- [Combine](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md#combine){:target="_blank"} + - [Merge by Fields](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md#combine-by-matching-fields){:target="_blank"}: requires input fields to match on + - [Merge by Position](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md#combine-by-position){:target="_blank"} + - [Combine all possible combinations](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md#combine-by-all-possible-combinations){:target="_blank"} +- [Choose Branch](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md#choose-branch){:target="_blank"} + +Notice 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`. + +
Property Input fields in the Merge node
Property Input fields in the Merge node
+ +/// warning | Property Input in dot notation +If 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). +/// + +/// note +You can also find the **Merge node** under the alias Join. This might be more intuitive if you're familiar with SQL joins. +/// + +### Merge Exercise + +Build a workflow that merges data from the Customer Datastore node and Code node. + +1. Add a **Merge node** that takes `Input 1` from a **Customer Datastore node** and `Input 2` from a **Code node**. +2. In the **Customer Datastore node**, run the operation **Get All People**. +3. 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`. + - Fill out the values of these properties with the information of two characters from the Customer Database. + - For example, Jay Gatsby's language is English and country name is United States. +4. In the **Merge node**, try out different merge options. + +??? note "Show me the solution" + + The workflow for this exercise looks like this: + +
Workflow exercise for merging data
Workflow exercise for merging data
+ + If 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): + +
Output of Merge node with option to keep matches
Output of Merge node with option to keep matches
+ + To check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI: + + ```json + { + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "nodes": [ + { + "parameters": { + "mode": "combine", + "mergeByFields": { + "values": [ + { + "field1": "name", + "field2": "name" + } + ] + }, + "options": {} + }, + "id": "578365f3-26dd-4fa6-9858-f0a5fdfc413b", + "name": "Merge", + "type": "n8n-nodes-base.merge", + "typeVersion": 2.1, + "position": [ + 720, + 580 + ] + }, + { + "parameters": {}, + "id": "71aa5aad-afdf-4f8a-bca0-34450eee8acc", + "name": "When clicking \"Execute workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 260, + 560 + ] + }, + { + "parameters": { + "operation": "getAllPeople" + }, + "id": "497174fe-3cab-4160-8103-78b44efd038d", + "name": "Customer Datastore (n8n training)", + "type": "n8n-nodes-base.n8nTrainingCustomerDatastore", + "typeVersion": 1, + "position": [ + 500, + 460 + ] + }, + { + "parameters": { + "jsCode": "return [\n {\n 'name': 'Jay Gatsby',\n 'language': 'English',\n 'country': {\n 'code': 'US',\n 'name': 'United States'\n }\n \n }\n \n];" + }, + "id": "387e8a1e-e796-4f05-8e75-7ce25c786c5f", + "name": "Code", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 500, + 720 + ] + } + ], + "connections": { + "When clicking \"Execute workflow\"": { + "main": [ + [ + { + "node": "Customer Datastore (n8n training)", + "type": "main", + "index": 0 + }, + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + }, + "Customer Datastore (n8n training)": { + "main": [ + [ + { + "node": "Merge", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code": { + "main": [ + [ + { + "node": "Merge", + "type": "main", + "index": 1 + } + ] + ] + } + }, + "pinData": {} + } + ``` + + +## Looping + +In 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). + +n8n 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. + +However, there are some [exceptions of nodes and operations](/flow-logic/looping.md#node-exceptions){:target="_blank"} that will require you to build a loop into your workflow. + +To [create a loop in an n8n workflow](/flow-logic/looping.md#using-loops-in-n8n){:target="_blank"}, 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. + +## Splitting data in batches + +If 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. + +For these processes, use the [**Loop Over Items node**](/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md){:target="_blank"}. This node splits input data into a specified batch size and, with each iteration, returns a predefined amount of data. + +/// warning | Execution of Loop Over Items node +The **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. +/// + +### Loop/Batch Exercise + +Build a workflow that reads the RSS feed from Medium and dev.to. The workflow should consist of three nodes: + +1. 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`). +2. 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. +3. An **RSS Read node** that gets the URL of the Medium RSS feed, passed as an expression: `{{ $json.url }}`. + - The **RSS Read node** is one of the [exception nodes](/flow-logic/looping.md#node-exceptions){:target="_blank"} which processes only the first item it receives, so the **Loop Over Items node** is necessary for iterating over multiple items. + +??? note "Show me the solution" + + 1. Add a **Code Node**. You can format the code in several ways, one way is: + - Set **Mode** to `Run Once for All Items`. + - Set **Language** to `JavaScript`. + - Copy the code below and paste it into the JavaScript Code editor: + ```javascript + let urls = [ + { + json: { + url: 'https://medium.com/feed/n8n-io' + } + }, + { + json: { + url: 'https://dev.to/feed/n8n' + } + } + ] + return urls; + ``` + 2. Add a **Loop Over Items node** connected to the **Code node**. + - Set **Batch Size** to `1`. + 3. The **Loop Over Items node** automatically adds a node called "Replace Me". Replace that node with an **RSS Read node**. + - Set the **URL** to use the url from the Code Node: `{{ $json.url }}`. + + The workflow for this exercise looks like this: + +
Workflow for getting RSS feeds from two blogs
Workflow for getting RSS feeds from two blogs
+ + To check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI: + + ```json + { + "meta": { + "templateCredsSetupCompleted": true, + "instanceId": "cb484ba7b742928a2048bf8829668bed5b5ad9787579adea888f05980292a4a7" + }, + "nodes": [ + { + "parameters": {}, + "id": "ed8dc090-ae8c-4db6-a93b-0fa873015c25", + "name": "When clicking \"Execute workflow\"", + "type": "n8n-nodes-base.manualTrigger", + "typeVersion": 1, + "position": [ + 460, + 460 + ] + }, + { + "parameters": { + "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;" + }, + "id": "1df2a9bf-f970-4e04-b906-92dbbc9e8d3a", + "name": "Code", + "type": "n8n-nodes-base.code", + "typeVersion": 2, + "position": [ + 680, + 460 + ] + }, + { + "parameters": { + "options": {} + }, + "id": "3cce249a-0eab-42e2-90e3-dbdf3684e012", + "name": "Loop Over Items", + "type": "n8n-nodes-base.splitInBatches", + "typeVersion": 3, + "position": [ + 900, + 460 + ] + }, + { + "parameters": { + "url": "={{ $json.url }}", + "options": {} + }, + "id": "50e1c1dc-9a5d-42d3-b7c0-accc31636aa6", + "name": "RSS Read", + "type": "n8n-nodes-base.rssFeedRead", + "typeVersion": 1, + "position": [ + 1120, + 460 + ] + } + ], + "connections": { + "When clicking \"Execute workflow\"": { + "main": [ + [ + { + "node": "Code", + "type": "main", + "index": 0 + } + ] + ] + }, + "Code": { + "main": [ + [ + { + "node": "Loop Over Items", + "type": "main", + "index": 0 + } + ] + ] + }, + "Loop Over Items": { + "main": [ + null, + [ + { + "node": "RSS Read", + "type": "main", + "index": 0 + } + ] + ] + }, + "RSS Read": { + "main": [ + [ + { + "node": "Loop Over Items", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "pinData": {} + } + ``` + + +# courses/level-two/chapter-4.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Dealing with errors in workflows + +Sometimes 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. + +But 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. + + +## Checking failed workflows + +n8n tracks executions of your workflows. + +When 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. + +Open the Executions log by selecting [**Executions**](/workflows/executions/index.md#execution-modes) in the left-side panel. + +To 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. + +
Executions log
Executions log
+ + +This 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. + +To toggle between viewing the execution and the editor, select the **Editor | Executions** button at the top of the page. + +
Workflow execution view
Workflow execution view
+ +## Catching erroring workflows + +To catch failed workflows, create a separate [**Error Workflow**](/flow-logic/error-handling.md) with the [**Error Trigger node**](/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger.md). This workflow will only execute if the main workflow execution fails. + +Use additional nodes in your **Error Workflow** that make sense, like sending notifications about the failed workflow and its errors using email or Slack. + +To receive error messages for a failed workflow, set the **Error Workflow** in the [Workflow Settings](/workflows/settings.md) to an Error Workflow that uses an **Error Trigger node**. + +The 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. + +/// note | Error workflows +- If a workflow uses the Error Trigger node, you don't have to activate the workflow. +- If a workflow contains the Error Trigger node, by default, the workflow uses itself as the error workflow. +- You can't test error workflows when running workflows manually. The Error trigger only runs when an automatic workflow errors. +- You can set the same Error Workflow for multiple workflows. +/// + +### Exercise + +In 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: + +1. Create a new Error Workflow. +2. Add the **Error Trigger node**. +3. Connect a node for the communication platform of your choice to the Error Trigger node, like [Slack](/integrations/builtin/app-nodes/n8n-nodes-base.slack.md), [Discord](/integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md), [Telegram](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md), or even [Gmail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) or a more generic [Send Email](/integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md). +4. In the workflow you want to monitor, open the [Workflow Settings](/workflows/settings.md) and select the new Error Workflow you just created. Note that this workflow needs to run automatically to trigger the error workflow. + +??? note "Show me the solution" + + The workflow for this exercise looks like this: + +
Error workflow
+ + To check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI: + + ```json + { + "nodes": [ + { + "parameters": {}, + "name": "Error Trigger", + "type": "n8n-nodes-base.errorTrigger", + "typeVersion": 1, + "position": [ + 720, + -380 + ] + }, + { + "parameters": { + "channel": "channelname", + "text": "=This workflow {{$node[\"Error Trigger\"].json[\"workflow\"][\"name\"]}}failed.\nHave a look at it here: {{$node[\"Error Trigger\"].json[\"execution\"][\"url\"]}}", + "attachments": [], + "otherOptions": {} + }, + "name": "Slack", + "type": "n8n-nodes-base.slack", + "position": [ + 900, + -380 + ], + "typeVersion": 1, + "credentials": { + "slackApi": { + "id": "17", + "name": "slack_credentials" + } + } + } + ], + "connections": { + "Error Trigger": { + "main": [ + [ + { + "node": "Slack", + "type": "main", + "index": 0 + } + ] + ] + } + } + } + ``` + + + +## Throwing exceptions in workflows + +Another way of troubleshooting workflows is to include a [**Stop and Error node**](/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror.md) in your workflow. This node throws an error. You can specify the error type: + +- **Error Message**: returns a custom message about the error +- **Error Object**: returns the type of error + +You can only use the **Stop and Error node** as the last node in a workflow. + +/// note | When to throw errors +Throwing 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. + +If you are working with data from a third-party service, you may come across problems such as: + +- Wrongly formatted JSON output +- Data with the wrong type (for example, numeric data that has a non-numeric value) +- Missing values +- Errors from remote servers + +Though 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. + +
Stop and Error node with error message
Stop and Error node with error message
+/// + + + +# courses/level-two/chapter-5/chapter-5.0.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Automating a business workflow + +Remember [our friend Nathan](/courses/level-one/chapter-3.md)? + +**Nathan 🙋:** Hello, it's me again. My manager was so impressed with my first workflow automation solution that she entrusted me with more responsibility.
+**You 👩‍🔧:** More work and responsibility. Congratulations, I guess. What do you need to do now?
+**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.
+**You 👩‍🔧:** Sounds like a lot of manual work, but the kind that can be automated. Let's do it! + + +## Workflow design + +Now that we know what Nathan wants to automate, let's list the steps he needs to take to achieve this: + +1. Get and combine data from all necessary sources. +2. Sort the data and format the dates. +3. Write binary files. +4. Send notifications using email and Discord. + +n8n provides [core nodes](/integrations/builtin/node-types.md#core-nodes) for all these steps. This use case is somewhat complex. We should build it from three separate workflows: + +1. A workflow that merges the company data with external information. +2. A workflow that generates the reports. +3. A workflow that monitors errors in the second workflow. + +## Workflow prerequisites + +To build the workflows, you will need the following: + +* An [Airtable](https://airtable.com/){:target="_blank" .external-link} account and [credentials](/integrations/builtin/credentials/airtable.md). +* A [Google](https://www.google.com/account/about/){:target="_blank" .external-link} account and [credentials](/integrations/builtin/credentials/google/index.md) to access Gmail. +* A [Discord](https://discord.com/){:target="_blank" .external-link} account and webhook URL (you receive this using email when you sign up for this course). + +Next, you will build these three workflows with step-by-step instructions. + + +# courses/level-two/chapter-5/chapter-5.1.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Workflow 1: Merging data + +Nathan'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. + +To accomplish this task, you first need to make a copy of this table in your Airtable account: + + + +Next, build a small workflow that merges data from Airtable and a REST Countries API: + +1. Use the [**Airtable node**](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md) to list the data in the Airtable table named `customers`. +2. Use the [**HTTP Request node**](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to get data from the REST Countries API: `https://restcountries.com/v3.1/all`. This will return data about world countries, split out into separate items. +3. Use the [**Merge node**](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md) 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. +4. Use another Airtable node to update the fields `region` and `subregion` in Airtable with the data from the Countries API. + +The workflow should look like this: + +
Workflow 1 for merging data from Airtable and the Countries API
Workflow 1 for merging data from Airtable and the Countries API
+ + +/// question | Quiz questions +* How many items does the **HTTP Request node** return? +* How many items does the **Merge node** return? +* How many unique regions are assigned in the customers table? +* What's the subregion assigned to the customerID 10? +/// + + +# courses/level-two/chapter-5/chapter-5.2.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Workflow 2: Generating reports + +In this workflow, you will merge data from different sources, transform binary data, generate files, and send notifications about them. The final workflow should look like this: + +
Workflow 2 for aggregating data and generating files
Workflow 2 for aggregating data and generating files
+ +To make things easier, let's split the workflow into three parts. + +## Part 1: Getting data from different sources + +The first part of the workflow consists of five nodes: + +
Workflow 1: Getting data from different sources
Workflow 1: Getting data from different sources
+ +1. Use the [**HTTP Request node**](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) to get data from the API endpoint that stores company data. Configure the following node parameters: + + - **Method**: Get + - **URL**: The **Dataset URL** you received in the email when you signed up for this course. + - **Authentication**: Generic Credential Type + - **Generic Auth Type**: Header Auth + - **Credentials for Header Auth**: The Header Auth name and Header Auth value you received in the email when you signed up for this course. + - **Send Headers**: Toggle to true + - **Specify Headers**: Select `Using Fields Below` + - **Name**: `unique_id` + - **Value**: The unique ID you received in the email when you signed up for this course. + +2. Use the [**Airtable node**](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md) to list data from the `customers` table (where you updated the fields `region` and `subregion`). +3. Use the [**Merge node**](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md) to merge data from the Airtable and HTTP Request node, based on matching the input fields for `customerID`. +4. Use the [**Sort node**](/integrations/builtin/core-nodes/n8n-nodes-base.sort.md) to sort data by `orderPrice` in descending order. + +/// question | Quiz questions +* What's the name of the employee assigned to customer 1? +* What's the order status of customer 2? +* What's the highest order price? +/// + +## Part 2: Generating file for regional sales + +The second part of the workflow consists of four nodes: + +
Workflow 2: Generating file for regional sales
Workflow 2: Generating file for regional sales
+ +1. Use the [**If node**](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) to filter to only display orders from the region `Americas`. +2. Use the [**Convert to File**](/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md) to transform the incoming data from JSON to binary format. Convert each item to a separate file. (Bonus points if you can figure out how to name each report based on the orderID!) +3. Use the [**Gmail node**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) (or another email node) to send the files using email to an address you have access to. Note that you need to add an attachment with the data property. +4. Use the [**Discord node**](/integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md) to send a message in the n8n Discord channel `#course-level-two`. In the node, configure the following parameters: + * **Webhook URL**: The Discord URL you received in the email when you signed up for this course. + * **Text**: "I sent the file using email with the label ID `{label ID}`. My ID: " followed by the unique ID emailed to you when you registered for this course.
Note that you need to replace the text in curly braces `{}` with [expressions](/glossary.md#expression-n8n) that reference the data from the nodes. + +/// question | Quiz questions +* How many orders are assigned to the `Americas` region? +* What's the total price of the orders in the `Americas` region? +* How many items does the **Write Binary File node** return? +/// + +## Part 3: Generating files for total sales + +The third part of the workflow consists of five nodes: + +
Workflow 3: Generating files for total sales
Workflow 3: Generating files for total sales
+ +1. Use the [**Loop Over Items node**](/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md) to split data from the Item Lists node into batches of 5. +2. Use the [**Set node**](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) to set four values, referenced with expressions from the previous node: `customerEmail`, `customerRegion`, `customerSince`, and `orderPrice`. +3. Use the [**Date & Time node**](/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md) to change the date format of the field `customerSince` to the format MM/DD/YYYY. + - Set the **Include Input Fields** option to keep all the data together. +4. Use the [**Convert to File node**](/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md) to create a CSV spreadsheet with the file name set as the expression: `{{$runIndex > 0 ? 'file_low_orders':'file_high_orders'}}`. +5. Use the [**Discord node**](/integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md) to send a message in the n8n Discord channel `#course-level-two`. In the node, configure the following parameters: + * **Webhook URL**: The Discord URL you received in the email when you signed up for this course. + * **Text**: "I created the spreadsheet `{file name}`. My ID:" followed by the unique ID emailed to you when you registered for this course.
Note that you need to replace `{file name}` with an expression that references data from the previous **Convert to File node**.
+ +/// question | Quiz questions +* What's the lowest order price in the first batch of items? +* What's the formatted date of customer 7? +* How many items does the **Convert to File node** return? +/// + +??? note "Show me the solution" + + To check the configuration of the nodes, you can copy the JSON workflow code below and paste it into your Editor UI: + + ```json + { + "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": {} + } + ``` + + +# courses/level-two/chapter-5/chapter-5.3.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Workflow 3: Monitoring workflow errors + +Last but not least, let's help Nathan know if there are any errors running the workflow. + +To accomplish this task, create an Error workflow that monitors the main workflow: + +1. Create a new workflow. +2. Add an **Error Trigger node** (and execute it as a test). +3. Connect a **Discord node** to the **Error Trigger node** and configure these fields:
+ + * **Webhook URL**: The Discord URL that you received in the email from n8n when you signed up for this course. + * **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. + + Note that you need to replace the text in curly brackets `{}` with expressions that take the respective information from the Error Trigger node.
+ +4. Execute the Discord node. +5. Set the newly created workflow as the **Error Workflow** for the main workflow you created in the previous lesson. + +The workflow should look like this: + +
Workflow 3 for monitoring workflow errors
Workflow 3 for monitoring workflow errors
+ +/// question | Quiz questions +* What fields does the **Error Trigger node** return? +* What information about the execution does the **Error Trigger node** return? +* What information about the workflow does the **Error Trigger node** return? +* What's the expression to reference the workflow name? +/// + + +# courses/level-two/chapter-6.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Test your knowledge + +Congratulations, you finished the n8n Course Level 2! + +You've learned a lot about workflow automation and built quite a complex business workflow. Why not showcase your skills? + +You can test your knowledge by taking a **quiz**, which consists of questions about the theoretical concepts and workflows covered in this course. + +- You need to have at least 80% correct answers to pass the quiz. +- You can take the quiz as many times as you want. +- There's no time limit on answering the quiz questions. + +
+[Take the quiz!](https://n8n-community.typeform.com/to/r9hDbytg){ .md-button } + +## What's next? + +- 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){:target="_blank" .external-link} and on our [blog](https://n8n.io/blog/){:target="_blank" .external-link}. +- Dive deeper into n8n's features by reading the [docs](/index.md). + + +# courses/level-two/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Level two: Introduction + +Welcome to the **n8n Course Level 2**! + + +## Is this course right for me? + +This course is for you if you: + +- Want to automate somewhat complex business processes. +- Want to dive deeper into n8n after taking the [Level 1 course](/courses/level-one/index.md). + +## What will I learn in this course? + +The focus in this course is on working with data. You will learn how to: + +- Use the data structure of n8n correctly. +- Process different data types (for example, XML, HTML, date, time, and binary data). +- Merge data from different sources (for example, a database, spreadsheet, or CRM). +- Use functions and JavaScript code in the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). +- Deal with error workflows and workflow errors. + +You will learn all this by completing short practical exercises after the theoretical explanations and building a business workflow following instructions. + +## What do I need to get started? + +To follow along this course (at a comfortable pace) you will need the following: + +- **n8n set up**: You can use the [self-hosted version](/hosting/installation/npm.md) or [n8n Cloud](/manage-cloud/overview.md). +- **A user ID**: [Sign up here](https://n8n-community.typeform.com/to/HQoQ7nXg){:target="_blank" .external-link} to get your unique ID and other credentials you will need in the course. +- **Basic n8n skills**: We strongly recommend taking the [Level 1 course](/courses/level-one/index.md) before this one. +- **Basic JavaScript understanding** + +## How long does the course take? + +Completing 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. + +## How do I complete the course? + +There are two milestones in this course that test your knowledge of what you have learned in the lessons: + +- [x] Building the [main workflow](/courses/level-two/chapter-5/chapter-5.0.md) +- [x] Passing the [quiz](https://n8n-community.typeform.com/to/r9hDbytg){:target="_blank" .external} at the end of the course + +You can always **check your progress** throughout the course by entering your unique ID [here](https://internal.users.n8n.cloud/webhook/course-level-2/verify){:target="_blank" .external-link}. + +If 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){:target="_blank" .external} in your forum profile. You can then share your profile and course verification ID to showcase your n8n skills to others. + +[Let's get started!](/courses/level-two/chapter-1.md){ .md-button } diff --git a/llms/credentials.md b/llms/credentials.md new file mode 100644 index 00000000000..8d927e8d231 --- /dev/null +++ b/llms/credentials.md @@ -0,0 +1,121 @@ + + +# credentials/add-edit-credentials.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Creating and editing credentials. +contentType: howto +--- + +# Create and edit credentials + +Credentials are securely stored authentication information used to connect n8n workflows to external services such as APIs, or databases. + +## Create a credential + +1. Select the ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **button** in the upper-left corner of the side menu. Select credential. +2. If your n8n instance supports [projects](/glossary.md#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. +3. Select the app or service you wish to connect to. + +Or: + +1. Using the ![universal create resource icon](/_images/common-icons/universal-resource-button.png){.off-glb} **Create** button in the upper-right corner from either the **Overview** page or a specific project. Select Credential. +2. 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. +3. Select the app or service you wish to connect to. + +You can also create new credential in the credential drop down when editing a node on the workflow editor. + +Once in the credential modal, enter the details required by your service. Refer to your service's page in the [credentials library](/integrations/builtin/credentials/index.md) for guidance. + +When you save a credential, n8n tests it to confirm it works. + +/// note | Credentials naming +n8n 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. +/// + +## Expressions in credentials + +You can use [expressions](/glossary.md#expression-n8n) to set credentials dynamically as your workflow runs: + +1. 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. +1. When creating your credential, hover over the field where you want to use an expression. +1. Toggle **Expression** on. +1. Enter your expression. + +### Example workflow + +[[ workflowDemo("file:///credentials/dynamic_credentials_using_expressions.json") ]] + +#### Using the example + +--8<-- "_snippets/examples-color-key.md" + + +# credentials/credential-sharing.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Credential sharing +description: Share credentials within an organization. +contentType: howto +--- + +# Credential sharing + + +/// info | Feature availability +Available on all Cloud plans, and Enterprise self-hosted plans. +/// + +You can share a credential directly with other users to use in their own workflows. Or share a credential in a [project](/glossary.md#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. + +Users 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. + +Refer to [Account types](/user-management/account-types.md) for more information about owners and admins. + +In [projects](/user-management/rbac/index.md), a user's role controls how they can interact with the workflows and credentials associated to the projects they're a member of. + +## Share a credential + +To share a credential: + +1. From the left menu, select either **Overview** or a project. +2. Select **Credentials** to see a list of your credentials. +3. Select the credential you want to share. +4. Select **Sharing**. +5. In the **Share with projects or users** dropdown, browse or search for the user or project with which you want to share your credentials. +6. Select a user or project. +7. Select **Save** to apply the changes. + +## Remove access to a credential + +To unshare a credential: + +1. From the left menu, select either **Overview** or a project. +2. Select **Credentials** to see a list of your credentials. +3. Select the credential you want to unshare. +4. Select **Sharing**. +5. Select **trash icon**![Trash icon](/_images/common-icons/delete-node.png){.off-glb} on the user or project you want to remove from the list of shared users and projects. +6. Select **Save** to apply the changes. + + +# credentials/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Authenticating with the services you're connecting to. +contentType: overview +--- + +# Credentials + +[Credentials](/glossary.md#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. + +Access 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. + +* [Create and edit credentials](/credentials/add-edit-credentials.md). +* Learn about [credential sharing](/credentials/credential-sharing.md). +* Find information on setting up credentials for your services in the [credentials library](/integrations/builtin/credentials/index.md). + + diff --git a/llms/data.md b/llms/data.md new file mode 100644 index 00000000000..1e569cb3c55 --- /dev/null +++ b/llms/data.md @@ -0,0 +1,723 @@ + + +# data/binary-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Binary data +description: Understand and use binary data in n8n. +contentType: overview +tags: + - binary data +hide: + - tags +--- + +# Binary data + +Binary data is any file-type data, such as image files or documents. + +This page collects resources relating to binary data in n8n. + +## Working with binary data in your workflows + +You can process binary data in n8n workflows. n8n provides nodes to help you work with binary data. You can also use code. + +### Nodes + +There are three key nodes dedicated to handling binary data files: + +- [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) to read and write files from/to the machine where n8n is running. +- [Convert to File](/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md) to take input data and output it as a file. +- [Extract From File](/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md) to get data from a binary format and convert it to JSON. + +There are separate nodes for working with XML and HTML data: + +* [HTML](/integrations/builtin/core-nodes/n8n-nodes-base.html.md) +* [XML](/integrations/builtin/core-nodes/n8n-nodes-base.xml.md) + +And nodes for performing common tasks: + +* [Compression](/integrations/builtin/core-nodes/n8n-nodes-base.compression.md) +* [Edit Image](/integrations/builtin/core-nodes/n8n-nodes-base.editimage.md) +* [FTP](/integrations/builtin/core-nodes/n8n-nodes-base.ftp.md) + +You can trigger a workflow based on changes to a local file using the [Local File trigger](/integrations/builtin/core-nodes/n8n-nodes-base.localfiletrigger.md). + +To split or concatenate binary data items, use the [data transformation nodes](/data/index.md#data-transformation-nodes). + +### Code + +You can use the [Code node](/code/code-node.md) to manipulate binary data in your workflows. For example, [Get the binary data buffer](/code/cookbook/code-node/get-binary-data-buffer.md): get the binary data available in your workflow. + + +## Configure binary data mode when self-hosting + +You can configure how your self-hosted n8n instance handles binary data using the [Binary data environment variables](/hosting/configuration/environment-variables/binary-data.md). This includes tasks such as setting the storage path and choosing how to store binary data. + +Your configuration affects how well n8n scales: [Scaling | Binary data filesystem mode](/hosting/scaling/binary-data.md). + +Reading 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](/hosting/configuration/environment-variables/nodes.md) for more information. + + +# data/code.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Processing data with code + +## Function + +A 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. + +The [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) 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. + + +# data/data-editing.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Data editing + +n8n allows you to edit [pinned data](/data/data-pinning.md). 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. + +/// note | For development only +Data editing isn't available for production workflow executions. It's a feature to help test workflows during development. +/// +## Edit output data + +To edit output data: + +1. Run the node to load data. +2. In the **OUTPUT** view, select **JSON** to switch to JSON view. +3. Select **Edit** ![Edit data icon](/_images/data/data-pinning/edit-data.png){.off-glb}. +4. Edit your data. +5. Select **Save**. n8n saves your data changes and pins your data. + +## Use data from previous executions + +You can copy data from nodes in previous workflow executions: + +1. Open the left menu. +2. Select **Executions**. +3. Browse the workflow executions list to find the one with the data you want to copy. +4. Select **Open Past Execution** ![Open past execution icon](/_images/data/data-pinning/open-execution.png){.off-glb}. +5. Double click the node whose data you want to copy. +6. If it's table layout, select **JSON** to switch to JSON view. +7. There are two ways to copy the JSON: + 1. Select the JSON you want by highlighting it, like selecting text. Then use `ctrl` + `c` to copy it. + 2. Select the JSON you want to copy by clicking on a parameter. Then: + 1. Hover over the JSON. n8n displays the **Copy** ![Copy data icon](/_images/data/data-pinning/copy-data.png){.off-glb} button. + 2. Select **Copy** ![Copy data icon](/_images/data/data-pinning/copy-data.png){.off-glb}. + 3. You can choose what to copy: + * **Copy Item Path** and **Copy Parameter Path** gives you expressions that access parts of the JSON. + * **Copy Value**: copies the entire selected JSON. +8. Return to the workflow you're working on: + 1. Open the left menu. + 2. Select **Workflows**. + 3. Select **Open**. + 4. Select the workflow you want to open. +9. Open the node where you want to use the copied data. +10. If there is no data, run the node to load data. +11. In the **OUTPUT** view, select **JSON** to switch to JSON view. +12. Select **Edit** ![Edit data icon](/_images/data/data-pinning/edit-data.png){.off-glb}. +15. Paste in the data from the previous execution. +16. Select **Save**. n8n saves your data changes and pins your data. + + +# data/data-filtering.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Data filtering + +/// info | Feature availability +Available on Cloud Pro and Enterprise plans. +/// + +Search and filter data in the node **INPUT** and **OUTPUT** panels. Use this to check your node's data. + +To search: + +1. In a node, select **Search** ![Search icon](/_images/common-icons/search.png){.off-glb} in the **INPUT** or **OUTPUT** panel. +1. Enter your search term. + +n8n filters as you type your search, displaying the objects or rows containing the term. + +Filtering is purely visual: n8n doesn't change or delete data. The filter resets when you close and reopen the node. + + +# data/data-flow-nodes.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data flow within nodes +description: How nodes process data items. +contentType: explanation +--- + +# Data flow within nodes + +--8<-- "_snippets/flow-logic/data-flow-nodes.md" + + +# data/data-mapping/data-item-linking/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Data item linking + +An 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. + +You need to understand this behavior if you're: + +* Building a programmatic-style node that implements complex behaviors with its input and output data. +* Using the Code node or expressions editor to access data from earlier items in the workflow. +* Using the Code node for complex behaviors with input and output data. + +This section provides: + +* A conceptual overview of [Item linking concepts](/data/data-mapping/data-item-linking/item-linking-concepts.md). +* Information on [Item linking for node creators](/data/data-mapping/data-item-linking/item-linking-node-building.md). +* Support for end users who need to [Work with the data path](/data/data-mapping/data-item-linking/item-linking-code-node.md) to retrieve item data from previous nodes, and link items when using the Code node. +* Guidance on troubleshooting [Errors](/data/data-mapping/data-item-linking/item-linking-errors.md). + + + + +# data/data-mapping/data-item-linking/item-linking-code-node.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Item linking in the Code node +--8<-- "_snippets/data/data-mapping/item-linking-code-node.md" + + + + +# data/data-mapping/data-item-linking/item-linking-concepts.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Item linking concepts + +Each 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. + +This document provides a conceptual overview of this feature. For usage details, refer to: + +* [Item linking for node creators](/data/data-mapping/data-item-linking/item-linking-node-building.md), for details on how to handle item linking when building a node. +* [Item linking in the Code node](/data/data-mapping/data-item-linking/item-linking-code-node.md), to learn how to handle item linking in the Code node. +* [Item linking errors](/data/data-mapping/data-item-linking/item-linking-errors.md), to understand the errors you may encounter in the editor UI. + +## n8n's automatic item linking + +If a node doesn't control how to link input items to output items, n8n tries to guess how to link the items automatically: + +* Single input, single output: the output links to the input. +* Single input, multiple outputs: all outputs link to that input. +* Multiple inputs and outputs: + * 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. + * 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. + * If the number isn't equal, or you create completely new items, n8n can't automatically link items. + +If n8n can't link items automatically, and the node doesn't handle the item linking, n8n displays an error. Refer to [Item linking errors](/data/data-mapping/data-item-linking/item-linking-errors.md) for more information. + +## Item linking example + +![A diagram showing the threads linking multiple items back through a workflow](/_images/data/data-mapping/data-item-linking/item-linking-multiple-lines.png) + +In 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. + +The methods for accessing linked items are different depending on whether you're using the UI, expressions, or the code node. Explore the following resources: + +* [Mapping in the UI](/data/data-mapping/data-mapping-ui.md) +* [Mapping in the expressions editor](/data/data-mapping/data-mapping-expressions.md) +* [Item linking in the Code node](/data/data-mapping/data-item-linking/item-linking-code-node.md) +* [Item linking errors](/data/data-mapping/data-item-linking/item-linking-errors.md) + + + + + + +# data/data-mapping/data-item-linking/item-linking-errors.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# Item linking errors + +In 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`. + +
+![A diagram showing the threads linking multiple items back through a workflow](/_images/data/data-mapping/data-item-linking/item-linking-multiple-lines.png) +
Diagram of threads for different items. Due to the item linking, you can get the actor for each movie using `$('Get famous movie actors').item`.
+
+ +Since 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](/data/data-mapping/data-item-linking/item-linking-concepts.md) for detailed information on how this works. + +`.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. + +When using `.item`, n8n displays an error when: + +- The thread is broken +- The thread points to more than one item in the previous node (as it's unclear which one to use) + +To solve these errors, you can either avoid using `.item`, or fix the root cause. + +You 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](/code/builtin/output-other-nodes.md) for more detail on these methods. + +The fix for the root cause depends on the exact error. + +### Fix for 'Info for expressions missing from previous node' + +If you see this error message: + +> ERROR: Info for expression missing from previous node + +There's a node in the chain that doesn't return pairing information. The solution here depends on the type of the previous node: + +- 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](/data/data-mapping/data-item-linking/item-linking-code-node.md) for more information. +- 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](/data/data-mapping/data-item-linking/item-linking-node-building.md) for more information. + +### Fix for 'Multiple matching items for expression' + +This is the error message: + +> ERROR: Multiple matching items for expression + +Sometimes 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. + +When you use `.item` and there are multiple possible matches, n8n doesn't know which one to use. To solve this you can either: + +- Use `.first()`, `.last()` or `.all()[index]` instead. Refer to [Built in methods and variables | Output of other nodes](/code/builtin/output-other-nodes.md) for more detail on these methods. +- Reference a different node that contains the same information, but doesn't have multiple matching items. + + +# data/data-mapping/data-item-linking/item-linking-node-building.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Item linking for node creators + +--8<-- "_snippets/data/data-mapping/item-linking-node-creators.md" + + +# data/data-mapping/data-mapping-expressions.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Mapping in the expressions editor + +These examples show how to access linked items in the expressions editor. Refer to [expressions](/code/expressions.md) for more information on expressions, including built in variables and methods. + +For information on errors with mapping and linking items, refer to [Item linking errors](/data/data-mapping/data-item-linking/item-linking-errors.md). + +## Access the linked item in a previous node's output + +When you use this, n8n works back up the item linking chain, to find the parent item in the given node. + +```js +// Returns the linked item +{{$("").item}} +``` + +As a longer example, consider a scenario where a node earlier in the workflow has the following output data: + +```json +[ + { + "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", + } +] +``` + +To extract the name, use the following expression: + +```js +{{$("").item.json.name}} +``` + + +### Access the linked item in the current node's input + +In this case, the item linking is within the node: find the input item that the node links to an output item. + +```js +// Returns the linked item +{{$input.item}} +``` + +As a longer example, consider a scenario where the current node has the following input data: + +```json +[ + { + "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", + } +] +``` + +To extract the name, you'd normally use drag-and-drop [Data mapping](/data/data-mapping/index.md), but you could also write the following expression: + +```js +{{$input.item.json.name}} +``` + + +# data/data-mapping/data-mapping-ui.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Mapping in the UI + +Data mapping means referencing data from previous nodes. It doesn't include changing (transforming) data, just referencing it. + +You can map data in the following ways: + +* Using the expressions editor. +* By dragging and dropping data from the **INPUT** into parameters. This generates the expression for you. + +For information on errors with mapping and linking items, refer to [Item linking errors](/data/data-mapping/data-item-linking/item-linking-errors.md). + +## How to drag and drop data + +1. Run your workflow to load data. +2. Open the node where you need to map data. +3. You can map in table, JSON, and schema view: + * In table view: click and hold a table heading to map top level data, or a field in the table to map nested data. + * In JSON view: click and hold a key. + * In schema view: click and hold a key. +4. Drag the item into the field where you want to use the data. + +### Understand what you're mapping with drag and drop + +Data mapping maps the key path, and loads the key's value into the field. For example, given the following data: + +```js +[ + { + "fruit": "apples", + "color": "green" + } +] +``` + +You 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. + +### Understand nested data + +Given the following data: + +```js +[ + { + "name": "First item", + "nested": { + "example-number-field": 1, + "example-string-field": "apples" + } + }, + { + "name": "Second item", + "nested": { + "example-number-field": 2, + "example-string-field": "oranges" + } + } +] +``` + +n8n displays it in table form like this: + +!["Screenshot of a table in the INPUT panel. It includes a top level field named "nested." This field contains nested data, which is indicated in bold."](/_images/data/data-mapping/nested-data.png) + + + +# data/data-mapping/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Data mapping + +Data mapping means referencing data from previous nodes. + +This section contains guidance on: + +* Mapping data in most scenarios: [Data mapping in the UI](/data/data-mapping/data-mapping-ui.md) and [Data mapping in expression](/data/data-mapping/data-mapping-expressions.md) +* How to handle [item linking](/data/data-mapping/data-item-linking/index.md) when using the Code node or building your own nodes. + + +# data/data-mocking.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Data mocking +description: Ways to mock data in your n8n workflow. +contentType: howto +--- + +# Data mocking + +Data mocking is simulating or faking data. It's useful when developing a workflow. By mocking data, you can: + +- Avoid making repeated calls to your data source. This saves time and costs. +- Work with a small, predictable dataset during initial development. +- 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. + + +## Mocking with real data using data pinning + +Using [data pinning](/data/data-pinning.md), 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](/data/data-editing.md). + +Use this approach when you need to configure your workflow to handle the exact data structure and parameters provided by your data source. + +--8<-- "_snippets/data/how-to-pin-data.md" + + +## Generate custom data using the Code or Edit Fields nodes + +You can create a custom dataset in your workflow using either the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) or the [Edit Fields (Set) node](/integrations/builtin/core-nodes/n8n-nodes-base.set.md). + +In 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. + +The Edit Fields node is a good choice for small tests. To create more complex datasets, use the Code node. + +## Output a sample data set from the Customer Datastore node + +The Customer Datastore node provides a fake dataset to work with. Add and execute the node to explore the data. + +Use this approach if you need some test data when exploring n8n, and you don't have a real use-case to work with. + + +# data/data-pinning.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Data pinning + +You 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. + +You 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: + +* 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. +* If the external resource has data or usage limits, pinning data during tests avoids consuming your resource limits. +* You can fetch and pin the data you want to test, then have confidence that the data is consistent in all your workflow tests. + +You can only pin data for nodes that have a single main output ("error" outputs don't count for this purpose). + +/// note | For development only +Data pinning isn't available for production workflow executions. It's a feature to help test workflows during development. +/// + +## Pin data + +--8<-- "_snippets/data/how-to-pin-data.md" + +## Unpin data + +When 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. + + +# data/data-structure.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Data structure + +In n8n, all data passed between nodes is an array of objects. It has the following structure: + +```json +[ + { + // For most data: + // Wrap each item in another object, with the key 'json' + "json": { + // Example data + "apple": "beets", + "carrot": { + "dill": 1 + } + }, + // For binary data: + // Wrap each item in another object, with the key 'binary' + "binary": { + // Example data + "apple-picture": { + "data": "....", // Base64 encoded binary data (required) + "mimeType": "image/png", // Best practice to set if possible (optional) + "fileExtension": "png", // Best practice to set if possible (optional) + "fileName": "example.png", // Best practice to set if possible (optional) + } + } + }, +] +``` + +/// note | Skipping the `json` key and array syntax +From 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. +/// +## Data item processing + +--8<-- "_snippets/flow-logic/data-flow-nodes.md" + + + + +# data/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Data + +Data 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: + + - Create your own node + - Write custom [expressions](/glossary.md#expression-n8n) + - Use the Function or Function Item node + +This section covers: + +* [Data structure](/data/data-structure.md) +* [Data flow within nodes](/data/data-flow-nodes.md) +* [Transforming data](/data/transforming-data.md) +* [Process data using code](/data/code.md) +* [Pinning](/data/data-pinning.md) and [editing](/data/data-editing.md) data during workflow development. +* [Data mapping](/data/data-mapping/index.md) and [Item linking](/data/data-mapping/data-item-linking/index.md): how data items link to each other. + +## Related resources + +### Data transformation nodes + +n8n provides a collection of nodes to transform data: + +* [Aggregate](/integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md): take separate items, or portions of them, and group them together into individual items. +* [Limit](/integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md): remove items beyond a defined maximum number. +* [Remove Duplicates](/integrations/builtin/core-nodes/n8n-nodes-base.removeduplicates/index.md): identify and delete items that are identical across all fields or a subset of fields. +* [Sort](/integrations/builtin/core-nodes/n8n-nodes-base.sort.md): organize lists of in a desired ordering, or generate a random selection. +* [Split Out](/integrations/builtin/core-nodes/n8n-nodes-base.splitout.md): separate a single data item containing a list into multiple items. +* [Summarize](/integrations/builtin/core-nodes/n8n-nodes-base.summarize.md): aggregate items together, in a manner similar to Excel pivot tables. + + +# data/schema-preview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Schema preview +description: +contentType: overview +--- + +# Schema Preview + +Schema 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. + +## Using the preview + +1. There must be a node with Schema Preview available in your workflow. +1. 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. +1. Use data from the Schema Preview just as you would other schemas - drag and drop fields as input into your node parameters and settings. + + +# data/transforming-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Transforming data + +n8n uses a predefined [data structure](/data/data-structure.md) that allows all nodes to process incoming data correctly. + +Your 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. + +For example, the image below shows the output of an [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node that returns data incompatible with n8n's data structure. The node returns the data and displays that only one item was returned. + +![HTTP Request node output](/_images/data/transforming-data/HTTPRequest_output.png) + +To transform this kind of structure into the n8n data structure you can use the data transformation nodes: + +* [Aggregate](/integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md): take separate items, or portions of them, and group them together into individual items. +* [Limit](/integrations/builtin/core-nodes/n8n-nodes-base.limit.md): remove items beyond a defined maximum number. +* [Remove Duplicates](/integrations/builtin/core-nodes/n8n-nodes-base.removeduplicates/index.md): identify and delete items that are identical across all fields or a subset of fields. +* [Sort](/integrations/builtin/core-nodes/n8n-nodes-base.sort.md): organize lists of in a desired ordering, or generate a random selection. +* [Split Out](/integrations/builtin/core-nodes/n8n-nodes-base.splitout.md): separate a single data item containing a list into multiple items. +* [Summarize](/integrations/builtin/core-nodes/n8n-nodes-base.summarize.md): aggregate items together, in a manner similar to Excel pivot tables. + + diff --git a/llms/embed.md b/llms/embed.md new file mode 100644 index 00000000000..51d24deed5d --- /dev/null +++ b/llms/embed.md @@ -0,0 +1,953 @@ + + +# embed/configuration.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n Embed Configuration +description: Learn how to configure your n8n Embed. +contentType: howto +--- + +# Configuration + +--8<-- "_snippets/embed-license.md" + +## Authentication + +You can secure n8n by setting up [User management](/user-management/index.md), n8n's built-in authentication feature. + +n8n supports [LDAP](/user-management/ldap.md) and [SAML](/user-management/saml/index.md). + +### Credential overwrites + +To offer OAuth login to users, it's possible to overwrite [credentials](/glossary.md#credential-n8n) on a global basis. This credential data isn't visible to users but the backend uses it automatically. + +In the Editor UI, n8n hides all overwritten fields by default. This means that users are able to authenticate using OAuth by pressing the "connect" button on the credentials. + +n8n offers two ways to apply credential overwrites: using Environment Variable and using the REST API. + +#### Using environment variables + +You can set credential overwrites using environment variable by setting the `CREDENTIALS_OVERWRITE_DATA` to `{ CREDENTIAL_NAME: { PARAMETER: VALUE }}`. + +/// warning +Even though this is possible, it isn't recommended. Environment variables aren't protected in n8n, so the data can leak to users. +/// + +#### Using REST APIs + +The recommended way is to load the data using a custom REST endpoint. Set the `CREDENTIALS_OVERWRITE_ENDPOINT` to a path under which this endpoint should be made available. + +/// note +The endpoints can be called just one at a time for security reasons. +/// + +For example: + +1. Activate the endpoint by setting the environment variable in the environment n8n runs under: + + ```sh + export CREDENTIALS_OVERWRITE_ENDPOINT=send-credentials + ``` + +2. A JSON file with the credentials to overwrite is then needed. For example, a `oauth-credentials.json` file to overwrite credentials for Asana and GitHub could look like this: + + ```json + { + "asanaOAuth2Api": { + "clientId": "", + "clientSecret": "" + }, + "githubOAuth2Api": { + "clientId": "", + "clientSecret": "" + } + } + ``` + +3. Then apply it to the instance by sending it using curl: + + ```sh + curl -H "Content-Type: application/json" --data @oauth-credentials.json http://localhost:5678/send-credentials + ``` + +/// note +There are cases when credentials are based on others. For example, the `googleSheetsOAuth2Api` extends the `googleOAuth2Api`. +In this case, you can set parameters on the parent credentials (`googleOAuth2Api`) for all child-credentials (`googleSheetsOAuth2Api`) to use. +/// + +## Environment variables + +n8n has many [environment variables](/hosting/configuration/environment-variables/index.md) you can configure. Here are the most relevant environment variables for your hosted solution: + +| Variable | Type | Default | Description | +| :------- | :--- | :------ | :---------- | +| `EXECUTIONS_TIMEOUT` | Number | `-1` | Sets a default timeout (in seconds) to all workflows after which n8n stops their execution. Users can override this for individual workflows up to the duration set in `EXECUTIONS_TIMEOUT_MAX`. Set `EXECUTIONS_TIMEOUT` to `-1` to disable. | +| `EXECUTIONS_DATA_PRUNE` | Boolean | `true` | Whether to delete data of past executions on a rolling basis. | +| `EXECUTIONS_DATA_MAX_AGE` | Number | `336` | The execution age (in hours) before it's deleted. | +| `EXECUTIONS_DATA_PRUNE_MAX_COUNT` | Number | `10000` | Maximum number of executions to keep in the database. 0 = no limit | +| `NODES_EXCLUDE` | Array of strings | - | Specify which nodes not to load. For example, to block nodes that can be a security risk if users aren't trustworthy: `NODES_EXCLUDE: "[\"n8n-nodes-base.executeCommand\", \"n8n-nodes-base.readWriteFile\"]"` | +| `NODES_INCLUDE` | Array of strings | - | Specify which nodes to load. | +| `N8N_TEMPLATES_ENABLED` | Boolean | `true` | Enable [workflow templates](/glossary.md#template-n8n) (true) or disable (false). | +| `N8N_TEMPLATES_HOST` | String | `https://api.n8n.io` | Change this if creating your own workflow template library. Note that to use your own workflow templates library, your API must provide the same endpoints and response structure as n8n's. Refer to [Workflow templates](/workflows/templates.md) for more information. | + +## Backend hooks + +It's possible to define external hooks that n8n executes whenever a specific operation runs. You can use these, for example, to log data, change data, or forbid an action by throwing an error. + +### Available hooks + +| Hook | Arguments | Description | +| :------- | :---------| :---------- | +| `credentials.create` | `[credentialData: ICredentialsDb]` | Called before new credentials get created. Use to restrict the number of credentials. | +| `credentials.delete` | `[id: credentialId]` | Called before credentials get deleted. | +| `credentials.update` | `[credentialData: ICredentialsDb]` | Called before existing credentials are saved. | +| `frontend.settings` | `[frontendSettings: IN8nUISettings]` | Gets called on n8n startup. Allows you to, for example, overwrite frontend data like the displayed OAuth URL. | +| `n8n.ready` | `[app: App]` | Called once n8n is ready. Use to, for example, register custom API endpoints. | +| `n8n.stop` | | Called when an n8n process gets stopped. Allows you to save some process data. | +| `oauth1.authenticate` | `[oAuthOptions: clientOAuth1.Options, oauthRequestData: {oauth_callback: string}]` | Called before an OAuth1 authentication. Use to overwrite an OAuth callback URL. | +| `oauth2.callback` | `[oAuth2Parameters: {clientId: string, clientSecret: string \| undefined, accessTokenUri: string, authorizationUri: string, redirectUri: string, scopes: string[]}]` | Called in an OAuth2 callback. Use to overwrite an OAuth callback URL. | +| `workflow.activate` | `[workflowData: IWorkflowDb]` | Called before a workflow gets activated. Use to restrict the number of active workflows. | +| `workflow.afterDelete` | `[workflowId: string]` | Called after a workflow gets deleted. | +| `workflow.afterUpdate` | `[workflowData: IWorkflowBase]` | Called after an existing workflow gets saved. | +| `workflow.create` | `[workflowData: IWorkflowBase]` | Called before a workflow gets created. Use to restrict the number of saved workflows. | +| `workflow.delete` | `[workflowId: string]` | Called before a workflow gets delete. | +| `workflow.postExecute` | `[run: IRun, workflowData: IWorkflowBase]` | Called after a workflow gets executed. | +| `workflow.preExecute` | `[workflow: Workflow: mode: WorkflowExecuteMode]` | Called before a workflow gets executed. Allows you to count or limit the number of workflow executions. | +| `workflow.update` | `[workflowData: IWorkflowBase]` | Called before an existing workflow gets saved. | + +### Registering hooks + +Set hooks by registering a hook file that contains the hook functions. +To register a hook, set the environment variable `EXTERNAL_HOOK_FILES`. + +You can set the variable to a single file: + +`EXTERNAL_HOOK_FILES=/data/hook.js` + +Or to contain multiple files separated by a semicolon: + +`EXTERNAL_HOOK_FILES=/data/hook1.js;/data/hook2.js` + +### Backend hook files + +Hook files are regular JavaScript files that have the following format: + +```js +module.exports = { + "frontend": { + "settings": [ + async function (settings) { + settings.oauthCallbackUrls.oauth1 = 'https://n8n.example.com/oauth1/callback'; + settings.oauthCallbackUrls.oauth2 = 'https://n8n.example.com/oauth2/callback'; + } + ] + }, + "workflow": { + "activate": [ + async function (workflowData) { + const activeWorkflows = await this.dbCollections.Workflow.count({ active: true }); + + if (activeWorkflows > 1) { + throw new Error( + 'Active workflow limit reached.' + ); + } + } + ] + } +} +``` + +### Backend hook functions + +A hook or a hook file can contain multiple hook functions, with all functions executed one after another. + +If the parameters of the hook function are objects, it's possible to change the data of that parameter to change the behavior of n8n. + +You can also access the database in any hook function using `this.dbCollections` (refer to the code sample in [Backend hook files](#backend-hook-files). + +## Frontend external hooks + +Like backend external hooks, it's possible to define external hooks in the frontend code that get executed by n8n whenever a user performs a specific operation. You can use them, for example, to log data and change data. + +### Available hooks + +| Hook | Description | +| :------- | :---------- | +| `credentialsEdit.credentialTypeChanged` | Called when an existing credential's type changes. | +| `credentials.create` | Called when someone creates a new credential. | +| `credentialsList.dialogVisibleChanged` | | +| `dataDisplay.nodeTypeChanged` | | +| `dataDisplay.onDocumentationUrlClick` | Called when someone selects the help documentation link. | +| `execution.open` | Called when an existing execution opens. | +| `executionsList.openDialog` | Called when someone selects an execution from existing Workflow Executions. | +| `expressionEdit.itemSelected` | | +| `expressionEdit.dialogVisibleChanged` | | +| `nodeCreateList.filteredNodeTypesComputed` | | +| `nodeCreateList.nodeFilterChanged` | Called when someone makes any changes to the node panel filter. | +| `nodeCreateList.selectedTypeChanged` | | +| `nodeCreateList.mounted` | | +| `nodeCreateList.destroyed` | | +| `nodeSettings.credentialSelected` | | +| `nodeSettings.valueChanged` | | +| `nodeView.createNodeActiveChanged` | | +| `nodeView.addNodeButton` | | +| `nodeView.createNodeActiveChanged` | | +| `nodeView.mount` | | +| `pushConnection.executionFinished` | | +| `showMessage.showError` | | +| `runData.displayModeChanged` | | +| `workflow.activeChange` | | +| `workflow.activeChangeCurrent` | | +| `workflow.afterUpdate` | Called when someone updates an existing workflow. | +| `workflow.open` | | +| `workflowRun.runError` | | +| `workflowRun.runWorkflow` | Called when a workflow executes. | +| `workflowSettings.dialogVisibleChanged` | | +| `workflowSettings.saveSettings` | Called when someone saves the settings of a workflow. | + +### Registering hooks + +You can set hooks by loading the hooks script on the page. One way to do this is by creating a hooks file in the project and adding a script tag in your `editor-ui/public/index.html` file: + +```html + +``` + +### Frontend hook files + +Frontend external hook files are regular JavaScript files which have the following format: + +```js +window.n8nExternalHooks = { + nodeView: { + mount: [ + function (store, meta) { + // do something + }, + ], + createNodeActiveChanged: [ + function (store, meta) { + // do something + }, + function (store, meta) { + // do something else + }, + ], + addNodeButton: [ + function (store, meta) { + // do something + }, + ], + }, +}; +``` + +### Frontend hook functions + +You can define multiple hook functions per hook. Each hook function is invoked with the following arguments arguments: + +* `store`: The Vuex store object. You can use this to change or get data from the store. +* `metadata`: The object that contains any data provided by the hook. To see what's passed, search for the hook in the `editor-ui` package. + + +# embed/deployment.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Deployment + +--8<-- "_snippets/embed-license.md" + +See the [hosting documentation](https://docs.n8n.io/reference/server-setup.html) for detailed setup options. + +## User data + +n8n recommends that you follow the same or similar practices used internally for n8n Cloud: Save user data using [Rook](https://rook.io/) and, if an n8n server goes down, a new instance starts on another machine using the same data. + +Due to this, you don't need to use backups except in case of a catastrophic failure, or when a user wants to reactivate their account within your prescribed retention period (two weeks for n8n Cloud). + +## Backups + +n8n recommends creating nightly backups by attaching another container, and copying all data to this second container. In this manner, RAM usage is negligible, and so doesn't impact the amount of users you can place on the server. + +## Restarting + +If your instance is down or restarting, missed executions (for example, Cron or Webhook nodes) during this time aren't recoverable. If it's important for you to maintain 100% uptime, you need to build another proxy in front of it which caches the data. + + +# embed/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n Embed Documentation and Guides +description: Learn how to white label and integrate n8n into your products with the Embed feature. Includes usage, costs, licensing, and support details. +contentType: overview +--- + +# n8n Embed + +n8n 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. + +For more information about when to use Embed, as well as costs and licensing processes, refer to [Embed](https://n8n.io/embed/){:target=_blank .external-link} on the n8n website. + +## Support + +The [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. + +## Russia and Belarus + +n8n 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/){:target=_blank .external-link} for more information. + + +# embed/managing-workflows.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Workflow management in Embed + +--8<-- "_snippets/embed-license.md" + +When managing an embedded n8n deployment, spanning across teams or organizations, you will likely need to run the same (or similar) workflows for multiple users. There are two available options for doing so: + +| Solution | Pros | Cons | +| -------- | ---- | ---- | +| Create a workflow for each user | No limitation on how workflow starts (can use any trigger) | Requires managing multiple workflows. | +| Create a single workflow, and pass it user credentials when executing | Simplified workflow management (only need to change one workflow). | To run the workflow, your product must call it | + + + +/// warning +The APIs referenced in this document are subject to change at any time. Be sure the check for continued functionality with each version upgrade. +/// + +## Workflow per user + +There are three general steps to follow: + +* Obtain the credentials for each user, and any additional parameters that may be required based on the workflow. +* Create the [n8n credentials](/glossary.md#credential-n8n) for this user. +* Create the workflow. + +### 1. Obtain user credentials + +Here you need to capture all credentials for any node/service this user must authenticate with, along with any additional parameters required for the particular workflow. The credentials and any parameters needed will depend on your workflow and what you are trying to do. + +### 2. Create user credentials + +After all relevant credential details have been obtained, you can proceed to create the relevant service credentials in n8n. This can be done using the Editor UI or API call. + + +#### Using the Editor UI + +1. From the menu select **Credentials** > **New**. +1. Use the drop-down to select the **Credential type** to create, for example *Airtable*. + ![Create New Credentials drop-down](/_images/embed/managing-workflows/create_new_credentials.png) +1. In the **Create New Credentials** modal, enter the corresponding credentials details for the user, and select the nodes that will have access to these credentials. + ![Create New Credentials modal](/_images/embed/managing-workflows/create_new_credentials2.png) +1. Click **Create** to finish and save. + +#### Using the API + +The frontend API used by the Editor UI can also be called to achieve the same result. The API endpoint is in the format: `https:///rest/credentials`. + +For example, to create the credentials in the Editor UI example above, the request would be: +``` +POST https:///rest/credentials +``` + +With the request body: +```json +{ + "name":"MyAirtable", + "type":"airtableApi", + "nodesAccess":[ + { + "nodeType":"n8n-nodes-base.airtable" + } + ], + "data":{ + "apiKey":"q12we34r5t67yu" + } +} +``` + +The response will contain the ID of the new credentials, which you will use when creating the workflow for this user: +```json +{ + "data":{ + "name":"MyAirtable", + "type":"airtableApi", + "data":{ + "apiKey":"q12we34r5t67yu" + }, + "nodesAccess":[ + { + "nodeType":"n8n-nodes-base.airtable", + "date":"2021-09-10T07:41:27.770Z" + } + ], + "id":"29", + "createdAt":"2021-09-10T07:41:27.777Z", + "updatedAt":"2021-09-10T07:41:27.777Z" + } +} +``` + +### 3. Create the workflow + +Best practice is to have a “base” workflow that you then duplicate and customize for each new user with their credentials (and any other details). + +You can duplicate and customize your template workflow using either the Editor UI or API call. + +#### Using the Editor UI + +1. From the menu select **Workflows** > **Open** to open the template workflow to be duplicated. + +1. Select **Workflows** > **Duplicate**, then enter a name for this new workflow and click **Save**. + ![Duplicate workflow](/_images/embed/managing-workflows/duplicate_workflow.png) + +1. Update all relevant nodes to use the credentials for this user (created above). + +1. **Save** this workflow set it to **Active** using the toggle in the top-right corner. + +#### Using the API + +1. Fetch the JSON of the template workflow using the endpoint: `https:///rest/workflows/` +``` +GET https:///rest/workflows/1012 +``` + +The response will contain the JSON data of the selected workflow: +```json +{ + "data": { + "id": "1012", + "name": "Nathan's Workflow", + "active": false, + "nodes": [ + { + "parameters": {}, + "name": "Start", + "type": "n8n-nodes-base.start", + "typeVersion": 1, + "position": [ + 130, + 640 + ] + }, + { + "parameters": { + "authentication": "headerAuth", + "url": "https://internal.users.n8n.cloud/webhook/custom-erp", + "options": { + "splitIntoItems": true + }, + "headerParametersUi": { + "parameter": [ + { + "name": "unique_id", + "value": "recLhLYQbzNSFtHNq" + } + ] + } + }, + "name": "HTTP Request", + "type": "n8n-nodes-base.httpRequest", + "typeVersion": 1, + "position": [ + 430, + 300 + ], + "credentials": { + "httpHeaderAuth": "beginner_course" + } + }, + { + "parameters": { + "operation": "append", + "application": "appKBGQfbm6NfW6bv", + "table": "processingOrders", + "options": {} + }, + "name": "Airtable", + "type": "n8n-nodes-base.airtable", + "typeVersion": 1, + "position": [ + 990, + 210 + ], + "credentials": { + "airtableApi": "Airtable" + } + }, + { + "parameters": { + "conditions": { + "string": [ + { + "value1": "={{$json[\"orderStatus\"]}}", + "value2": "processing" + } + ] + } + }, + "name": "IF", + "type": "n8n-nodes-base.if", + "typeVersion": 1, + "position": [ + 630, + 300 + ] + }, + { + "parameters": { + "keepOnlySet": true, + "values": { + "number": [ + { + "name": "=orderId", + "value": "={{$json[\"orderID\"]}}" + } + ], + "string": [ + { + "name": "employeeName", + "value": "={{$json[\"employeeName\"]}}" + } + ] + }, + "options": {} + }, + "name": "Set", + "type": "n8n-nodes-base.set", + "typeVersion": 1, + "position": [ + 800, + 210 + ] + }, + { + "parameters": { + "functionCode": "let totalBooked = items.length;\nlet bookedSum = 0;\n\nfor(let i=0; i < items.length; i++) {\n bookedSum = bookedSum + items[i].json.orderPrice;\n}\nreturn [{json:{totalBooked, bookedSum}}]\n" + }, + "name": "Function", + "type": "n8n-nodes-base.function", + "typeVersion": 1, + "position": [ + 800, + 400 + ] + }, + { + "parameters": { + "webhookUri": "https://discord.com/api/webhooks/865213348202151968/oD5_WPDQwtr22Vjd_82QP3-_4b_lGhAeM7RynQ8Js5DzyXrQEnj0zeAQIA6fki1JLtXE", + "text": "=This week we have {{$json[\"totalBooked\"]}} booked orders with a total value of {{$json[\"bookedSum\"]}}. My Unique ID: {{$node[\"HTTP Request\"].parameter[\"headerParametersUi\"][\"parameter\"][0][\"value\"]}}" + }, + "name": "Discord", + "type": "n8n-nodes-base.discord", + "typeVersion": 1, + "position": [ + 1000, + 400 + ] + }, + { + "parameters": { + "triggerTimes": { + "item": [ + { + "mode": "everyWeek", + "hour": 9 + } + ] + } + }, + "name": "Cron", + "type": "n8n-nodes-base.cron", + "typeVersion": 1, + "position": [ + 220, + 300 + ] + } + ], + "connections": { + "HTTP Request": { + "main": [ + [ + { + "node": "IF", + "type": "main", + "index": 0 + } + ] + ] + }, + "Start": { + "main": [ + [] + ] + }, + "IF": { + "main": [ + [ + { + "node": "Set", + "type": "main", + "index": 0 + } + ], + [ + { + "node": "Function", + "type": "main", + "index": 0 + } + ] + ] + }, + "Set": { + "main": [ + [ + { + "node": "Airtable", + "type": "main", + "index": 0 + } + ] + ] + }, + "Function": { + "main": [ + [ + { + "node": "Discord", + "type": "main", + "index": 0 + } + ] + ] + }, + "Cron": { + "main": [ + [ + { + "node": "HTTP Request", + "type": "main", + "index": 0 + } + ] + ] + } + }, + "createdAt": "2021-07-16T11:15:46.066Z", + "updatedAt": "2021-07-16T12:05:44.045Z", + "settings": {}, + "staticData": null, + "tags": [] + } +} +``` + +1. Save the returned JSON data and update any relevant credentials and fields for the new user. + +1. Create a new workflow using the updated JSON as the request body at endpoint: `https:///rest/workflows` +``` +POST https:///rest/workflows/ +``` + +The response will contain the ID of the new workflow, which you will use in the next step. + +1. Lastly, activate the new workflow: +``` +PATCH https:///rest/workflows/1012 +``` + +Passing the additional value `active` in your JSON payload: +```json +// ... +"active":true, +"settings": {}, +"staticData": null, +"tags": [] +``` + +## Single workflow + +There are four steps to follow to implement this method: + +* Obtain the credentials for each user, and any additional parameters that may be required based on the workflow. See [Obtain user credentials](#1-obtain-user-credentials) above. +* Create the n8n credentials for this user. See [Create user credentials](#2-create-user-credentials) above. +* Create the workflow. +* Call the workflow as needed. + +### Create the workflow + +The details and scope of this workflow will vary greatly according to the individual use case, however there are a few design implementations to keep in mind: + +* This workflow must be triggered by a [Webhook](/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md) node. +* The incoming webhook call must contain the user’s credentials and any other workflow parameters required. +* Each node where the user’s credentials are needed should use an [expression](/code/expressions.md) so that the node’s credential field reads the credential provided in the webhook call. +* Save and activate the workflow, ensuring the production URL is selected for the Webhook node. Refer to [webhook node](/integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md) for more information. + +### Call the workflow + +For each new user, or for any existing user as may be needed, call the webhook defined as the workflow trigger and provide the necessary credentials (and any other workflow parameters). + + +# embed/prerequisites.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Prerequisites + +--8<-- "_snippets/embed-license.md" + +The requirements provided here are an example based on n8n Cloud and are for illustrative purposes only. Your requirements may vary depending on the number of users, workflows, and executions. Contact n8n for more information. + +| Component | Sizing | Supported | +| :-------- | :----- | :-------- | +| CPU/vCPU | Minimum 10 CPU cycles, scaling as needed | Any public or private cloud | +| Database | 512 MB - 4 GB SSD | SQLite or PostgreSQL | +| Memory | 320 MB - 2 GB | | + +## CPU considerations + +n8n isn't CPU intensive so even small instances (of providers such as AWS and GCP) should be enough for most use cases. Usually, memory requirements supersede CPU requirements, so focus resources there when planning your infrastructure. + +## Database considerations + +n8n uses its database to store [credentials](/glossary.md#credential-n8n), past executions, and workflows. + +A core feature of n8n is the flexibility to choose a database. All the supported databases have different advantages and disadvantages, which you have to consider individually and pick the one that best suits your needs. By default n8n creates an SQLite database if no database exists at the given location. + +n8n recommends that every n8n instance have a dedicated database. This helps to prevent dependencies and potential performance degradation. If it isn't possible to provide a dedicated database for every n8n instance, n8n recommends making use of Postgres's schema feature. + +For Postgres, the database must already exist on the DB-instance. The database user for the n8n process needs to have full permissions on all tables that they're using or creating. n8n creates and maintains the database schema. + +### Best practices + +* SSD storage. +* In containerized cloud environments, ensure that the volume is persisted and mounted when stopping/starting a container. If not, all data is lost. +* If using Postgres, don't use the `tablePrefix` configuration option. It will be deprecated in the near future. +* Pay attention to the changelog of new versions and consider reverting migrations before downgrading. +* Set up at least the basic database security and stability mechanisms such as IP allow lists and backups. + +## Memory considerations + +An n8n instance doesn't typically require large amounts of available memory. For example an n8n Cloud instance at idle requires ~100MB. It's the nature of your workflows and the data being processed that determines your memory requirements. + +For example, while most nodes just pass data to the next node in the workflow, the [Code node](/code/code-node.md) creates a pre-processing and post-processing copy of the data. When dealing will large binary files, this can consume all available resources. + + +# embed/white-labelling.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# White labelling + +--8<-- "_snippets/embed-license.md" + +White labelling n8n means customizing the frontend styling and assets to match your brand identity. The process involves changing two packages in n8n's source code [github.com/n8n-io/n8n](https://github.com/n8n-io/n8n){:target=_blank .external-link}: + +* [packages/design-system](https://github.com/n8n-io/n8n/tree/master/packages/design-system){:target=_blank .external-link}: n8n's [storybook](https://storybook.js.org/){:target=_blank .external-link} design system with CSS styles and Vue.js components +* [packages/editor-ui](https://github.com/n8n-io/n8n/tree/master/packages/editor-ui){:target=_blank .external-link}: n8n's [Vue.js](https://vuejs.org/){:target=_blank .external-link} frontend build with [Vite.js](https://vitejs.dev){:target=_blank .external-link} + +## Prerequisites + +You need the following installed on your development machine: + +--8<-- "_snippets/integrations/creating-nodes/prerequisites.md" + +Create a fork of [n8n's repository](https://github.com/n8n-io/n8n){:target=_blank .external-link} and clone your new repository. + +```shell +git clone https://github.com//n8n.git n8n +cd n8n +``` + +Install all dependencies, build and start n8n. + +```shell +npm install +npm run build +npm run start +``` + +Whenever you make changes you need to rebuild and restart n8n. While developing you can use `npm run dev` to automatically rebuild and restart n8n anytime you make code changes. + +## Theme colors + +To customize theme colors open [packages/design-system](https://github.com/n8n-io/n8n/tree/master/packages/design-system){:target=_blank .external-link} and start with: + +- [packages/design-system/src/css/_tokens.scss](https://github.com/n8n-io/n8n/blob/master/packages/design-system/src/css/_tokens.scss){:target=_blank .external-link} +- [packages/design-system/src/css/_tokens.dark.scss](https://github.com/n8n-io/n8n/blob/master/packages/design-system/src/css/_tokens.dark.scss){:target=_blank .external-link} + +At the top of `_tokens.scss` you will find `--color-primary` variables as HSL colors: + +```scss +@mixin theme { + --color-primary-h: 6.9; + --color-primary-s: 100%; + --color-primary-l: 67.6%; +``` + +In the following example the primary color changes to #0099ff. To convert to HSL you can use a [color converter tool](https://www.w3schools.com/colors/colors_converter.asp){:target=_blank .external-link}. + +```scss +@mixin theme { + --color-primary-h: 204; + --color-primary-s: 100%; + --color-primary-l: 50%; +``` + +![Example Theme Color Customization](/_images/embed/white-label/color-transition.gif) + + +## Theme logos + +To change the editor’s logo assets look into [packages/editor-ui/public](https://github.com/n8n-io/n8n/tree/master/packages/editor-ui/public){:target=_blank .external-link} and replace: + +- favicon-16x16.png +- favicon-32x32.png +- favicon.ico +- n8n-logo.svg +- n8n-logo-collapsed.svg +- n8n-logo-expanded.svg + +Replace these logo assets. n8n uses them in Vue.js components, including: + +* [MainSidebar.vue](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/src/components/MainSidebar.vue){:target=_blank .external-link}: top/left logo in the main sidebar. +* [Logo.vue](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/src/components/Logo.vue): reused in other components. + +In the following example replace `n8n-logo-collapsed.svg` and `n8n-logo-expanded.svg` to update the main sidebar's logo assets. + +![Example Logo Main Sidebar](/_images/embed/white-label/logo-main-sidebar.png) + +If your logo assets require different sizing or placement you can customize SCSS styles at the bottom of [MainSidebar.vue](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/src/components/MainSidebar.vue){:target=_blank .external-link}. + +```scss +.logoItem { + display: flex; + justify-content: space-between; + height: $header-height; + line-height: $header-height; + margin: 0 !important; + border-radius: 0 !important; + border-bottom: var(--border-width-base) var(--border-style-base) var(--color-background-xlight); + cursor: default; + + &:hover, &:global(.is-active):hover { + background-color: initial !important; + } + + * { vertical-align: middle; } + .icon { + height: 18px; + position: relative; + left: 6px; + } + +} +``` + +## Text localization + +To change all text occurrences like `n8n` or `n8n.io` to your brand identity you can customize n8n's English internationalization file: [packages/editor-ui/src/plugins/i18n/locales/en.json](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/src/plugins/i18n/locales/en.json){:target=_blank .external-link}. + +n8n uses the [Vue I18n](https://kazupon.github.io/vue-i18n/){:target=_blank .external-link} internationalization plugin for Vue.js to translate the majority of UI texts. To search and replace text occurrences inside `en.json` you can use [Linked locale messages](https://kazupon.github.io/vue-i18n/guide/messages.html#linked-locale-messages){:target=_blank .external-link}. + +In the following example add the `_brand.name` translation key to white label n8n's [AboutModal.vue](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/src/components/AboutModal.vue){:target=_blank .external-link}. + +```js +{ + "_brand.name": "My Brand", + //replace n8n with link to _brand.name + "about.aboutN8n": "About @:_brand.name", + "about.n8nVersion": "@:_brand.name Version", +} +``` + +![Example About Modal Localization](/_images/embed/white-label/about-modal.png) + +### Window title + +To change n8n's window title to your brand name, edit the following: + +- [packages/editor-ui/index.html](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/index.html){:target=_blank .external-link} +- [packages/editor-ui/src/components/mixins/titleChange.ts](https://github.com/n8n-io/n8n/blob/master/packages/editor-ui/src/components/mixins/titleChange.ts){:target=_blank .external-link} + +The following example replaces all occurrences of `n8n` and `n8n.io` with `My Brand` in `index.html` and `titleChange.ts`. + +```html + + + + + My Brand - Workflow Automation + +``` + +```typescript +$titleSet(workflow: string, status: WorkflowTitleStatus) { + // replace n8n prefix + window.document.title = `My Brand - ${icon} ${workflow}`; +}, + +$titleReset() { + // replace n8n prefix + document.title = `My Brand - Workflow Automation`; +}, +``` + +![Example Window Title Localization](/_images/embed/white-label/window-title.png) + + + + + + +# embed/workflow-templates.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Workflow templates + +--8<-- "_snippets/embed-license.md" + +n8n provides a library of workflow [templates](/glossary.md#template-n8n). When embedding n8n, you can: + +* Continue to use n8n's workflow templates library (this is the default behavior) +* Disable workflow templates +* Create your own workflow templates library + +## Disable workflow templates + +--8<-- "_snippets/workflows/templates/disable-templates.md" + +## Use your own workflow templates library + +--8<-- "_snippets/workflows/templates/custom-templates-library.md" + +## Add your workflows to the n8n library + +--8<-- "_snippets/workflows/templates/submit-templates.md" + diff --git a/llms/flow-logic.md b/llms/flow-logic.md new file mode 100644 index 00000000000..da4dc139029 --- /dev/null +++ b/llms/flow-logic.md @@ -0,0 +1,276 @@ + + +# flow-logic/error-handling.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +description: How to handle execution errors. +--- + +# Error handling + +When 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. + +/// note | Investigating errors +To investigate failed executions, you can: + +* Review your [Executions](/workflows/executions/index.md), for a [single workflow](/workflows/executions/single-workflow-executions.md) or [all workflows you have access to](/workflows/executions/all-executions.md). You can [load data from previous execution](/workflows/executions/debug.md) into your current workflow. +* Enable [Log streaming](/log-streaming.md). +/// + +## Create and set an error workflow + +For 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](/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger.md). + +You can use the same error workflow for multiple workflows. + +--8<-- "_snippets/flow-logic/create-set-error-workflow.md" + +## Error data + +--8<-- "_snippets/integrations/builtin/core-nodes/error-trigger/error-data.md" + +## Cause a workflow execution failure using Stop And Error + +When 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. + +You can add the [Stop And Error](/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror.md) node to your workflow to force executions to fail under your chosen circumstances, and trigger the error workflow. + + +# flow-logic/execution-order.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Execution order in multi-branch workflows +description: How n8n decides the node execution order in multi-branch workflows. +contentType: explanation +--- + +# Execution order in multi-branch workflows + +n8n's node execution order depends on the version of n8n you're using: + +* 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. +* 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](/glossary.md#canvas-n8n), from topmost to bottommost. If two branches are at the same height, the leftmost branch executes first. + +You can change the execution order in your [workflow settings](/workflows/settings.md). + + + +# flow-logic/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Flow logic +description: How to represent logic in n8n workflows. +contentType: overview +--- + +# Flow logic + +n8n allows you to represent complex logic in your workflows. + +[[% import "_macros/section-toc.html" as sectionToc %]] + +This section covers: + +[[ sectionToc.sectionToc(page) ]] + +## Related sections + +You need some understanding of [Data](/data/index.md) in n8n, including [Data structure](/data/data-structure.md) and [Data flow within nodes](/data/data-flow-nodes.md). + +When building your logic, you'll use n8n's [Core nodes](/integrations/builtin/core-nodes/index.md), including: + +* Splitting: [IF](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) and [Switch](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md). +* Merging: [Merge](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md), [Compare Datasets](/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md), and [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). +* Looping: [IF](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) and [Loop Over Items](/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md). +* Waiting: [Wait](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md). +* Creating sub-workflows: [Execute Workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) and [Execute Workflow Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md). +* Error handling: [Stop And Error](/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror.md) and [Error Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.errortrigger.md). + + +# flow-logic/looping.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Looping in n8n + +Looping 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. + +## Using loops in n8n + +n8n 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. + +![The Customer Datastore node output](/_images/flow-logic/looping/customer_datastore_node.png) + +Nodes 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: + +1. Connect the Slack node to the Customer Datastore node. +2. Configure the parameters. +3. Execute the node. + +You would receive five messages: one for each item. + +This is how you can process multiple items without having to explicitly connect nodes in a loop. + +### Executing nodes once + +For 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. + + +## Creating loops + +n8n 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. + +### Loop until a condition is met + +To create a loop in an n8n workflow, connect the output of one node to the input of a previous node. Add an [IF](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) node to check when to stop the loop. + +Here is an [example workflow](https://n8n.io/workflows/1130) that implements a loop with an `IF` node: + +![Editor UI view of sample workflow](/_images/flow-logic/looping/example_workflow.png) + +### Loop until all items are processed + +Use the [Loop Over Items](/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md) node when you want to loop until all items are processed. To process each item individually, set **Batch Size** to `1`. + +You 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. + +The 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. + +## Node exceptions + +Nodes and operations where you need to design a loop into your workflow: + +* [CrateDB](/integrations/builtin/app-nodes/n8n-nodes-base.cratedb.md) executes once for `insert` and `update`. +* [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node in **Run Once for All Items** mode: processes all the items based on the entered code snippet. +* [Execute Workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) node in **Run Once for All Items** mode. +* [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md): you must handle pagination yourself. If your API call returns paginated results you must create a loop to fetch one page at a time. +* [Microsoft SQL](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftsql.md) executes once for `insert`, `update`, and `delete`. +* [MongoDB](/integrations/builtin/app-nodes/n8n-nodes-base.mongodb.md) executes once for `insert` and `update`. +* [QuestDB](/integrations/builtin/app-nodes/n8n-nodes-base.questdb.md) executes once for `insert`. +* [Redis](/integrations/builtin/app-nodes/n8n-nodes-base.redis.md): + * Info: this operation executes only once, regardless of the number of items in the incoming data. +* [RSS Read](/integrations/builtin/core-nodes/n8n-nodes-base.rssfeedread.md) executes once for the requested URL. +* [TimescaleDB](/integrations/builtin/app-nodes/n8n-nodes-base.timescaledb.md) executes once for `insert` and `update`. + + +# flow-logic/merging.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +description: Merge data streams in you n8n workflows. +--- + +# Merging data + +Merging brings multiple data streams together. You can achieve this using different nodes depending on your workflow requirements. + +- Merge data from different data streams or nodes: Use the [Merge](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md) node to combine data from various sources into one. +- Merge data from multiple node executions: Use the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node for complex scenarios where you need to merge data from multiple executions of a node or multiple nodes. +- Compare and merge data: Use the [Compare Datasets](/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md) node to compare, merge, and output data streams based on the comparison. + +Explore each method in more detail in the sections below. + +## Merge data from different data streams + +If your workflow [splits](/flow-logic/splitting.md), you combine the separate streams back into one stream. + +Here'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](/integrations/builtin/core-nodes/n8n-nodes-base.merge.md) documentation contains details on each of the merge operations. + +[[ workflowDemo("https://api.n8n.io/workflows/templates/1747") ]] + +## Merge data from different nodes + +You 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. + +
+![Merging data from two previous nodes. The diagram shows three nodes lined up sequentially. The first node is labeled Fetch data, the second is labeled Modify data, and the third is labeled Merge: append both data sets. Arrows connect nodes 1 to 2, 2 to 3, and 1 to 3.](/_images/flow-logic/merging/merge-node-data.png) +
Merging data from two previous nodes
+
+ +## Merge data from multiple node executions + +Use the Code node to merge data from multiple node executions. This is useful in some [Looping](/flow-logic/looping.md) scenarios. + +/// note | Node executions and workflow executions +This section describes merging data from multiple node executions. This is when a node executes multiple times during a single workflow execution. +/// +Refer to this [example workflow](https://n8n.io/workflows/1814-merge-multiple-runs-into-one/){:target=_blank .external-link} using Loop Over Items and Wait to artificially create multiple executions. + +[[ workflowDemo("https://api.n8n.io/workflows/templates/1814") ]] + +## Compare, merge, and split again + +The [Compare Datasets](/integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md) node compares data streams before merging them. It outputs up to four different data streams. + +Refer to this [example workflow](https://n8n.io/workflows/1943-comparing-data-with-the-compare-datasets-node/){:target=_blank .external-link} for an example. + +[[ workflowDemo("https://api.n8n.io/workflows/templates/1943") ]] + +# flow-logic/splitting.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Split workflows into multiple paths using If and Switch +contentType: howto +--- + +# Splitting workflows with conditional nodes + +Splitting uses the [IF](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) or [Switch](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md) nodes. It turns a single-branch workflow into a multi-branch workflow. This is a key piece of representing complex logic in n8n. + +Compare these workflows: + +!["Diagram representing two workflows. One has three steps and follows a linear process, with a user submitting a bug, and the workflow emailing a support team. The second workflow starts the same way, but then splits depending on whether the user marked the issue as urgent. It then splits again depending on the user's support plan"](/_images/flow-logic/splitting/single-multi-branch-workflow.png) + +This is the power of splitting and conditional nodes in n8n. + +Refer to the [IF](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) or [Switch](/integrations/builtin/core-nodes/n8n-nodes-base.switch.md) documentation for usage details. + + +# flow-logic/subworkflows.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +description: Call workflows from other workflows, and split large workflows into smaller components. +--- + +# Sub-workflows + +You 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](/hosting/scaling/memory-errors.md). Creating sub-workflows uses the [Execute Workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) and [Execute Sub-workflow Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md) nodes. + +## Set up and use a sub-workflow + +This section walks through setting up both the parent workflow and sub-workflow. + +--8<-- "_snippets/flow-logic/subworkflow-usage.md" + +## How data passes between workflows + +--8<-- "_snippets/flow-logic/subworkflow-data-flow.md" + + +# flow-logic/waiting.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Waiting +description: How to make your workflow execution wait. +contentType: howto +--- + +# Waiting + +Waiting 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. + +Making a workflow wait uses the [Wait](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md) node. Refer to the node documentation for usage details. + +n8n 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/){:target=_blank .external-link}. diff --git a/llms/help-community.md b/llms/help-community.md new file mode 100644 index 00000000000..01a6fbce4d7 --- /dev/null +++ b/llms/help-community.md @@ -0,0 +1,125 @@ + + +# help-community/contributing.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Learn how to contribute to n8n. +contentType: howto +--- + +# How can you contribute? + +There are a several ways in which you can contribute to n8n, depending on your skills and interests. Each form of contribution is valuable to us! + +## Share some love: Review us + +- Star n8n on [GitHub](https://github.com/n8n-io/n8n){:target=_blank class=.external-link} and [Docker Hub](https://hub.docker.com/r/n8nio/n8n){:target=_blank class=.external-link}. +- Follow us on [Twitter](https://twitter.com/n8n_io){:target=_blank class=.external-link}, [LinkedIn](https://www.linkedin.com/company/28491094), and [Facebook](https://www.facebook.com/n8nio/){:target=_blank class=.external-link}. +- Upvote n8n on [AlternativeTo](https://alternativeto.net/software/n8n-io/){:target=_blank class=.external-link} and [Alternative.me](https://alternative.me/n8n-io){:target=_blank class=.external-link}. +- Add n8n to your stack on [Stackshare](https://stackshare.io/n8n){:target=_blank class=.external-link}. +- Write a review about n8n on [G2](https://www.g2.com/products/n8n/reviews){:target=_blank class=.external-link}, [Slant](https://www.slant.co/improve/options/37977/~n8n-review){:target=_blank class=.external-link}, and [Capterra](https://www.capterra.com/p/198028/n8n-io/){:target=_blank class=.external-link}. + +## Help out the community + +You can participate in the [forum](https://community.n8n.io/){:target=_blank class=.external-link} and help the community members out with their questions. + +When sharing workflows in the community forum for debugging, use code blocks. Use triple backticks ` ``` ` to wrap the workflow JSON in a code block. + +The following video demonstrates the steps of sharing workflows on the community forum: + +
+ + + +
+ +## Contribute a workflow template + +--8<-- "_snippets/workflows/templates/submit-templates.md" + +## Build a node + +Create an integration for a third party service. Check out [the node creation docs](/integrations/creating-nodes/overview.md) for guidance on how to create and publish a community node. + +## Contribute to the code + +There are different ways in which you can contribute to the n8n code base: + +- Fix [issues](https://github.com/n8n-io/n8n/issues){:target=_blank class=.external-link} reported on GitHub. The [CONTRIBUTING guide](https://github.com/n8n-io/n8n/blob/master/CONTRIBUTING.md){:target=_blank class=.external-link} will help you get your development environment ready in minutes. +- Add additional functionality to an existing third party integration. +- Add a new feature to n8n. + +## Contribute to the docs + +You can contribute to the n8n documentation, for example by documenting nodes or fixing issues. + +The repository for the docs is [here](https://github.com/n8n-io/n8n-docs){:target=_blank class=.external-link} and the guidelines for contributing to the docs are [here](https://github.com/n8n-io/n8n-docs/blob/master/CONTRIBUTING.md){:target=_blank class=.external-link}. + +## Contribute to the blog + +You can write an article for the [n8n blog](https://blog.n8n.io/){:target=_blank class=.external-link}. Your article can be, for example, a [workflow tutorial](https://blog.n8n.io/tag/tutorial/){:target=_blank class=.external-link}, an opinion piece on automation, or some domain-specific [automation guides](https://blog.n8n.io/tag/guide/){:target=_blank class=.external-link}. + +### How to submit a post + +n8n appreciates all contributions. Publishing a tutorial on your own site that supports the community is a great contribution. If you want n8n to highlight your post on the blog, follow these steps: + +1. Email your idea to [marketing@n8n.io](mailto:marketing@n8n.io) with the subject "Blog contribution: [Your Topic]." +2. Submit your draft: + - Write your post in a Google Doc following the [style guide](https://www.notion.so/97dc73436a624933b75ddc941a361b70?pvs=21){:target=_blank class=.external-link}. + - If your blog post includes example workflows, include the workflow JSON in a separate section at the end. + - For author credit, provide a second Google Doc with your full name, a short byline, and your image. n8n will use this to create your author page and credit you as the author of the post. +3. Wait for feedback. We will respond if your draft fits with the blog's strategy and requirements. If you don't hear back within 30 days, it means we won't be moving forward with your blog post. + +## Refer a candidate + +Do you know someone who would be a great fit for one of our [open positions](https://n8n.io/careers){:target=_blank class=.external-link}? Refer them to us! In return, we'll pay you €1,000 when the referral successfully passes their probationary period. + +Here's how this works: + +1. **Search**: Have a look at the description and requirements of each role, and consider if someone you know would be a great fit. +2. **Referral**: Once you've identified a potential candidate, send an email to [Jobs at n8n](mailto:jobs@n8n.io) with the subject line *Employee referral - [job title]* and a short description of the person you're referring (and the reason why). Also, tell your referral to apply for the job through our [careers page](https://n8n.io/careers){:target=_blank class=.external-link}. +3. **Evaluation**: We'll screen the application and inform you about the next steps of the hiring process. +4. **Reward**: As soon as your referral has successfully finished the probationary period, we'll reward you for your efforts by transferring the €1,000 to your bank account. + + +# help-community/help.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: How to get help and support with n8n. +contentType: howto +hide: + - toc +--- + +# Get help with n8n + +If you need more help with n8n, you can ask for support in the [forum](https://community.n8n.io/){:target=_blank class=.external-link}. This is the best source of answers, as both the n8n support team and community members can help. + +If your Cloud instance is having issues, or if you're an enterprise customer who needs support, you can contact [help@n8n.io](mailto:help@n8n.io). + +## Use the About n8n debug tool + +Whether you're posting to the forum or emailing customer support, you'll get help faster if you provide details about your n8n instance in your first post or email. + +The fastest way to do this is to use the **About n8n** debug tool: + +1. Open the left-side panel. +2. Select **Help**. +3. Select **About n8n**. +4. The **About n8n** modal opens to display your current information. +5. Select **Copy debug information** to copy your information. +6. n8n recommends pasting this information into your forum post or support email. + +/// note | Don't see **Copy debug**? +The **Copy debug** option is available beginning in n8n version 1.49.0. + +If you're using an earlier version of n8n, n8n recommends manually providing this information: + +* n8n version +* Database +* n8n EXECUTIONS_PROCESS setting +* Running n8n via (Docker, npm, n8n cloud) +* Operating system +/// diff --git a/llms/hosting.md b/llms/hosting.md new file mode 100644 index 00000000000..caf9a2af4ea --- /dev/null +++ b/llms/hosting.md @@ -0,0 +1,4678 @@ + + +# hosting/architecture/database-structure.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Understand the n8n database structure +contentType: explanation +--- + +# Database structure + +This page describes the purpose of each table in the n8n database. + +## Database and query technology + +By default, n8n uses SQLite as the database. If you are using another database the structure will be similar, but the data-types may be different depending on the database. + +n8n uses [TypeORM](https://github.com/typeorm/typeorm){:target=_blank .external-link} for queries and migrations. + +To inspect the n8n database, you can use [DBeaver](https://dbeaver.io){:target=_blank .external-link}, which is an open-source universal database tool. + +## Tables + +These are the tables n8n creates during setup. + +### auth_identity + +Stores details of external authentication providers when using [SAML](/user-management/saml/index.md). + +### auth_provider_sync_history + +Stores the history of a SAML connection. + +### credentials_entity + +Stores the [credentials](/glossary.md#credential-n8n) used to authenticate with integrations. + +### event_destinations + +Contains the destination configurations for [Log streaming](/log-streaming.md). + +### execution_data + +Contains the workflow at time of running, and the execution data. + +### execution_entity + +Stores all saved workflow executions. Workflow settings can affect which executions n8n saves. + +### execution_metadata + +Stores [Custom executions data](/workflows/executions/custom-executions-data.md). + +### installed_nodes + +Lists the [community nodes](/integrations/community-nodes/installation/index.md) installed in your n8n instance. + +### installed_packages + +Details of npm community nodes packages installed in your n8n instance. [installed_nodes](#installed_nodes) lists each individual node. `installed_packages` lists npm packages, which may contain more than one node. + +### migrations + +A log of all database migrations. Read more about [Migrations](https://github.com/typeorm/typeorm/blob/master/docs/migrations.md){:target=_blank .external-link} in TypeORM's documentation. + +### project + +Lists the [projects](/user-management/rbac/projects.md) in your instance. + +### project_relation + +Describes the relationship between a user and a [project](/user-management/rbac/projects.md), including the user's [role type](/user-management/rbac/role-types.md). + +### role + +Not currently used. Foruse in future work on custom roles. + +### settings + +Records custom instance settings. These are settings that you can't control using environment variables. They include: + +* Whether the instance owner is set up +* Whether the user chose to skip owner and user management setup +* License key + +### shared_credentials + +Maps credentials to users. + +### shared_workflow + +Maps workflows to users. + +### tag_entity + +All workflow tags created in the n8n instance. This table lists the tags. [workflows_tags](#workflows_tags) records which workflows have which tags. + +### user + +Contains user data. + +### variables + +Store [variables](/code/variables.md). + +### webhook_entity + +Records the active webhooks in your n8n instance's workflows. This isn't just webhooks uses in the Webhook node. It includes all active webhooks used by any trigger node. + +### workflow_entity + +Your n8n instance's saved workflows. + +### workflow_history + +Store previous versions of workflows. + +### workflow_statistics + +Counts workflow IDs and their status. + +### workflows_tags + +Maps tags to workflows. [tag_entity](#tag_entity) contains tag details. + +## Entity Relationship Diagram (ERD) + +!["n8n ERD"](/_images/hosting/architecture/n8n-database-diagram.png) + + + + +# hosting/architecture/overview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Understand n8n's architecture +contentType: overview +--- + +# Architecture + +Understanding n8n's underlying architecture is helpful if you need to: + +* Embed n8n +* Customize n8n's default databases + +This section is a work in progress. If you have questions, please try the [forum](https://community.n8n.io/){:target=_blank .external-link} and let n8n know which architecture documents would be useful for you. + + +# hosting/cli-commands.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: CLI commands available in n8n. +contentType: reference +--- + +# CLI commands for n8n + +n8n includes a CLI (command line interface), allowing you to perform actions using the CLI rather than the n8n editor. These include starting workflows, and exporting and importing workflows and credentials. + +## Running CLI commands + +You can use CLI commands with self-hosted n8n. Depending on how you choose to install n8n, there are differences in how to run the commands: + +* npm: the `n8n` command is directly available. The documentation uses this in the examples below. +* Docker: the `n8n` command is available within your Docker container: + + ```sh + docker exec -u node -it + ``` + +## Start a workflow + +You can start workflows directly using the CLI. + +Execute a saved workflow by its ID: + +```bash +n8n execute --id +``` + +## Change the active status of a workflow + +You can change the active status of a workflow using the CLI. + +/// note | Restart required +These commands operate on your n8n database. If you execute them while n8n is running, the changes don't take effect until you restart n8n. +/// + +Set the active status of a workflow by its ID to false: + +```bash +n8n update:workflow --id= --active=false +``` + +Set the active status of a workflow by its ID to true: + +```bash +n8n update:workflow --id= --active=true +``` + +Set the active status to false for all the workflows: + +```bash +n8n update:workflow --all --active=false +``` + +Set the active status to true for all the workflows: + +```bash +n8n update:workflow --all --active=true +``` + +## Export workflows and credentials + +You can export your workflows and credentials from n8n using the CLI. + +Command flags: + +| Flag | Description | +|-------------|-------| +| --help | Help prompt. | +| --all | Exports all workflows/credentials. | +| --backup | Sets --all --pretty --separate for backups. You can optionally set --output. | +| --id | The ID of the workflow to export. | +| --output | Outputs file name or directory if using separate files. | +| --pretty | Formats the output in an easier to read fashion. | +| --separate | Exports one file per workflow (useful for versioning). Must set a directory using --output. | +| --decrypted | Exports the credentials in a plain text format. | + +### Workflows + +Export all your workflows to the standard output (terminal): + +```bash +n8n export:workflow --all +``` + +Export a workflow by its ID and specify the output file name: + +```bash +n8n export:workflow --id= --output=file.json +``` + +Export all workflows to a specific directory in a single file: + +```bash +n8n export:workflow --all --output=backups/latest/file.json +``` + +Export all the workflows to a specific directory using the `--backup` flag (details above): + +```bash +n8n export:workflow --backup --output=backups/latest/ +``` + +### Credentials + +Export all your credentials to the standard output (terminal): + +```bash +n8n export:credentials --all +``` + +Export credentials by their ID and specify the output file name: + +```bash +n8n export:credentials --id= --output=file.json +``` + +Export all credentials to a specific directory in a single file: + +```bash +n8n export:credentials --all --output=backups/latest/file.json +``` + +Export all the credentials to a specific directory using the `--backup` flag (details above): + +```bash +n8n export:credentials --backup --output=backups/latest/ +``` + +Export all the credentials in plain text format. You can use this to migrate from one installation to another that has a different secret key in the configuration file. + +/// warning | Sensitive information +All sensitive information is visible in the files. +/// + +```bash +n8n export:credentials --all --decrypted --output=backups/decrypted.json +``` + +## Import workflows and credentials + +You can import your workflows and credentials from n8n using the CLI. + +/// warning | Update the IDs +When exporting workflows and credentials, n8n also exports their IDs. If you have workflows and credentials with the same IDs in your existing database, they will be overwritten. To avoid this, delete or change the IDs before importing. +/// + +Available flags: + +| Flag | Description | +|------|-------------| +| --help | Help prompt. | +| --input | Input file name or directory if you use --separate. | +| --projectId | Import the workflow or credential to the specified project. Can't be used with `--userId`. | +| --separate | Imports `*.json` files from directory provided by --input. | +| --userId | Import the workflow or credential to the specified user. Can't be used with `--projectId`. | + +/// note | Migrating to SQLite +n8n limits workflow and credential names to 128 characters, but SQLite doesn't enforce size limits. + +This might result in errors like **Data too long for column name** during the import process. + +In this case, you can edit the names from the n8n interface and export again, or edit the JSON file directly before importing. +/// + +### Workflows + +Import workflows from a specific file: + +```bash +n8n import:workflow --input=file.json +``` + +Import all the workflow files as JSON from the specified directory: + +```bash +n8n import:workflow --separate --input=backups/latest/ +``` + +### Credentials + +Import credentials from a specific file: + +```bash +n8n import:credentials --input=file.json +``` + +Import all the credentials files as JSON from the specified directory: + +```bash +n8n import:credentials --separate --input=backups/latest/ +``` + +## License + +### Clear + +Clear your existing license from n8n's database and reset n8n to default features: + +```sh +n8n license:clear +``` + +If your license includes [floating entitlements](/glossary.md#entitlement-n8n), running this command will also attempt to release them back to the pool, making them available for other instances. + +### Info + +Display information about the existing license: + +```sh +n8n license:info +``` + +## User management + +You can reset user management using the n8n CLI. This returns user management to its pre-setup state. It removes all user accounts. + +Use this if you forget your password, and don't have SMTP set up to do password resets by email. + +```sh +n8n user-management:reset +``` + +### Disable MFA for a user + +If a user loses their recovery codes you can disable MFA for a user with this command. The user will then be able to log back in to set up MFA again. + +```sh +n8n mfa:disable --email=johndoe@example.com +``` + +### Disable LDAP + +You can reset the LDAP settings using the command below. + +```sh +n8n ldap:reset +``` + +## Security audit + +You can run a [security audit](/hosting/securing/security-audit.md) on your n8n instance, to detect common security issues. + +```sh +n8n audit +``` + + +# hosting/community-edition-features.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Community edition features +description: Differences in available features between the Community edition and other paid plans. +contentType: explanation +tags: + - Community edition + - Enterprise edition +hide: + - tags +--- + +# Community Edition Features + +The community edition includes almost the complete feature set of n8n, except for the features listed here. + +The community edition doesn't include these features: + +- [Custom Variables](/code/variables.md) +- [Environments](/source-control-environments/index.md) +- [External secrets](/external-secrets.md) +- [External storage for binary data](/hosting/scaling/external-storage.md) +- [Log streaming](/log-streaming.md) ([Logging](/hosting/logging-monitoring/logging.md) _is_ included) +- [Multi-main mode](/hosting/scaling/queue-mode.md#multi-main-setup) ([Queue mode](/hosting/scaling/queue-mode.md) _is_ included) +- [Projects](/user-management/rbac/projects.md) +- SSO ([SAML](/hosting/securing/set-up-sso.md), [LDAP](/user-management/ldap.md)) +- Sharing ([workflows](/workflows/sharing.md), [credentials](/credentials/credential-sharing.md)) (Only the instance owner and the user who creates them can access workflows and credentials) +- [Version control using Git](/source-control-environments/index.md) +- [Workflow history](/workflows/history.md) (You can get one day of workflow history with the community edition by [registering](#registered-community-edition)) + +These features are available on the Enterprise Cloud plan, including the self-hosted Enterprise edition. Some of these features are available on the Starter and Pro Cloud plan. + +See [pricing](https://n8n.io/pricing/){:target=_blank .external-link} for reference. + +## Registered Community Edition + +You can unlock extra features by registering your n8n community edition. You register with your email and receive a license key. + +Registering unlocks these features for the community edition: + +* [Folders](/release-notes.md#folders): Organize your workflows into tidy folders +* [Debug in editor](/workflows/executions/debug.md): Copy and [pin](/glossary.md#data-pinning-n8n) execution data when working on a workflow +* One day of [workflow history](/workflows/history.md): 24 hours of workflow history so you can revert back to previous workflow versions +* [Custom execution data](/workflows/executions/custom-executions-data.md): Save, find, and annotate execution metadata + +To register a new community edition instance, select the option during your initial account creation. + +To register an existing community edition instance: + +1. Select the **three dots icon** ![three dots icon](/_images/common-icons/three-dots-horizontal.png){.off-glb} in the lower-left corner. +1. Select **Settings** and then **Usage and plan**. +1. Select **Unlock** to enter your email and then select **Send me a free license key**. +1. Check your email for the account you entered. + +Once you have a license key, activate it by clicking the button in the license email or by visiting **Options > Settings > Usage and plan** and selecting **Enter activation key**. + +Once activated, your license will not expire. We may change the unlocked features in the future. This will not impact previously unlocked features. + + +# hosting/configuration/configuration-examples/base-url.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Configure the Base URL for n8n's front end access +description: Configure the Base URL environment variable to define the front end's access path to the back end's REST API for n8n. +contentType: howto +--- + +# Configure the Base URL for n8n's front end access + +/// warning | Requires manual UI build +This use case involves configuring the `VUE_APP_URL_BASE_API` environmental variable which requires a manual build of the `n8n-editor-ui` package. You can't use it with the default n8n Docker image where the default setting for this variable is `/`, meaning that it uses the root-domain. +/// + +You can configure the Base URL that the front end uses to connect to the back end's REST API. This is relevant when you want to host n8n's front end and back end separately. + +```bash +export VUE_APP_URL_BASE_API=https://n8n.example.com/ +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on this variable. + + +# hosting/configuration/configuration-examples/custom-certificate-authority.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Configure n8n to use your own certificate authority +description: Customize the n8n container to work with self signed certificates when connecting to services. +contentType: howto +--- + +# Configure n8n to use your own certificate authority or self-signed certificate + +You can add your own certificate authority (CA) or self-signed certificate to n8n. This means you are able to trust a certain SSL certificate instead of trusting all invalid certificates, which is a potential security risk. + +/// note | Available in version 1.42.0 +This feature is only available in version 1.42.0+. +/// + +To use this feature you need to place your certificates in a folder and mount the folder to `/opt/custom-certificates` in the container. + +## Docker + +The examples below assume you have a folder called `pki` that contains your certificates in either the directory you run the command from or next to your docker compose file. + +### Docker CLI +When using the CLI you can use the `-v` flag from the command line: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -v ./pki:/opt/custom-certificates \ + docker.n8n.io/n8nio/n8n +``` + +### Docker Compose + +```yaml +name: n8n +services: + n8n: + volumes: + - ./pki:/opt/custom-certificates + container_name: n8n + ports: + - 5678:5678 + image: docker.n8n.io/n8nio/n8n +``` + +You should also give the right permissions to the imported certs. You can do this once the container is running (assuming n8n as the container name): + +```bash +docker exec --user 0 n8n chown -R 1000:1000 /opt/custom-certificates +``` + + +# hosting/configuration/configuration-examples/custom-nodes-location.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Specify location for your custom nodes +description: Add folders and specify paths for your custom nodes. +contentType: howto +--- + +# Specify location for your custom nodes + +Every user can add custom nodes that get loaded by n8n on startup. The default +location is in the subfolder `.n8n/custom` of the user who started n8n. + +You can define more folders with an environment variable: + +```bash +export N8N_CUSTOM_EXTENSIONS="/home/jim/n8n/custom-nodes;/data/n8n/nodes" +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/nodes.md) for more information on this variable. + + +# hosting/configuration/configuration-examples/encryption-key.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Set a custom encryption key +description: Set a custom encryption key for n8n to securely encrypt credentials. +contentType: howto +--- + +# Set a custom encryption key + +n8n creates a random encryption key automatically on the first launch and saves +it in the `~/.n8n` folder. n8n uses that key to encrypt the credentials before +they get saved to the database. If the key isn't yet in the settings file, +you can set it using an environment variable, so that n8n +uses your custom key instead of generating a new one. + +In [queue mode](/hosting/scaling/queue-mode.md), you must specify the encryption key environment variable for all workers. + +```bash +export N8N_ENCRYPTION_KEY= +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on this variable. + + +# hosting/configuration/configuration-examples/execution-timeout.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Configure workflow timeout settings +description: Set execution timeouts to determine how long workflows can run. +contentType: howto +--- + +# Configure workflow timeout settings + +A workflow times out and gets canceled after this time (in seconds). If the workflow runs in the main process, a soft timeout happens (takes effect after the current node finishes). If a workflow runs in its own process, n8n attempts a soft timeout first, then kills the process after waiting for a fifth of the given timeout duration. + +`EXECUTIONS_TIMEOUT` default is `-1`. For example, if you want to set the timeout to one hour: + +```bash +export EXECUTIONS_TIMEOUT=3600 +``` + +You can also set maximum execution time (in seconds) for each workflow individually. For example, if you want to set maximum execution time to two hours: + +```bash +export EXECUTIONS_TIMEOUT_MAX=7200 +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/executions.md) for more information on these variables. + + +# hosting/configuration/configuration-examples/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Configuration examples +description: An overview containing different configuration examples. +contentType: overview +--- + +# Configuration examples + +This section contains examples for how to configure n8n to solve particular use cases. + +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + + +# hosting/configuration/configuration-examples/isolation.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Isolate n8n +description: Prevent your n8n instance from connecting with n8n's servers. +contentType: howto +--- + +# Isolate n8n + +By default, a self-hosted n8n instance sends data to n8n's servers. It notifies users about available updates, workflow templates, and diagnostics. + +To prevent your n8n instance from connecting to n8n's servers, set these environment variables to false: + +``` +N8N_DIAGNOSTICS_ENABLED=false +N8N_VERSION_NOTIFICATIONS_ENABLED=false +N8N_TEMPLATES_ENABLED=false +``` + +Unset n8n's diagnostics configuration: + +``` +EXTERNAL_FRONTEND_HOOKS_URLS= +N8N_DIAGNOSTICS_CONFIG_FRONTEND= +N8N_DIAGNOSTICS_CONFIG_BACKEND= +``` + +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on these variables. + + +# hosting/configuration/configuration-examples/modules-in-code-node.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Enable modules in Code node +description: Allow the use of both built-in and external modules within the Code node. +contentType: howto +--- + +# Enable modules in Code node + +For security reasons, the Code node restricts importing modules. It's possible to lift that restriction for built-in and external modules by setting the following environment variables: + +- `NODE_FUNCTION_ALLOW_BUILTIN`: For built-in modules +- `NODE_FUNCTION_ALLOW_EXTERNAL`: For external modules sourced from n8n/node_modules directory. External module support is disabled when an environment variable isn't set. + +```bash +# Allows usage of all builtin modules +export NODE_FUNCTION_ALLOW_BUILTIN=* + +# Allows usage of only crypto +export NODE_FUNCTION_ALLOW_BUILTIN=crypto + +# Allows usage of only crypto and fs +export NODE_FUNCTION_ALLOW_BUILTIN=crypto,fs + +# Allow usage of external npm modules. +export NODE_FUNCTION_ALLOW_EXTERNAL=moment,lodash +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/nodes.md) for more information on these variables. + + +# hosting/configuration/configuration-examples/prometheus.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Enable Prometheus metrics +description: Enable Prometheus metrics endpoint. +contentType: howto +--- + +# Enable Prometheus metrics + +To collect and expose metrics, n8n uses the [prom-client](https://www.npmjs.com/package/prom-client){:target="_blank" .external-link} library. + +The `/metrics` endpoint is disabled by default, but it's possible to enable it using the `N8N_METRICS` environment variable. + +```bash +export N8N_METRICS=true +``` + +Refer to the respective [Environment Variables](/hosting/configuration/environment-variables/endpoints.md) (`N8N_METRICS_INCLUDE_*`) for configuring which metrics and labels should get exposed. + +Both `main` and `worker` instances are able to expose metrics. + +## Queue metrics + +To enable queue metrics, set the `N8N_METRICS_INCLUDE_QUEUE_METRICS` env var to `true`. You can adjust the refresh rate with `N8N_METRICS_QUEUE_METRICS_INTERVAL`. + +Queue metrics are only available for the `main` instance in single-main mode. + +``` +# HELP n8n_scaling_mode_queue_jobs_active Current number of jobs being processed across all workers in scaling mode. +# TYPE n8n_scaling_mode_queue_jobs_active gauge +n8n_scaling_mode_queue_jobs_active 0 + +# HELP n8n_scaling_mode_queue_jobs_completed Total number of jobs completed across all workers in scaling mode since instance start. +# TYPE n8n_scaling_mode_queue_jobs_completed counter +n8n_scaling_mode_queue_jobs_completed 0 + +# HELP n8n_scaling_mode_queue_jobs_failed Total number of jobs failed across all workers in scaling mode since instance start. +# TYPE n8n_scaling_mode_queue_jobs_failed counter +n8n_scaling_mode_queue_jobs_failed 0 + +# HELP n8n_scaling_mode_queue_jobs_waiting Current number of enqueued jobs waiting for pickup in scaling mode. +# TYPE n8n_scaling_mode_queue_jobs_waiting gauge +n8n_scaling_mode_queue_jobs_waiting 0 +``` + + +# hosting/configuration/configuration-examples/time-zone.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Set the self-hosted instance timezone +description: Change the default timezone for your self-hosted n8n instance. +contentType: howto +--- + +# Set the self-hosted instance timezone + +The default timezone is America/New_York. For instance, the Schedule node uses it to know at what time the workflow should start. To set a different default timezone, set `GENERIC_TIMEZONE` to the appropriate value. For example, if you want to set the timezone to Berlin (Germany): + +```bash +export GENERIC_TIMEZONE=Europe/Berlin +``` + +You can find the name of your timezone [here](https://momentjs.com/timezone/){:target="_blank" .external-link}. + +Refer to [Environment variables reference](/hosting/configuration/environment-variables/timezone-localization.md) for more information on this variable. + + +# hosting/configuration/configuration-examples/user-folder.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Specify user folder path +description: Specify location of the folder that stores user-specific data. +contentType: howto +--- + +# Specify user folder path + +n8n saves user-specific data like the encryption key, SQLite database file, and +the ID of the tunnel (if used) in the subfolder `.n8n` of the user who started n8n. It's possible to overwrite the user-folder using an environment variable. + +```bash +export N8N_USER_FOLDER=/home/jim/n8n +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment.md) for more information on this variable. + + +# hosting/configuration/configuration-examples/webhook-url.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Configure webhook URLs with reverse proxy +description: Customize n8n webhook URLs for compatibility with reverse proxy setups. +contentType: howto +--- + +# Configure n8n webhooks with reverse proxy + +n8n creates the webhook URL by combining `N8N_PROTOCOL`, `N8N_HOST` and `N8N_PORT`. If n8n runs behind a reverse proxy, that won't work. That's because n8n runs internally on port 5678 but the reverse proxy exposes it to the web on port 443. In that case, it's important to set the webhook URL manually so that n8n can display it in the Editor UI and register the correct webhook URLs with external services. + +```bash +export WEBHOOK_URL=https://n8n.example.com/ +``` +Refer to [Environment variables reference](/hosting/configuration/environment-variables/endpoints.md) for more information on this variable. + + +# hosting/configuration/configuration-methods.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Configuration methods +description: How to set environment variables for n8n. +contentType: howto +--- + +# Configuration + +You can change n8n's settings using environment variables. For a full list of available configurations see [Environment Variables](/hosting/configuration/environment-variables/index.md). + +## Set environment variables by command line + +### npm + +For npm, set your desired environment variables in terminal using the `export` command as shown below: + +```bash +export = +``` + +### Docker + +In Docker you can use the `-e` flag from the command line: + +```bash +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -e N8N_TEMPLATES_ENABLED="false" \ + docker.n8n.io/n8nio/n8n +``` + +## Set environment variables using a file + +You can also configure n8n using a configuration file. + +Only define the values that need to be different from the default in your configuration file. You can use multiple files. For example, you can have a file with generic base settings, and files with specific values for different environments. + +### npm + +Set the path to the JSON configuration file using the environment variable `N8N_CONFIG_FILES`: + +```shell +# Bash - Single file +export N8N_CONFIG_FILES=//my-config.json +# Bash - Multiple files are comma-separated +export N8N_CONFIG_FILES=//my-config.json,//production.json + +# PowerShell - Single file, persist for current user +# Note that setting scope (Process, User, Machine) has no effect on Unix systems +[Environment]::SetEnvironmentVariable('N8N_CONFIG_FILES', '\config.json', 'User') +``` + +Example file: + +```json +{ + "executions": { + "saveDataOnSuccess": "none" + }, + "generic": { + "timezone": "Europe/Berlin" + }, + "nodes": { + "exclude": "[\"n8n-nodes-base.executeCommand\",\"n8n-nodes-base.writeBinaryFile\"]" + } +} +``` + +/// note | Formatting as JSON +You can't always work out the correct JSON from the [Environment variables reference](/hosting/configuration/environment-variables/index.md). For example, to set `N8N_METRICS` to `true`, you need to do: + +```json +{ + "endpoints": { + "metrics": { + "enable": true + } + } +} +``` + +Refer to the [Schema file in the source code](https://github.com/n8n-io/n8n/blob/master/packages/cli/src/config/schema.ts){:target=_blank .external-link} for full details of the expected settings. +/// + + +### Docker + +In Docker, you can set your environment variables in the `n8n: environment:` element of your `docker-compose.yaml` file. + +For example: + +```yaml +n8n: + environment: + - N8N_TEMPLATES_ENABLED=false +``` + +### Keeping sensitive data in separate files + +You can append `_FILE` to individual environment variables to provide their configuration in a separate file, enabling you to avoid passing sensitive details using environment variables. n8n loads the data from the file with the given name, making it possible to load data from [Docker-Secrets](https://docs.docker.com/engine/swarm/secrets/){:target=_blank .external-link} and [Kubernetes-Secrets](https://kubernetes.io/docs/concepts/configuration/secret/){:target=_blank .external-link}. + +Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for details on each variable. + +While most environment variables can use the `_FILE` suffix, it's more beneficial for sensitive data such as [credentials](/glossary.md#credential-n8n) and database configuration. Here are some examples: + +```yaml +CREDENTIALS_OVERWRITE_DATA_FILE=/path/to/credentials_data +DB_TYPE_FILE=/path/to/db_type +DB_POSTGRESDB_DATABASE_FILE=/path/to/database_name +DB_POSTGRESDB_HOST_FILE=/path/to/database_host +DB_POSTGRESDB_PORT_FILE=/path/to/database_port +DB_POSTGRESDB_USER_FILE=/path/to/database_user +DB_POSTGRESDB_PASSWORD_FILE=/path/to/database_password +DB_POSTGRESDB_SCHEMA_FILE=/path/to/database_schema +DB_POSTGRESDB_SSL_CA_FILE=/path/to/ssl_ca +DB_POSTGRESDB_SSL_CERT_FILE=/path/to/ssl_cert +DB_POSTGRESDB_SSL_KEY_FILE=/path/to/ssl_key +DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED_FILE=/path/to/ssl_reject_unauth +``` + + +# hosting/configuration/environment-variables/binary-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Binary data environment variables +description: Customize binary data storage modes and paths with environment variables for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Binary data environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +By default, n8n uses memory to store binary data. Enterprise users can choose to use an external service instead. Refer to [External storage](/hosting/scaling/external-storage.md) for more information on using external storage for binary data. + + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_AVAILABLE_BINARY_DATA_MODES` | String | `filesystem` | A comma separated list of available binary data modes. | +| `N8N_BINARY_DATA_STORAGE_PATH` | String | `N8N_USER_FOLDER/binaryData` | The path where n8n stores binary data. | +| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem, or `s3` to AWS S3. Note that binary data pruning operates on the active binary data mode. For example, if your instance stored data in S3, and you later switched to filesystem mode, n8n only prunes binary data in the filesystem. This may change in future. | + + +# hosting/configuration/environment-variables/credentials.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Credentials environment variables +description: Manage default credentials and override them through environment variables your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Credentials environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +Enable credential overwrites using the following environment variables. Refer to [Credential overwrites](/embed/configuration.md#credential-overwrites) for details. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `CREDENTIALS_OVERWRITE_DATA`
/`_FILE` | * | - | Overwrites for credentials. | +| `CREDENTIALS_OVERWRITE_ENDPOINT` | String | - | The API endpoint to fetch credentials. | +| `CREDENTIALS_DEFAULT_NAME` | String | `My credentials` | The default name for credentials. | + + +# hosting/configuration/environment-variables/database.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Database environment variables +description: Set up and configure databases with environment variables for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Database environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +By default, n8n uses SQLite. n8n also supports PostgreSQL. n8n [removed support for MySQL and MariaDB](/1-0-migration-checklist.md#mysql-and-mariadb) in v1.0. + +This page outlines environment variables to configure your chosen database for your self-hosted n8n instance. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `DB_TYPE`
/`_FILE` | Enum string:
`sqlite`, `postgresdb` | `sqlite` | The database to use. | +| `DB_TABLE_PREFIX` | * | - | Prefix to use for table names. | + +## PostgreSQL + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `DB_POSTGRESDB_DATABASE`
/`_FILE` | String | `n8n` | The name of the PostgreSQL database. | +| `DB_POSTGRESDB_HOST`
/`_FILE` | String | `localhost` | The PostgreSQL host. | +| `DB_POSTGRESDB_PORT`
/`_FILE` | Number | `5432` | The PostgreSQL port. | +| `DB_POSTGRESDB_USER`
/`_FILE` | String | `postgres` | The PostgreSQL user. | +| `DB_POSTGRESDB_PASSWORD`
/`_FILE` | String | - | The PostgreSQL password. | +| `DB_POSTGRESDB_POOL_SIZE`
/`_FILE` | Number | `2` | Control how many parallel open Postgres connections n8n should have. Increasing it may help with resource utilization, but too many connections may degrade performance. | +| `DB_POSTGRESDB_CONNECTION_TIMEOUT`
/`_FILE` | Number | `20000` | Postgres connection timeout (ms). +| `DB_POSTGRESDB_SCHEMA`
/`_FILE` | String | `public` | The PostgreSQL schema. | +| `DB_POSTGRESDB_SSL_ENABLED`
/`_FILE` | Boolean | `false` | Whether to enable SSL. Automatically enabled if `DB_POSTGRESDB_SSL_CA`, `DB_POSTGRESDB_SSL_CERT` or `DB_POSTGRESDB_SSL_KEY` is defined. | +| `DB_POSTGRESDB_SSL_CA`
/`_FILE` | String | - | The PostgreSQL SSL certificate authority. | +| `DB_POSTGRESDB_SSL_CERT`
/`_FILE` | String | - | The PostgreSQL SSL certificate. | +| `DB_POSTGRESDB_SSL_KEY`
/`_FILE` | String | - | The PostgreSQL SSL key. | +| `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED`
/`_FILE` | Boolean | `true` | If n8n should reject unauthorized SSL connections (true) or not (false). | + +## SQLite + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `DB_SQLITE_POOL_SIZE` | Number | `0` | Controls whether to open the SQLite file in [WAL mode](https://www.sqlite.org/wal.html) or [rollback journal mode](https://www.sqlite.org/lockingv3.html#rollback). Uses rollback journal mode when set to zero. When greater than zero, uses WAL mode with the value determining the number of parallel SQL read connections to configure. WAL mode is much more performant and reliable than the rollback journal mode. | +| `DB_SQLITE_VACUUM_ON_STARTUP` | Boolean | `false` | Runs [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target="_blank" .external-link} operation on startup to rebuild the database. Reduces file size and optimizes indexes. This is a long running blocking operation and increases start-up time. | + + +# hosting/configuration/environment-variables/deployment.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Deployment environment variables +description: Configure deployment options and application accessibility with environment variables for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Deployment environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +This page lists the deployment configuration options for your self-hosted n8n instance, including setting up access URLs, enabling templates, customizing encryption, and configuring server details. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_EDITOR_BASE_URL` | String | - | Public URL where users can access the editor. Also used for emails sent from n8n and the redirect URL for SAML based authentication. | +| `N8N_CONFIG_FILES` | String | - | Use to provide the path to any JSON [configuration file](/hosting/configuration/configuration-methods.md). | +| `N8N_DISABLE_UI` | Boolean | `false` | Set to `true` to disable the UI. | +| `N8N_PREVIEW_MODE` | Boolean | `false` | Set to `true` to run in preview mode. | +| `N8N_TEMPLATES_ENABLED` | Boolean | `false` | Enables [workflow templates](/glossary.md#template-n8n) (true) or disable (false). | +| `N8N_TEMPLATES_HOST` | String | `https://api.n8n.io` | Change this if creating your own workflow template library. Note that to use your own workflow templates library, your API must provide the same endpoints and response structure as n8n's. Refer to [Workflow templates](/workflows/templates.md) for more information. | +| `N8N_ENCRYPTION_KEY` | String | Random key generated by n8n | Provide a custom key used to encrypt credentials in the n8n database. By default n8n generates a random key on first launch. | +| `N8N_USER_FOLDER` | String | `user-folder` | Provide the path where n8n will create the `.n8n` folder. This directory stores user-specific data, such as database file and encryption key. | +| `N8N_PATH` | String | `/` | The path n8n deploys to. | +| `N8N_HOST` | String | `localhost` | Host name n8n runs on. | +| `N8N_PORT` | Number | `5678` | The HTTP port n8n runs on. | +| `N8N_LISTEN_ADDRESS` | String | `0.0.0.0` | The IP address n8n should listen on. | +| `N8N_PROTOCOL` | Enum string: `http`, `https` | `http` | The protocol used to reach n8n. | +| `N8N_SSL_KEY` | String | - | The SSL key for HTTPS protocol. | +| `N8N_SSL_CERT` | String | - | The SSL certificate for HTTPS protocol. | +| `N8N_PERSONALIZATION_ENABLED` | Boolean | `true` | Whether to ask users personalisation questions and then customise n8n accordingly. | +| `N8N_VERSION_NOTIFICATIONS_ENABLED` | Boolean | `true` | When enabled, n8n sends notifications of new versions and security updates. | +| `N8N_VERSION_NOTIFICATIONS_ENDPOINT` | String | `https://api.n8n.io/versions/` | The endpoint to retrieve where version information. | +| `N8N_VERSION_NOTIFICATIONS_INFO_URL` | String | `https://docs.n8n.io/getting-started/installation/updating.html` | The URL displayed in the New Versions panel for more information. | +| `N8N_DIAGNOSTICS_ENABLED` | Boolean | `true` | Whether to share selected, anonymous [telemetry](/privacy-security/privacy.md) with n8n. Note that if you set this to `false`, you can't enable Ask AI in the Code node. | +| `N8N_DIAGNOSTICS_CONFIG_FRONTEND` | String | `1zPn9bgWPzlQc0p8Gj1uiK6DOTn;https://telemetry.n8n.io` | Telemetry configuration for the frontend. | +| `N8N_DIAGNOSTICS_CONFIG_BACKEND` | String | `1zPn7YoGC3ZXE9zLeTKLuQCB4F6;https://telemetry.n8n.io/v1/batch` | Telemetry configuration for the backend. | +| `N8N_PUSH_BACKEND` | String | `websocket` | Choose whether the n8n backend uses server-sent events (`sse`) or WebSockets (`websocket`) to send changes to the UI. | +| `VUE_APP_URL_BASE_API` | String | `http://localhost:5678/` | Used when building the `n8n-editor-ui` package manually to set how the frontend can reach the backend API. Refer to [Configure the Base URL](/hosting/configuration/configuration-examples/base-url.md). | +| `N8N_HIRING_BANNER_ENABLED` | Boolean | `true` | Whether to show the n8n hiring banner in the console (true) or not (false). | +| `N8N_PUBLIC_API_SWAGGERUI_DISABLED` | Boolean | `false` | Whether the Swagger UI (API playground) is disabled (true) or not (false). | +| `N8N_PUBLIC_API_DISABLED` | Boolean | `false` | Whether to disable the public API (true) or not (false). | +| `N8N_PUBLIC_API_ENDPOINT` | String | `api` | Path for the public API endpoints. | +| `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | Number | `30` | How long should the n8n process wait (in seconds) for components to shut down before exiting the process. | +| `N8N_DEV_RELOAD` | Boolean | `false` | When working on the n8n source code, set this to `true` to automatically reload or restart the application when changes occur in the source code files. | +| `N8N_REINSTALL_MISSING_PACKAGES` | Boolean | `false` | If set to `true`, n8n will automatically attempt to reinstall any missing packages. | +| `N8N_TUNNEL_SUBDOMAIN` | String | - | Specifies the subdomain for the n8n tunnel. If not set, n8n generates a random subdomain.| +| `N8N_PROXY_HOPS` | Number | 0 | Number of reverse-proxies n8n is running behind. | + + +# hosting/configuration/environment-variables/endpoints.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Endpoints environment variables +description: Customize the application's API and webhook endpoints with environment variables for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Endpoints environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +This page lists environment variables for customizing endpoints in n8n. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_PAYLOAD_SIZE_MAX` | Number | `16` | The maximum payload size in MiB. | +| `N8N_FORMDATA_FILE_SIZE_MAX` | Number | `200` | Max payload size for files in form-data webhook payloads in MiB. | +| `N8N_METRICS` | Boolean | `false` | Whether to enable the `/metrics` endpoint. | +| `N8N_METRICS_PREFIX` | String | `n8n_` | Optional prefix for n8n specific metrics names. | +| `N8N_METRICS_INCLUDE_DEFAULT_METRICS` | Boolean | `true` | Whether to expose default system and node.js metrics. | +| `N8N_METRICS_INCLUDE_CACHE_METRICS` | Boolean | false | Whether to include metrics (true) for cache hits and misses, or not include them (false). | +| `N8N_METRICS_INCLUDE_MESSAGE_EVENT_BUS_METRICS` | Boolean | `false` | Whether to include metrics (true) for events, or not include them (false). | +| `N8N_METRICS_INCLUDE_WORKFLOW_ID_LABEL` | Boolean | `false` | Whether to include a label for the workflow ID on workflow metrics. | +| `N8N_METRICS_INCLUDE_NODE_TYPE_LABEL` | Boolean | `false` | Whether to include a label for the node type on node metrics. | +| `N8N_METRICS_INCLUDE_CREDENTIAL_TYPE_LABEL` | Boolean | `false` | Whether to include a label for the credential type on credential metrics. | +| `N8N_METRICS_INCLUDE_API_ENDPOINTS` | Boolean | `false` | Whether to expose metrics for API endpoints. | +| `N8N_METRICS_INCLUDE_API_PATH_LABEL` | Boolean | `false` | Whether to include a label for the path of API invocations. | +| `N8N_METRICS_INCLUDE_API_METHOD_LABEL` | Boolean | `false` | Whether to include a label for the HTTP method (GET, POST, ...) of API invocations. | +| `N8N_METRICS_INCLUDE_API_STATUS_CODE_LABEL` | Boolean | `false` | Whether to include a label for the HTTP status code (200, 404, ...) of API invocations. | +| `N8N_METRICS_INCLUDE_QUEUE_METRICS` | Boolean | `false` | Whether to include metrics for jobs in scaling mode. Not supported in multi-main setup. | +| `N8N_METRICS_QUEUE_METRICS_INTERVAL` | Integer | `20` | How often (in seconds) to update queue metrics. | +| `N8N_ENDPOINT_REST` | String | `rest` | The path used for REST endpoint. | +| `N8N_ENDPOINT_WEBHOOK` | String | `webhook` | The path used for webhook endpoint. | +| `N8N_ENDPOINT_WEBHOOK_TEST` | String | `webhook-test` | The path used for test-webhook endpoint. | +| `N8N_ENDPOINT_WEBHOOK_WAIT` | String | `webhook-waiting` | The path used for waiting-webhook endpoint. | +| `WEBHOOK_URL` | String | - | Used to manually provide the Webhook URL when running n8n behind a reverse proxy. See [here](/hosting/configuration/configuration-examples/webhook-url.md) for more details. | +| `N8N_DISABLE_PRODUCTION_MAIN_PROCESS` | Boolean | `false` | Disable production webhooks from main process. This helps ensure no HTTP traffic load to main process when using webhook-specific processes. | + + +# hosting/configuration/environment-variables/executions.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Executions environment variables +description: Environment variables to configure settings related to workflow executions. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Executions environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +This page lists environment variables to configure workflow execution settings. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `EXECUTIONS_MODE` | Enum string: `regular`, `queue` | `regular` | Whether executions should run directly or using queue.

Refer to [Queue mode](/hosting/scaling/queue-mode.md) for more details. | +| `EXECUTIONS_TIMEOUT` | Number | `-1` | Sets a default timeout (in seconds) to all workflows after which n8n stops their execution. Users can override this for individual workflows up to the duration set in `EXECUTIONS_TIMEOUT_MAX`. Set `EXECUTIONS_TIMEOUT` to `-1` to disable. | +| `EXECUTIONS_TIMEOUT_MAX` | Number | `3600` | The maximum execution time (in seconds) that users can set for an individual workflow. | +| `EXECUTIONS_DATA_SAVE_ON_ERROR` | Enum string: `all`, `none` | `all` | Whether n8n saves execution data on error. | +| `EXECUTIONS_DATA_SAVE_ON_SUCCESS` | Enum string: `all`, `none` | `all` | Whether n8n saves execution data on success. | +| `EXECUTIONS_DATA_SAVE_ON_PROGRESS` | Boolean | `false` | Whether to save progress for each node executed (true) or not (false). | +| `EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS` | Boolean | `true` | Whether to save data of executions when started manually. | +| `EXECUTIONS_DATA_PRUNE` | Boolean | `true` | Whether to delete data of past executions on a rolling basis. | +| `EXECUTIONS_DATA_MAX_AGE` | Number | `336` | The execution age (in hours) before it's deleted. | +| `EXECUTIONS_DATA_PRUNE_MAX_COUNT` | Number | `10000` | Maximum number of executions to keep in the database. 0 = no limit | +| `EXECUTIONS_DATA_HARD_DELETE_BUFFER` | Number | `1` | How old (hours) the finished execution data has to be to get hard-deleted. By default, this buffer excludes recent executions as the user may need them while building a workflow. | +| `EXECUTIONS_DATA_PRUNE_HARD_DELETE_INTERVAL` | Number | `15` | How often (minutes) execution data should be hard-deleted. | +| `EXECUTIONS_DATA_PRUNE_SOFT_DELETE_INTERVAL` | Number | `60` | How often (minutes) execution data should be soft-deleted. | +| `N8N_CONCURRENCY_PRODUCTION_LIMIT` | Number | `-1` | Max production executions allowed to run concurrently, in both regular and scaling modes. `-1` to disable in regular mode. | + + +# hosting/configuration/environment-variables/external-data-storage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: External data storage environment variables +description: Environment variables to configure external data storage for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables + - external storage + - storage +hide: + - toc + - tags +--- + +# External data storage environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +Refer to [External storage](/hosting/scaling/external-storage.md) for more information on using external storage for binary data. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_EXTERNAL_STORAGE_S3_HOST` | String | - | Host of the n8n bucket in S3-compatible external storage. For example, `s3.us-east-1.amazonaws.com` | +| `N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME` | String | - | Name of the n8n bucket in S3-compatible external storage. | +| `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` | String | - | Region of the n8n bucket in S3-compatible external storage. For example, `us-east-1`| +| `N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY` | String | - | Access key in S3-compatible external storage | +| `N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET` | String | - | Access secret in S3-compatible external storage. | +| `N8N_EXTERNAL_STORAGE_S3_AUTH_AUTO_DETECT` | Boolean | - | Use automatic credential detection to authenticate S3 calls for external storage. This will ignore the access key and access secret and use the default [credential provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html#credchain). | + + +# hosting/configuration/environment-variables/external-hooks.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: External hooks environment variables +description: Environment variables to integrate external hooks into your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# External hooks environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +You can define external hooks that n8n executes whenever a specific operation runs. Refer to [Backend hooks](/embed/configuration.md#backend-hooks) for examples of available hooks and [Hook files](/embed/configuration.md#backend-hook-files) for information on file formatting. + +| Variable | Type | Description | +| :------- | :---- | :---------- | +| `EXTERNAL_HOOK_FILES` | String | Files containing backend external hooks. Provide multiple files as a colon-separated list ("`:`"). | +| `EXTERNAL_FRONTEND_HOOKS_URLS` | String | URLs to files containing frontend external hooks. Provide multiple URLs as a colon-separated list ("`:`"). | + + +# hosting/configuration/environment-variables/external-secrets.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: External secrets environment variables +description: Configure the interval for checking updates to external secrets in self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# External secrets environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +You can use an external secrets store to manage credentials for n8n. Refer to [External secrets](/external-secrets.md) for details. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_EXTERNAL_SECRETS_UPDATE_INTERVAL` | Number | `300` (5 minutes) | How often (in seconds) to check for secret updates. | + + +# hosting/configuration/environment-variables/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Environment Variables Overview +description: An overview of configuration environment variables for self-hosted n8n. +contentType: overview +tags: + - environment variables +hide: + - toc + - tags +--- + +# Environment variables overview + +This section lists of environment variables that you can use to change n8n's configuration settings when self-hosting n8n. + +/// note | File-based configuration +You can provide a [configuration file](/hosting/configuration/configuration-methods.md) for n8n. You can also append `_FILE` to certain variables to provide their configuration in a separate file. +/// + +[[% import "_macros/section-toc.html" as sectionToc %]] + +[[ sectionToc.sectionToc(page) ]] + + +# hosting/configuration/environment-variables/insights.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Insights environment variables +description: Configure insights metrics collection with environment variables for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Insights environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +Insights gives instance owners and admins visibility into how workflows perform over time. Refer to [Insights](/insights.md) for details. + + | Variable | Type | Default | Description | + |:---------------------------------------------------------|:-------|:--------|:----------------------------------------------------------------------------------------| + | `N8N_DISABLED_MODULES` | String | - | Set to `insights` to disable the feature and metrics collection for an instance. | + | `N8N_INSIGHTS_COMPACTION_BATCH_SIZE` | Number | 500 | The number of raw insights data to compact in a single batch. | + | `N8N_INSIGHTS_COMPACTION_DAILY_TO_WEEKLY_THRESHOLD_DAYS` | Number | 180 | The maximum age (in days) of daily insights data to compact. | + | `N8N_INSIGHTS_COMPACTION_HOURLY_TO_DAILY_THRESHOLD_DAYS` | Number | 90 | The maximum age (in days) of hourly insights data to compact. | + | `N8N_INSIGHTS_COMPACTION_INTERVAL_MINUTES` | Number | 60 | Interval (in minutes) at which compaction should run. | + | `N8N_INSIGHTS_FLUSH_BATCH_SIZE` | Number | 1000 | The maximum number of insights data to keep in the buffer before flushing. | + | `N8N_INSIGHTS_FLUSH_INTERVAL_SECONDS` | Number | 30 | The interval (in seconds) at which the insights data should be flushed to the database. | + + +# hosting/configuration/environment-variables/licenses.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: License environment variables +description: Environment variables to configure license settings in n8n, including options to hide the usage page, manage license activation and auto-renewal settings, and specify the server URL for license retrieval. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# License environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +To enable certain licensed features, you must first activate your license. You can do this either through the UI or by setting environment variables. For more information, see [license key](/license-key.md). + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_HIDE_USAGE_PAGE` | boolean | `false` | Hide the usage and plans page in the app. | +| `N8N_LICENSE_ACTIVATION_KEY` | String | `''` | Activation key to initialize license. Not applicable if the n8n instance was already activated. | +| `N8N_LICENSE_AUTO_RENEW_ENABLED` | Boolean | `true` | Enables (true) or disables (false) autorenewal for licenses.
If disabled, you need to manually renew the license every 10 days by navigating to **Settings** > **Usage and plan**, and pressing `F5`. Failure to renew the license will disable all licensed features. | +| `N8N_LICENSE_DETACH_FLOATING_ON_SHUTDOWN` | Boolean | `true` | Controls whether the instance releases [floating entitlements](/glossary.md#entitlement-n8n) back to the pool upon shutdown. Set to `true` to allow other instances to reuse the entitlements, or `false` to retain them.
For production instances that must always keep their licensed features, set this to `false`. | +| `N8N_LICENSE_SERVER_URL` | String | `http://license.n8n.io/v1` | Server URL to retrieve license. | +| `N8N_LICENSE_TENANT_ID` | Number | `1` | Tenant ID associated with the license. Only set this variable if explicitly instructed by n8n. | +| `https_proxy_license_server` | String | `https://user:pass@proxy:port` | Proxy server URL for HTTPS requests to retrieve license. This variable name needs to be lowercase. | + + +# hosting/configuration/environment-variables/logs.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Logs environment variables +description: Environment variables to configure logging and diagnostic data. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Logs environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +This page lists environment variables to set up logging for debugging. Refer to [Logging in n8n](/hosting/logging-monitoring/logging.md) for details. + +## n8n logs + + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_LOG_LEVEL` | Enum string: `info`, `warn`, `error`, `debug` | `info` | Log output level. Refer to [Log levels](/hosting/logging-monitoring/logging.md#log-levels) for details. | +| `N8N_LOG_OUTPUT` | Enum string: `console`, `file` | `console` | Where to output logs. Provide multiple values as a comma-separated list. | +| `N8N_LOG_FILE_COUNT_MAX` | Number | `100` | Max number of log files to keep. | +| `N8N_LOG_FILE_SIZE_MAX` | Number | `16` | Max size of each log file in MB. | +| `N8N_LOG_FILE_LOCATION` | String | `/logs/n8n.log` | Log file location. Requires N8N_LOG_OUTPUT set to `file`. | +| `DB_LOGGING_ENABLED` | Boolean | `false` | Whether to enable database-specific logging. | +| `DB_LOGGING_OPTIONS` | Enum string: `query`, `error`, `schema`, `warn`, `info`, `log` | `error` | Database log output level. To enable all logging, specify `all`. Refer to [TypeORM logging options](https://orkhan.gitbook.io/typeorm/docs/logging#logging-options){:target=_blank .external-link} | +| `DB_LOGGING_MAX_EXECUTION_TIME` | Number | `1000` | Maximum execution time (in milliseconds) before n8n logs a warning. Set to `0` to disable long running query warning. | +| `CODE_ENABLE_STDOUT` | Boolean | `false` | Set to `true` to send Code node logs to process's stdout for debugging, monitoring, or logging purposes. | +| `NO_COLOR` | any | `undefined` | Set to any value to output logs without ANSI colors. For more information, see the [no-color.org website](https://no-color.org/){:target=_blank .external-link}. | + + +## Log streaming + +Refer to [Log streaming](/log-streaming.md) for more information on this feature. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_EVENTBUS_CHECKUNSENTINTERVAL` | Number | `0` | How often (in milliseconds) to check for unsent event messages. Can in rare cases send message twice. Set to `0` to disable it. | +| `N8N_EVENTBUS_LOGWRITER_SYNCFILEACCESS` | Boolean | `false` | Whether all file access happens synchronously within the thread (true) or not (false). | +| `N8N_EVENTBUS_LOGWRITER_KEEPLOGCOUNT` | Number | `3` | Number of event log files to keep. | +| `N8N_EVENTBUS_LOGWRITER_MAXFILESIZEINKB` | Number | `10240` | Maximum size (in kilo-bytes) of an event log file before a new one starts. | +| `N8N_EVENTBUS_LOGWRITER_LOGBASENAME` | String | `n8nEventLog` | Basename of the event log file. | + + +# hosting/configuration/environment-variables/nodes.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Nodes environment variables +description: Environment variable to configure nodes management in self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Nodes environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +This page lists the environment variables configuration options for managing [nodes](/glossary.md#node-n8n) in n8n, including specifying which nodes to load or exclude, importing built-in or external modules in the Code node, and enabling community nodes. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `NODES_INCLUDE` | Array of strings | - | Specify which nodes to load. | +| `NODES_EXCLUDE` | Array of strings | - | Specify which nodes not to load. For example, to block nodes that can be a security risk if users aren't trustworthy: `NODES_EXCLUDE: "[\"n8n-nodes-base.executeCommand\", \"n8n-nodes-base.readWriteFile\"]"` | +| `NODE_FUNCTION_ALLOW_BUILTIN` | String | - | Permit users to import specific built-in modules in the Code node. Use * to allow all. n8n disables importing modules by default. | +| `NODE_FUNCTION_ALLOW_EXTERNAL` | String | - | Permit users to import specific external modules (from `n8n/node_modules`) in the Code node. n8n disables importing modules by default. | +| `NODES_ERROR_TRIGGER_TYPE` | String | `n8n-nodes-base.errorTrigger` | Specify which node type to use as Error Trigger. | +| `N8N_CUSTOM_EXTENSIONS` | String | - | Specify the path to directories containing your custom nodes. | +| `N8N_COMMUNITY_PACKAGES_ENABLED` | Boolean | `true` | Enables (true) or disables (false) the functionality to install and load community nodes. If set to false, neither verified nor unverified community packages will be available, regardless of their individual settings. | +| `N8N_COMMUNITY_PACKAGES_REGISTRY` | String | `https://registry.npmjs.org` | NPM registry URL to pull community packages from (license required). | +| `N8N_VERIFIED_PACKAGES_ENABLED` | Boolean | `true` | When `N8N_COMMUNITY_PACKAGES_ENABLED` is true, this variable controls whether to show verified community nodes in the nodes panel for installation and use (true) or to hide them (false). | +| `N8N_UNVERIFIED_PACKAGES_ENABLED` | Boolean | `true` | When `N8N_COMMUNITY_PACKAGES_ENABLED` is true, this variable controls whether to enable the installation and use of unverified community nodes from an NPM registry (true) or not (false). | +| `N8N_COMMUNITY_PACKAGES_PREVENT_LOADING` | Boolean | `false` | Prevents (true) or allows (false) loading installed community nodes on instance startup. Use this if a faulty node prevents the instance from starting. | + + +# hosting/configuration/environment-variables/queue-mode.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Queue mode environment variables +description: Environment variables to configure queue mode on your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Queue mode environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +You can run n8n in different modes depending on your needs. Queue mode provides the best scalability. Refer to [Queue mode](/hosting/scaling/queue-mode.md) for more information. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `QUEUE_BULL_PREFIX` | String | - | Prefix to use for all queue keys. | +| `QUEUE_BULL_REDIS_DB` | Number | `0` | The Redis database used. | +| `QUEUE_BULL_REDIS_HOST` | String | `localhost` | The Redis host. | +| `QUEUE_BULL_REDIS_PORT` | Number | `6379` | The Redis port used. | +| `QUEUE_BULL_REDIS_USERNAME` | String | - | The Redis username (needs Redis version 6 or above). Don't define it for Redis < 6 compatibility | +| `QUEUE_BULL_REDIS_PASSWORD` | String | - | The Redis password. | +| `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Number | `10000` | The Redis timeout threshold (in ms). | +| `QUEUE_BULL_REDIS_CLUSTER_NODES` | String | - | Expects a comma-separated list of Redis Cluster nodes in the format `host:port`, for the Redis client to initially connect to. If running in queue mode (`EXECUTIONS_MODE = queue`), setting this variable will create a Redis Cluster client instead of a Redis client, and n8n will ignore `QUEUE_BULL_REDIS_HOST` and `QUEUE_BULL_REDIS_PORT`. | +| `QUEUE_BULL_REDIS_TLS` | Boolean | `false` | Enable TLS on Redis connections. | +| `QUEUE_BULL_REDIS_DUALSTACK` | Boolean | `false` | Enable dual-stack support (IPv4 and IPv6) on Redis connections. | +| `QUEUE_WORKER_TIMEOUT` (**deprecated**) | Number | `30` | **Deprecated** Use `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` instead.

How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | +| `QUEUE_HEALTH_CHECK_ACTIVE` | Boolean | `false` | Whether to enable health checks (true) or disable (false). | +| `QUEUE_HEALTH_CHECK_PORT` | Number | - | The port to serve health checks on. | +| `QUEUE_WORKER_LOCK_DURATION` | Number | `30000` | How long (in ms) is the lease period for a worker to work on a message. | +| `QUEUE_WORKER_LOCK_RENEW_TIME` | Number | `15000` | How frequently (in ms) should a worker renew the lease time. | +| `QUEUE_WORKER_STALLED_INTERVAL` | Number | `30000` | How often should a worker check for stalled jobs (use 0 for never). | +| `QUEUE_WORKER_MAX_STALLED_COUNT` | Number | `1` | Maximum amount of times a stalled job will be re-processed. | + +## Multi-main setup + +Refer to [Configuring multi-main setup](/hosting/scaling/queue-mode.md#configuring-multi-main-setup) for details. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_MULTI_MAIN_SETUP_ENABLED` | Boolean | `false` | Whether to enable multi-main setup for queue mode (license required). | +| `N8N_MULTI_MAIN_SETUP_KEY_TTL` | Number | `10` | Time to live (in seconds) for leader key in multi-main setup. | +| `N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL` | Number | `3` | Interval (in seconds) for leader check in multi-main setup. | + + +# hosting/configuration/environment-variables/security.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Security environment variables +description: Configure authentication and environment variable access in self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Security environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_BLOCK_ENV_ACCESS_IN_NODE` | Boolean | `false` | Whether to allow users to access environment variables in expressions and the Code node (false) or not (true). | +| `N8N_RESTRICT_FILE_ACCESS_TO` | String | | Limits access to files in these directories. Provide multiple files as a colon-separated list ("`:`"). | +| `N8N_BLOCK_FILE_ACCESS_TO_N8N_FILES` | Boolean | `true` | Set to `true` to block access to all files in the `.n8n` directory and user defined configuration files. | +| `N8N_SECURITY_AUDIT_DAYS_ABANDONED_WORKFLOW` | Number | 90 | Number of days to consider a workflow abandoned if it's not executed. | +| `N8N_SECURE_COOKIE` | Boolean | `true` | Ensures that cookies are only sent over HTTPS, enhancing security.| +| `N8N_SAMESITE_COOKIE` | Enum string: `strict`, `lax`, `none` | `lax` | Controls cross-site cookie behavior ([learn more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite)):
  • `strict`: Sent only for first-party requests.
  • `lax` (default): Sent with top-level navigation requests.
  • `none`: Sent in all contexts (requires HTTPS).
| + + +# hosting/configuration/environment-variables/source-control.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Source control environment variables +description: Environment variable to set the default SSH key type for source control setup. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Source control environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +n8n uses Git-based source control to support environments. Refer to [Source control and environments](/source-control-environments/setup.md) for more information on how to link a Git repository to an n8n instance and configure your source control. + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_SOURCECONTROL_DEFAULT_SSH_KEY_TYPE` | String | `ed25519` | Set to `rsa` to make RSA the default SSH key type for [Source control setup](/source-control-environments/setup.md). | + + +# hosting/configuration/environment-variables/task-runners.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Task runner environment variables +description: Environment variables to confgure task runners your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Task runner environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +[Task runners](/hosting/configuration/task-runners.md) execute code defined by the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). + +## n8n instance environment variables + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_RUNNERS_ENABLED` | Boolean | `false` | Are task runners enabled. | +| `N8N_RUNNERS_MODE` | Enum string: `internal`, `external` | `internal` | How to launch and run the task runner. `internal` means n8n will launch a task runner as child process. `external` means an external orchestrator will launch the task runner. | +| `N8N_RUNNERS_AUTH_TOKEN` | String | Random string | Shared secret used by a task runner to authenticate to n8n. Required when using `external` mode. | +| `N8N_RUNNERS_BROKER_PORT` | Number | `5679` | Port the task broker listens on for task runner connections. | +| `N8N_RUNNERS_BROKER_LISTEN_ADDRESS` | String | `127.0.0.1` | Address the task broker listens on. | +| `N8N_RUNNERS_MAX_PAYLOAD` | Number | `1 073 741 824` | Maximum payload size in bytes for communication between a task broker and a task runner. | +| `N8N_RUNNERS_MAX_OLD_SPACE_SIZE` | String | | The `--max-old-space-size` option to use for a task runner (in MB). By default, Node.js will set this based on available memory. | +| `N8N_RUNNERS_MAX_CONCURRENCY` | Number | `5` | The number of concurrent tasks a task runner can execute at a time. | +| `N8N_RUNNERS_TASK_TIMEOUT` | Number | `60` | How long (in seconds) a task can take to complete before the task aborts and the runner restarts. Must be greater than 0. | +| `N8N_RUNNERS_HEARTBEAT_INTERVAL` | Number | `30` | How often (in seconds) the runner must send a heartbeat to the broker, else the task aborts and the runner restarts. Must be greater than 0. | + + +## Task runner launcher environment variables + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_RUNNERS_LAUNCHER_LOG_LEVEL` | Enum string: `debug`, `info`, `warn`, `error` | `info` | Which log messages to show. | +| `N8N_RUNNERS_AUTH_TOKEN` | String | - | Shared secret used to authenticate to n8n. | +| `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT` | Number | `15` | The number of seconds to wait before shutting down an idle runner. | +| `N8N_RUNNERS_TASK_BROKER_URI` | String | `http://127.0.0.1:5679` | The URI of the task broker server (n8n instance). | +| `N8N_RUNNERS_LAUNCHER_HEALTH_CHECK_PORT` | Number | `5680` | Port for the launcher's health check server. | +| `N8N_RUNNERS_MAX_PAYLOAD` | Number | `1 073 741 824` | Maximum payload size in bytes for communication between a task broker and a task runner. | +| `N8N_RUNNERS_MAX_CONCURRENCY` | Number | `5` | The number of concurrent tasks a task runner can execute at a time. | +| `NODE_OPTIONS` | String | - | [Options](https://nodejs.org/api/cli.html#node_optionsoptions) for Node.js. | + + +## Task runner environment variables + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_RUNNERS_GRANT_TOKEN` | String | Random string | Token the runner uses to authenticate with the task broker. This is automatically provided by the launcher. | +| `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT` | Number | `15` | The number of seconds to wait before shutting down an idle runner. | +| `N8N_RUNNERS_TASK_BROKER_URI` | String | `http://127.0.0.1:5679` | The URI of the task broker server (n8n instance). | +| `N8N_RUNNERS_LAUNCHER_HEALTH_CHECK_PORT` | Number | `5680` | Port for the launcher's health check server. | +| `N8N_RUNNERS_MAX_PAYLOAD` | Number | `1 073 741 824` | Maximum payload size in bytes for communication between a task broker and a task runner. | +| `N8N_RUNNERS_MAX_CONCURRENCY` | Number | `5` | The number of concurrent tasks a task runner can execute at a time. | +| `NODE_FUNCTION_ALLOW_BUILTIN` | String | - | Permit users to import specific built-in modules in the Code node. Use * to allow all. n8n disables importing modules by default. | +| `NODE_FUNCTION_ALLOW_EXTERNAL` | String | - | Permit users to import specific external modules (from `n8n/node_modules`) in the Code node. n8n disables importing modules by default. | +| `N8N_RUNNERS_ALLOW_PROTOTYPE_MUTATION` | Boolean | `false` | Whether to allow prototype mutation for external libraries. Set to `true` to allow modules that rely on runtime prototype mutation (for example, [`puppeteer`](https://pptr.dev/)) at the cost of relaxing security. | +| `GENERIC_TIMEZONE` | * | `America/New_York` | The [same default timezone as configured for the n8n instance](/hosting/configuration/environment-variables/timezone-localization.md). | + + +# hosting/configuration/environment-variables/timezone-localization.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Timezone and localization environment variables +description: Set the timezone and default language locale for self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Timezone and localization environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `GENERIC_TIMEZONE` | * | `America/New_York` |The n8n instance timezone. Important for schedule nodes (such as Cron). | +| `N8N_DEFAULT_LOCALE` | String | `en` | A locale identifier, compatible with the [Accept-Language header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language){:target="_blank" .external-link}. n8n doesn't support regional identifiers, such as `de-AT`. When running in a locale other than the default, n8n displays UI strings in the selected locale, and falls back to `en` for any untranslated strings. | + + +# hosting/configuration/environment-variables/user-management-smtp-2fa.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: User management SMTP, and two-factor authentication environment variables +description: Environment variables to set up user management and emails. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# User management SMTP, and two-factor authentication environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +Refer to [User management](/hosting/configuration/user-management-self-hosted.md) for more information on setting up user management and emails. + +| Variable | Type | Default | Description | +| :------- | :--- | :------ | :---------- | +| `N8N_EMAIL_MODE` | String | `smtp` | Enable emails. | +| `N8N_SMTP_HOST` | String | - | _your_SMTP_server_name_ | +| `N8N_SMTP_PORT` | Number | - | _your_SMTP_server_port_ | +| `N8N_SMTP_USER` | String | - | _your_SMTP_username_ | +| `N8N_SMTP_PASS` | String | - | _your_SMTP_password_ | +| `N8N_SMTP_OAUTH_SERVICE_CLIENT` | String | - | If using 2LO with a service account this is your client ID | +| `N8N_SMTP_OAUTH_PRIVATE_KEY` | String | - | If using 2LO with a service account this is your private key | +| `N8N_SMTP_SENDER` | String | - | Sender email address. You can optionally include the sender name. Example with name: _N8N ``_ | +| `N8N_SMTP_SSL` | Boolean | `true` | Whether to use SSL for SMTP (true) or not (false). | +| `N8N_SMTP_STARTTLS` | Boolean | `true` | Whether to use STARTTLS for SMTP (true) or not (false). | +| `N8N_UM_EMAIL_TEMPLATES_INVITE` | String | - | Full path to your HTML email template. This overrides the default template for invite emails. | +| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | String | - | Full path to your HTML email template. This overrides the default template for password reset emails. | +| `N8N_UM_EMAIL_TEMPLATES_WORKFLOW_SHARED` | String | - | Overrides the default HTML template for notifying users that a workflow was shared. Provide the full path to the template. | +| `N8N_UM_EMAIL_TEMPLATES_CREDENTIALS_SHARED` | String | - | Overrides the default HTML template for notifying users that a credential was shared. Provide the full path to the template. | +| `N8N_USER_MANAGEMENT_JWT_SECRET` | String | - | Set a specific JWT secret. By default, n8n generates one on start. | +| `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS` | Number | 168 | Set an expiration date for the JWTs in hours. | +| `N8N_USER_MANAGEMENT_JWT_REFRESH_TIMEOUT_HOURS` | Number | 0 | How many hours before the JWT expires to automatically refresh it. 0 means 25% of `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. -1 means it will never refresh, which forces users to log in again after the period defined in `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. | +| `N8N_MFA_ENABLED` | Boolean | `true` | Whether to enable two-factor authentication (true) or disable (false). n8n ignores this if existing users have 2FA enabled. | + + + +# hosting/configuration/environment-variables/workflows.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Workflows environment variables +description: Environment variables to configure workflows in n8n, including default naming, onboarding flow preferences, tag management, and caller policy settings. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Workflows environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +| Variable | Type | Default | Description | +| :------- | :---- | :------- | :---------- | +| `N8N_ONBOARDING_FLOW_DISABLED` | Boolean | `false` | Whether to disable onboarding tips when creating a new workflow (true) or not (false). | +| `N8N_WORKFLOW_ACTIVATION_BATCH_SIZE` | Number | `1` | How many workflows to activate simultaneously during startup. +| `N8N_WORKFLOW_CALLER_POLICY_DEFAULT_OPTION` | String | `workflowsFromSameOwner` | Which workflows can call a workflow. Options are: `any`, `none`, `workflowsFromAList`, `workflowsFromSameOwner`. This feature requires [Workflow sharing](/workflows/sharing.md). | +| `N8N_WORKFLOW_TAGS_DISABLED` | Boolean | `false` | Whether to disable workflow tags (true) or enable tags (false). | +| `WORKFLOWS_DEFAULT_NAME` | String | `My workflow` | The default name used for new workflows. | + + +# hosting/configuration/supported-databases-settings.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# Supported databases + +By default, n8n uses SQLite to save credentials, past executions, and workflows. n8n also supports PostgresDB. + +## Shared settings + +The following environment variables get used by all databases: + + - `DB_TABLE_PREFIX` (default: -) - Prefix for table names + +## PostgresDB + +To use PostgresDB as the database, you can provide the following environment variables: + + - `DB_TYPE=postgresdb` + - `DB_POSTGRESDB_DATABASE` (default: 'n8n') + - `DB_POSTGRESDB_HOST` (default: 'localhost') + - `DB_POSTGRESDB_PORT` (default: 5432) + - `DB_POSTGRESDB_USER` (default: 'postgres') + - `DB_POSTGRESDB_PASSWORD` (default: empty) + - `DB_POSTGRESDB_SCHEMA` (default: 'public') + - `DB_POSTGRESDB_SSL_CA` (default: undefined): Path to the server's CA certificate used to validate the connection (opportunistic encryption isn't supported) + - `DB_POSTGRESDB_SSL_CERT` (default: undefined): Path to the client's TLS certificate + - `DB_POSTGRESDB_SSL_KEY` (default: undefined): Path to the client's private key corresponding to the certificate + - `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED` (default: true): If TLS connections that fail validation should be rejected + +```bash +export DB_TYPE=postgresdb +export DB_POSTGRESDB_DATABASE=n8n +export DB_POSTGRESDB_HOST=postgresdb +export DB_POSTGRESDB_PORT=5432 +export DB_POSTGRESDB_USER=n8n +export DB_POSTGRESDB_PASSWORD=n8n +export DB_POSTGRESDB_SCHEMA=n8n + +# optional: +export DB_POSTGRESDB_SSL_CA=$(pwd)/ca.crt +export DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED=false + +n8n start +``` + +### Required permissions + +n8n needs to create and modify the schemas of the tables it uses. + +Recommended permissions: + +```sql +CREATE DATABASE n8n-db; +CREATE USER n8n-user WITH PASSWORD 'random-password'; +GRANT ALL PRIVILEGES ON DATABASE n8n-db TO n8n-user; +``` + +### TLS + +You can choose between these configurations: + +- Not declaring (default): Connect with `SSL=off` +- Declaring only the CA and unauthorized flag: Connect with `SSL=on` and verify the server's signature +- Declaring `_{CERT,KEY}` and the above: Use the certificate and key for client TLS authentication + +## SQLite + +This is the default database that gets used if nothing is defined. + +The database file is located at: +`~/.n8n/database.sqlite` + + +# hosting/configuration/task-runners.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Task runners +description: How to configure task runners to execute tasks using internal or external runner processes. +contentType: howto +--- + +# Task runners + +Task runners are a generic mechanism to execute tasks in a secure and performant way. They're used to execute user-provided JavaScript code in the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). + +This document describes how task runners work and how you can configure them. + +## How it works + +The task runner feature consists of three components: a task runner, a task broker, and a task requester. + +![Task runner overview](/_images/hosting/configuration/task-runner-concept.png) + +Task runners connect to the task broker using a websocket connection. A task requester submits a task request to the broker where an available task runner can pick it up for execution. + +The runner executes the task and submits the results to the task requester. The task broker coordinates communication between the runner and the requester. + +The n8n instance (main and worker) acts as the broker. The Code node in this case is the task requester. + +## Task runner modes + +You can use task runners in two different modes: internal and external. + +### Internal mode + +In internal mode, the n8n instance launches the task runner as a child process. The n8n process monitors and manages the life cycle of the task runner. The task runner process shares the same `uid` and `gid` as n8n. + +### External mode + +In external mode, an external orchestrator (for example, Kubernetes) launches the task runner instead of n8n. Typically, this means you would configure the task runner to run as a side-car container next to n8n. + +![Task runner deployed as a side-car container](/_images/hosting/configuration/task-runner-external-mode.png) + +In this mode, the orchestrator monitors and manages the life cycle of the task runner container. The task runner is fully isolated from the n8n instance. + +When using the [Queue mode](/hosting/scaling/queue-mode.md), each n8n container (main and workers) needs to have its own task runner. + +## Setting up external mode + +Use the following details to configure task runners in external mode + +### Configuring n8n instance in external mode + +You can configure n8n to use external task runners by setting the following environment variables: + +| Environment variables | Description | +|--------------------------------------------------------|------------------------------------------------------------| +| `N8N_RUNNERS_ENABLED=true` | Enables task runners. | +| `N8N_RUNNERS_MODE=external` | Use task runners in external mode. | +| `N8N_RUNNERS_AUTH_TOKEN=` | A shared secret task runners use to connect to the broker. | +| `N8N_RUNNERS_BROKER_LISTEN_ADDRESS=0.0.0.0` | By default, the task broker only listens to localhost. When using multiple containers (for example, with Docker Compose), it needs to be able to accept external connections. | + +For full list of environment variables see [task runner environment variables](/hosting/configuration/environment-variables/task-runners.md). + +### Configuring task runners in external mode + +The task runner comes bundled within the n8n Docker image. The Docker image also includes the task runner launcher. + +The launcher can start the runner on-demand, which means lower memory usage when there's no work needed, but a short delay (few hundred ms) in cold-start. The launcher also monitors the runner and restarts it in case of infinite loops or other issues. + +Run a task runner container from the n8n Docker image by setting the following properties: + +| Configuration | Description | +|-----------------|---------------------------------------------------------| +| `command` | `["/usr/local/bin/task-runner-launcher", "javascript"]` | +| `livenessProbe` | `GET /healthz`, port `5680` | + +Set the following environment variables for the container, adjusted to fit your needs: + +| Environment variables | Description | +| ------ | ----- | +| `N8N_RUNNERS_AUTH_TOKEN=` | The shared secret the task runner uses to connect to the broker. | +| `N8N_RUNNERS_MAX_CONCURRENCY=5` | The number of concurrent tasks the runner can execute. | +| `N8N_RUNNERS_TASK_BROKER_URI=localhost:5679` | The address of the task broker server within the n8n instance. | +| `N8N_RUNNERS_AUTO_SHUTDOWN_TIMEOUT=15` | Number of seconds of inactivity to wait before shutting down the task runner process. The launcher will automatically start the runner again when there are new tasks to execute. Set to `0` to disable automatic shutdown. | +| `NODE_OPTIONS=--max-old-space-size=` | The memory limit for the task runner Node.js process. This should be lower than the limit for container so that the runner runs out of memory before the container. That way, the launcher is able to monitor the runner. | +| `GENERIC_TIMEZONE` | The [same default timezone as configured for the n8n instance](/hosting/configuration/environment-variables/timezone-localization.md). | + +For full list of environment variables see [task runner environment variables](/hosting/configuration/environment-variables/task-runners.md). + + +# hosting/configuration/user-management-self-hosted.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Configure self-hosted n8n for user management +contentType: howto +--- + +# Configure self-hosted n8n for user management + +User management in n8n allows you to invite people to work in your n8n instance. + +This document describes how to configure your n8n instance to support user management, and the steps to start inviting users. + +Refer to the main [User management](/user-management/index.md) guide for more information about usage, including: + +* [Managing users](/user-management/manage-users.md) +* [Account types](/user-management/account-types.md) +* [Best practices](/user-management/best-practices.md) + +For LDAP setup information, refer to [LDAP](/user-management/ldap.md). + +For SAML setup information, refer to [SAML](/user-management/saml/index.md). + +/// note | Basic auth and JWT removed +n8n removed support for basic auth and JWT in version 1.0. +/// +## Setup + +There are three stages to set up user management in n8n: + +1. Configure your n8n instance to use your SMTP server. +2. Start n8n and follow the setup steps in the app. +3. Invite users. + +### Step one: SMTP + +n8n recommends setting up an SMTP server, for user invites and password resets. + +/// note | Optional from 0.210.1 +From version 0.210.1 onward, this step is optional. You can choose to manually copy and send invite links instead of setting up SMTP. Note that if you skip this step, users can't reset passwords. +/// +Get the following information from your SMTP provider: + +* Server name +* SMTP username +* SMTP password +* SMTP sender name + +To set up SMTP with n8n, configure the SMTP environment variables for your n8n instance. For information on how to set environment variables, refer to [Configuration](/hosting/configuration/configuration-methods.md) + +| Variable | Type | Description | Required? | +| -------- | ---- | ----------- | --------- | +| `N8N_EMAIL_MODE` | string | `smtp` | Required | +| `N8N_SMTP_HOST` | string | _your_SMTP_server_name_ | Required | +| `N8N_SMTP_PORT` | number | _your_SMTP_server_port_ Default is `465`.| Optional | +| `N8N_SMTP_USER` | string | _your_SMTP_username_ | Optional | +| `N8N_SMTP_PASS` | string | _your_SMTP_password_ | Optional | +| `N8N_SMTP_OAUTH_SERVICE_CLIENT` | string | _your_OAuth_service_client_ | Optional | +| `N8N_SMTP_OAUTH_PRIVATE_KEY` | string | _your_OAuth_private_key_ | Optional | +| `N8N_SMTP_SENDER` | string | Sender email address. You can optionally include the sender name. Example with name: _N8N ``_ | Required | +| `N8N_SMTP_SSL` | boolean | Whether to use SSL for SMTP (true) or not (false). Defaults to `true`. | Optional | +| `N8N_UM_EMAIL_TEMPLATES_INVITE` | string | Full path to your HTML email template. This overrides the default template for invite emails. | Optional | +| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | string | Full path to your HTML email template. This overrides the default template for password reset emails. | Optional | +| `N8N_UM_EMAIL_TEMPLATES_WORKFLOW_SHARED` | String | Overrides the default HTML template for notifying users that a credential was shared. Provide the full path to the template. | Optional | +| `N8N_UM_EMAIL_TEMPLATES_CREDENTIALS_SHARED` | String | Overrides the default HTML template for notifying users that a credential was shared. Provide the full path to the template. | Optional | + + +If your n8n instance is already running, you need to restart it to enable the new SMTP settings. + +/// note | More configuration options +There are more configuration options available as environment variables. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for a list. These include options to disable tags, workflow templates, and the personalization survey, if you don't want your users to see them. +/// + +/// note | New to SMTP? +If you're not familiar with SMTP, this [blog post by SendGrid](https://sendgrid.com/blog/what-is-an-smtp-server/) offers a short introduction, while [Wikipedia's Simple Mail Transfer Protocol article](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) provides more detailed technical background. +/// + +### Step two: In-app setup + +--8<-- "_snippets/user-management/in-app-setup.md" + +### Step three: Invite users + +--8<-- "_snippets/user-management/invite-users.md" + + +# hosting/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n Hosting Documentation and Guides +description: Access n8n hosting documentation and guides. Find comprehensive resources to help you set up and manage your self-hosted n8n instances. +contentType: overview +hide: + - toc +--- + +# Self-hosting n8n + +This 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. + +See [Community edition features](/hosting/community-edition-features.md) for a list of available features. + +
+ +- __Installation and server setups__ + + Install n8n on any platform using npm or Docker. Or follow our guides to popular hosting platforms. + + [:octicons-arrow-right-24: Docker installation guide](/hosting/installation/docker.md) + +- __Configuration__ + + Learn how to configure n8n with environment variables. + + [:octicons-arrow-right-24: Environment Variables](/hosting/configuration/environment-variables/index.md) + +- __Users and authentication__ + + Choose and set up user authentication for your n8n instance. + + [:octicons-arrow-right-24: Authentication](/hosting/configuration/user-management-self-hosted.md) + +- __Scaling__ + + Manage data, modes, and processes to keep n8n running smoothly at scale. + + [:octicons-arrow-right-24: Scaling](/hosting/scaling/queue-mode.md) + +- __Securing n8n__ + + Secure your n8n instance by setting up SSL, SSO, or 2FA or blocking or opting out of some data collection or features. + + [:octicons-arrow-right-24: Securing n8n guide](/hosting/securing/overview.md) + +- __Starter kits__ + + 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. + + [:octicons-arrow-right-24: Starter kits](/hosting/starter-kits/ai-starter-kit.md) + +
+ +--8<-- "_snippets/self-hosting/warning.md" + + +# hosting/installation/docker.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Docker Installation + +[Docker](https://www.docker.com/){:target=_blank .external-link} offers the following advantages: + +* Installs n8n in a clean environment. +* Easier setup for your preferred database. +* Can avoid issues due to different operating systems, as Docker provides a consistent system. +* Can avoid compatibility issues due to differences in operating systems and tools. +* Makes migrating to new hosts or environments more straightforward. + +You can also use n8n in Docker with [Docker Compose](/hosting/installation/server-setups/docker-compose.md). You can find Docker Compose configurations for various architectures in the [n8n-hosting repository](https://github.com/n8n-io/n8n-hosting). + +--8<-- "_snippets/self-hosting/warning.md" + +## Prerequisites + +Before proceeding, install [Docker Desktop](https://docs.docker.com/get-docker/){:target=_blank .external-link}. + +/// note | Linux Users +Docker Desktop is available for Mac and Windows. Linux users must install [Docker Engine](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) individually for your distribution. +/// + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Starting n8n + +From your terminal, run: + +```sh +docker volume create n8n_data + +docker run -it --rm --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n +``` + +This command creates a volume to store persistent data, downloads the required n8n image, and starts your container, exposed on port `5678`. To save your work between container restarts, it also mounts a docker volume, `n8n_data`, to persist your data locally. + +Once running, you can access n8n by opening: +[http://localhost:5678](http://localhost:5678) + +## Using with PostgreSQL + +By default, n8n uses SQLite to save [credentials](/glossary.md#credential-n8n), past executions, and workflows. n8n also supports PostgreSQL, configurable using environment variables as detailed below. + +When using PostgreSQL, it's still important to persist the data stored in the `/home/node/.n8n` folder. This includes n8n user data and, even more importantly, the encryption key for credentials. It's also the name of the webhook when using the [n8n tunnel](#n8n-with-tunnel). + +If n8n can't find the `/home/node/.n8n` directory on startup, it automatically creates one. In this case, all existing credentials that n8n saved with a different encryption key will no longer work. + +/// note | Keep in mind +While persisting the `/home/node/.n8n` directory with PostgreSQL is the recommended best practice, it's not explicitly required. You can provide the encryption key by passing the [`N8N_ENCRYPTION_KEY` environment variable](/hosting/configuration/environment-variables/deployment.md) when starting your Docker container. +/// + +To use n8n with PostgreSQL, execute the following commands, replacing the placeholders (depicted within angled brackets, for example ``) with your actual values: + +```sh +docker volume create n8n_data + +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -e DB_TYPE=postgresdb \ + -e DB_POSTGRESDB_DATABASE= \ + -e DB_POSTGRESDB_HOST= \ + -e DB_POSTGRESDB_PORT= \ + -e DB_POSTGRESDB_USER= \ + -e DB_POSTGRESDB_SCHEMA= \ + -e DB_POSTGRESDB_PASSWORD= \ + -v n8n_data:/home/node/.n8n \ + docker.n8n.io/n8nio/n8n +``` + +You can find a complete `docker-compose` file for PostgreSQL in the [n8n hosting repository](https://github.com/n8n-io/n8n-hosting/tree/main/docker-compose/withPostgres). + +## Setting timezone + +To define the timezone n8n should use, you can set the [`GENERIC_TIMEZONE` environment variable](/hosting/configuration/environment-variables/timezone-localization.md). Schedule-oriented nodes, like the [Schedule Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.scheduletrigger/index.md) use this to determine the correct timezone. + +You can set the system timezone, which controls what some scripts and commands like `date` return, using the `TZ` environment variable. + +This example sets the same timezone for both variables: + +```sh +docker volume create n8n_data + +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -e GENERIC_TIMEZONE="Europe/Berlin" \ + -e TZ="Europe/Berlin" \ + -v n8n_data:/home/node/.n8n \ + docker.n8n.io/n8nio/n8n +``` + +## Updating + +To update n8n, in Docker Desktop, navigate to the **Images** tab and select **Pull** from the context menu to download the latest n8n image: + +![Docker Desktop](/_images/hosting/installation/docker/docker_desktop.png) + +You can also use the command line to pull the latest, or a specific version: + +```sh +# Pull latest (stable) version +docker pull docker.n8n.io/n8nio/n8n + +# Pull specific version +docker pull docker.n8n.io/n8nio/n8n:1.81.0 + +# Pull next (unstable) version +docker pull docker.n8n.io/n8nio/n8n:next +``` + +After pulling the updated image, stop your n8n container and start it again. You can also use the command line. Replace `` in the commands below with the container ID you find in the first command: + +```sh +# Find your container ID +docker ps -a + +# Stop the container with the `` +docker stop + +# Remove the container with the `` +docker rm + +# Start the container +docker run --name= [options] -d docker.n8n.io/n8nio/n8n +``` + +### Updating Docker Compose + +--8<-- "_snippets/self-hosting/installation/docker-compose-updating.md" + +## Further reading + +You can find more information about Docker setup in the README file for the [Docker image](https://github.com/n8n-io/n8n/tree/master/docker/images/n8n). + +--8<-- "_snippets/self-hosting/installation/tunnel.md" + +Start n8n with `--tunnel` by running: + +```sh +docker volume create n8n_data + +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -v n8n_data:/home/node/.n8n \ + docker.n8n.io/n8nio/n8n \ + start --tunnel +``` + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/npm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# npm + +npm is a quick way to get started with n8n on your local machine. You must have [Node.js](https://nodejs.org/en/){:target=_blank .external-link} installed. n8n requires Node.js 18 or above. + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Try n8n with npx + +You can try n8n without installing it using npx. + +From the terminal, run: + +```bash +npx n8n +``` + +This command will download everything that's needed to start n8n. You can then access n8n and start building workflows by opening [http://localhost:5678](http://localhost:5678){:target=_blank .external-link}. + +## Install globally with npm + +To install n8n globally, use npm: + +```bash +npm install n8n -g +``` + +To install or update to a specific version of n8n use the `@` syntax to specify the version. For example: + +```bash +npm install -g n8n@0.126.1 +``` + +To install `next`: + +```bash +npm install -g n8n@next +``` + +After the installation, start n8n by running: + +```bash +n8n +# or +n8n start +``` + + +### Next steps + +Try out n8n using the [Quickstarts](/try-it-out/index.md). + +## Updating + +To update your n8n instance to the `latest` version, run: + +```bash +npm update -g n8n +``` + +To install the `next` version: + +```bash +npm install -g n8n@next +``` + +--8<-- "_snippets/self-hosting/installation/tunnel.md" + +Start n8n with `--tunnel` by running: + +```bash +n8n start --tunnel +``` + +## Reverting an upgrade + +Install the older version that you want to go back to. + +If the upgrade involved a database migration: + +1. Check the feature documentation and release notes to see if there are any manual changes you need to make. +1. Run `n8n db:revert` on your current version to roll back the database. If you want to revert more than one database migration, you need to repeat this process. + +## Windows troubleshooting + +If you are experiencing issues running n8n on Windows, make sure your Node.js environment is correctly set up. Follow Microsoft's guide to [Install NodeJS on Windows](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows){:target=_blank .external-link}. + + +# hosting/installation/server-setups/aws.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Hosting n8n on Amazon Web Services + +This hosting guide shows you how to self-host n8n with Amazon Web Services (AWS). It uses n8n with Postgres as a database backend using Kubernetes to manage the necessary resources and reverse proxy. + +## Hosting options + +AWS offers several ways suitable for hosting n8n, including EC2 (virtual machines), and EKS (containers running with Kubernetes). + +This guide uses [EKS](https://aws.amazon.com/eks/){:target=_blank .external-link} as the hosting option. Using Kubernetes requires some additional complexity and configuration, but is the best method for scaling n8n as demand changes. + +## Prerequisites + +The steps in this guide use a mix of the AWS UI and [the eksctl CLI tool for EKS](https://eksctl.io){:target=_blank .external-link}. + +While not mentioned in the documentation for eksctl, you also need to [install the AWS CLI tool](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html){:target=_blank .external-link}, and [configure authentication of the tool](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html){:target=_blank .external-link}. + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Create a cluster + +Use the eksctl tool to create a cluster specifying a name and a region with the following command: + +```shell +eksctl create cluster --name n8n --region +``` + +This can take a while to create the cluster. + + +Once the cluster is created, eksctl automatically sets the kubectl context to the cluster. + +## Clone configuration repository + +Kubernetes and n8n require a series of configuration files. You can clone these from [this repository](https://github.com/n8n-io/n8n-kubernetes-hosting/tree/aws){:target=_blank .external-link}. The following steps tell you what each file does, and what settings you need to change. + +Clone the repository with the following command: + +```shell +git clone https://github.com/n8n-io/n8n-kubernetes-hosting.git -b aws +``` + +And change directory to the root of the repository you cloned: + +```shell +cd n8n-kubernetes-hosting +``` + +## Configure Postgres + +For larger scale n8n deployments, Postgres provides a more robust database backend than SQLite. + +### Configure volume for persistent storage + +To maintain data between pod restarts, the Postgres deployment needs a persistent volume. The default AWS storage class, [gp2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/general-purpose.html#EBSVolumeTypes_gp2){:target=_blank .external-link}, is suitable for this purpose. This is defined in the `postgres-claaim0-persistentvolumeclaim.yaml` manifest. + +```yaml +… +spec: + storageClassName: gp2 + accessModes: + - ReadWriteOnce +… +``` + +### Postgres environment variables + +Postgres needs some environment variables set to pass to the application running in the containers. + +The example `postgres-secret.yaml` file contains placeholders you need to replace with values of your own for user details and the database to use. + +The `postgres-deployment.yaml` manifest then uses the values from this manifest file to send to the application pods. + +## Configure n8n + +### Create a volume for file storage + +While not essential for running n8n, using persistent volumes helps maintain files uploaded while using n8n and if you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables/deployment.md) between restarts, which saves a file containing the key into file storage during startup. + +The `n8n-claim0-persistentvolumeclaim.yaml` manifest creates this, and the n8n Deployment mounts that claim in the `volumes` section of the `n8n-deployment.yaml` manifest. + +```yaml +… +volumes: + - name: n8n-claim0 + persistentVolumeClaim: + claimName: n8n-claim0 +… +``` + +### Pod resources + +[Kubernetes](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/){:target=_blank .external-link} lets you specify the minimum resources application containers need and the limits they can run to. The example YAML files cloned above contain the following in the `resources` section of the `n8n-deployment.yaml` file: + +```yaml +… +resources: + requests: + memory: "250Mi" + limits: + memory: "500Mi" +… +``` + +This defines a minimum of 250mb per container, a maximum of 500mb, and lets Kubernetes handle CPU. You can change these values to match your own needs. As a guide, here are the resources values for the n8n cloud offerings: + +--8<-- "_snippets/self-hosting/installation/suggested-pod-resources.md" + +### Optional: Environment variables + +You can configure n8n settings and behaviors using environment variables. + +Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. + +## Deployments + +The two deployment manifests (`n8n-deployment.yaml` and `postgres-deployment.yaml`) define the n8n and Postgres applications to Kubernetes. + +The manifests define the following: + +- Send the environment variables defined to each application pod +- Define the container image to use +- Set resource consumption limits +- The `volumes` defined earlier and `volumeMounts` to define the path in the container to mount volumes. +- Scaling and restart policies. The example manifests define one instance of each pod. You should change this to meet your needs. + +## Services + +The two service manifests (`postgres-service.yaml` and `n8n-service.yaml`) expose the services to the outside world using the Kubernetes load balancer using ports 5432 and 5678 respectively by default. + +## Send to Kubernetes cluster + +Send all the manifests to the cluster by running the following command in the `n8n-kubernetes-hosting` directory: + +```shell +kubectl apply -f . +``` + +/// note | Namespace error +You may see an error message about not finding an "n8n" namespace as that resources isn't ready yet. You can run the same command again, or apply the namespace manifest first with the following command: + +```shell +kubectl apply -f namespace.yaml +``` +/// + + +## Set up DNS + +n8n typically operates on a subdomain. Create a DNS record with your provider for the subdomain and point it to a static address of the instance. + +To find the address of the n8n service running on the instance: + +1. Open the **Clusters** section of the **Amazon Elastic Kubernetes Service** page in the AWS console. +2. Select the name of the cluster to open its configuration page. +3. Select the **Resources** tab, then **Service and networking** > **Services**. +4. Select the **n8n** service and copy the **Load balancer URLs** value. Use this value suffixed with the n8n service port (5678) for DNS. + +/// note | Use HTTP +This guide uses HTTP connections for the services it defines, for example in `n8n-deployment.yaml`. However, if you click the **Load balancer URLs** value, EKS takes you to an "HTTPS" URL which results in an error. To solve this, when you open the n8n subdomain, make sure to use HTTP. +/// +## Delete resources + +If you need to delete the setup, you can remove the resources created by the manifests with the following command: + +```shell +kubectl delete -f . +``` + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/azure.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Hosting n8n on Azure + +This hosting guide shows you how to self-host n8n on Azure. It uses n8n with Postgres as a database backend using Kubernetes to manage the necessary resources and reverse proxy. + +## Prerequisites + +You need [The Azure command line tool](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli){:target="_blank" .external-link} + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Hosting options + +Azure offers several ways suitable for hosting n8n, including Azure Container Instances (optimized for running containers), Linux Virtual Machines, and Azure Kubernetes Service (containers running with Kubernetes). + +This guide uses the Azure Kubernetes Service (AKS) as the hosting option. Using Kubernetes requires some additional complexity and configuration, but is the best method for scaling n8n as demand changes. + +The steps in this guide use a mix of the Azure UI and command line tool, but you can use either to accomplish most tasks. + +## Open the Azure Kubernetes Service + +From [the Azure portal](https://portal.azure.com/){:target="_blank" .external-link} select **Kubernetes services**. + +## Create a cluster + +From the Kubernetes services page, select **Create** > **Create a Kubernetes cluster**. + +You can select any of the configuration options that suit your needs, then select **Create** when done. + +## Set Kubectl context + +The remainder of the steps in this guide require you to set the Azure instance as the Kubectl context. You can find the connection details for a cluster instance by opening its details page and then the **Connect** button. The resulting code snippets shows the steps to paste and run into a terminal to change your local Kubernetes settings to use the new cluster. + +## Clone configuration repository + +Kubernetes and n8n require a series of configuration files. You can clone these from [this repository](https://github.com/n8n-io/n8n-kubernetes-hosting/tree/azure){:target=_blank .external-link}. The following steps tell you which file configures what and what you need to change. + +Clone the repository with the following command: + +```shell +git clone https://github.com/n8n-io/n8n-kubernetes-hosting.git -b azure +``` + +And change directory to the root of the repository you cloned: + +```shell +cd azure +``` + +## Configure Postgres + +For larger scale n8n deployments, Postgres provides a more robust database backend than SQLite. + +### Configure volume for persistent storage + +To maintain data between pod restarts, the Postgres deployment needs a persistent volume. The default storage class is suitable for this purpose and is defined in the `postgres-claim0-persistentvolumeclaim.yaml` manifest. + +/// note | Specialized storage classes +If you have specialised or higher requirements for storage classes, [read more on the options Azure offers in the documentation](https://learn.microsoft.com/en-us/azure/aks/concepts-storage#storage-classes){:target="_blank" .external-link}. +/// +### Postgres environment variables + +Postgres needs some environment variables set to pass to the application running in the containers. + +The example `postgres-secret.yaml` file contains placeholders you need to replace with your own values. Postgres will use these details when creating the database.. + +The `postgres-deployment.yaml` manifest then uses the values from this manifest file to send to the application pods. + +## Configure n8n + +### Create a volume for file storage + +While not essential for running n8n, using persistent volumes is required for: + +* Using nodes that interact with files, such as the binary data node. +* If you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables/deployment.md) between restarts. This saves a file containing the key into file storage during startup. + +The `n8n-claim0-persistentvolumeclaim.yaml` manifest creates this, and the n8n Deployment mounts that claim in the `volumes` section of the `n8n-deployment.yaml` manifest. + +```yaml +… +volumes: + - name: n8n-claim0 + persistentVolumeClaim: + claimName: n8n-claim0 +… +``` + +### Pod resources + +[Kubernetes lets you](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/){:target="_blank" .external-link} optionally specify the minimum resources application containers need and the limits they can run to. The example YAML files cloned above contain the following in the `resources` section of the `n8n-deployment.yaml` file: + +```yaml +… +resources: + requests: + memory: "250Mi" + limits: + memory: "500Mi" +… +``` + +This defines a minimum of 250mb per container, a maximum of 500mb, and lets Kubernetes handle CPU. You can change these values to match your own needs. As a guide, here are the resources values for the n8n cloud offerings: + +--8<-- "_snippets/self-hosting/installation/suggested-pod-resources.md" + +### Optional: Environment variables + +You can configure n8n settings and behaviors using environment variables. + +Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. + +## Deployments + +The two deployment manifests (`n8n-deployment.yaml` and `postgres-deployment.yaml`) define the n8n and Postgres applications to Kubernetes. + +The manifests define the following: + +- Send the environment variables defined to each application pod +- Define the container image to use +- Set resource consumption limits with the `resources` object +- The `volumes` defined earlier and `volumeMounts` to define the path in the container to mount volumes. +- Scaling and restart policies. The example manifests define one instance of each pod. You should change this to meet your needs. + +## Services + +The two service manifests (`postgres-service.yaml` and `n8n-service.yaml`) expose the services to the outside world using the Kubernetes load balancer using ports 5432 and 5678 respectively. + +## Send to Kubernetes cluster + +Send all the manifests to the cluster with the following command: + +```shell +kubectl apply -f . +``` + +/// note | Namespace error +You may see an error message about not finding an "n8n" namespace as that resources isn't ready yet. You can run the same command again, or apply the namespace manifest first with the following command: + +```shell +kubectl apply -f namespace.yaml +``` +/// + + +## Set up DNS + +n8n typically operates on a subdomain. Create a DNS record with your provider for the subdomain and point it to the IP address of the n8n service. Find the IP address of the n8n service from the **Services & ingresses** menu item of the cluster you want to use under the **External IP** column. You need to add the n8n port, "5678" to the URL. + +/// note | Static IP addresses with AKS +[Read this tutorial](https://learn.microsoft.com/en-us/azure/aks/static-ip){:target="_blank" .external-link} for more details on how to use a static IP address with AKS. +/// +## Delete resources + +Remove the resources created by the manifests with the following command: + +```shell +kubectl delete -f . +``` + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/digital-ocean.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Hosting n8n on DigitalOcean + +This hosting guide shows you how to self-host n8n on a DigitalOcean droplet. It uses: + +* [Caddy](https://caddyserver.com){:target="_blank" .external-link} (a reverse proxy) to allow access to the Droplet from the internet. Caddy will also automatically create and manage SSL / TLS certificates for your n8n instance. +* [Docker Compose](https://docs.docker.com/compose/){:target="_blank" .external-link} to create and define the application components and how they work together. + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Create a Droplet + +1. [Log in](https://cloud.digitalocean.com/login){:target=_blank .external-link} to DigitalOcean. +2. Select the project to host the Droplet, or [create a new project](https://docs.digitalocean.com/products/projects/how-to/create/){:target=_blank .external-link}. +3. In your project, select **Droplets** from the **Manage** menu. +4. [Create a new Droplet](https://docs.digitalocean.com/products/droplets/how-to/create/){:target=_blank .external-link} using the [Docker image](https://marketplace.digitalocean.com/apps/docker){:target="_blank" .external-link} available on the **Marketplace** tab. + +/// note | Droplet resources +When creating the Droplet, DigitalOcean asks you to choose a plan. For most usage levels, a basic shared CPU plan is enough. +/// +/// note | SSH key or Password +DigitalOcean lets you choose between SSH key and password-based authentication. SSH keys are considered more secure. +/// +## Log in to your Droplet and create new user + +The rest of this guide requires you to log in to the Droplet using a terminal with SSH. Refer to [How to Connect to Droplets with SSH](https://docs.digitalocean.com/products/droplets/how-to/connect-with-ssh/){:target="_blank" .external-link} for more information. + +You should create a new user, to avoid working as the root user: + +1. Log in as root. +2. Create a new user: + ```shell + adduser + ``` +3. Follow the prompts in the CLI to finish creating the user. +4. Grant the new user administrative privileges: + ```shell + usermod -aG sudo + ``` + You can now run commands with superuser privileges by using `sudo` before the command. +5. Follow the steps to set up SSH for the new user: [Add Public Key Authentication](https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-14-04#step-four-add-public-key-authentication-recommended){:target=_blank .external-link}. +5. Log out of the droplet. +6. Log in using SSH as the new user. + +## Clone configuration repository + +Docker Compose, n8n, and Caddy require a series of folders and configuration files. You can clone these from [this repository](https://github.com/n8n-io/n8n-docker-caddy){:target=_blank .external-link} into the home folder of the logged-in user on your Droplet. The following steps will tell you which file to change and what changes to make. + +Clone the repository with the following command: + +```shell +git clone https://github.com/n8n-io/n8n-docker-caddy.git +``` + +And change directory to the root of the repository you cloned: + +```shell +cd n8n-docker-caddy +``` + +## Default folders and files + +The host operating system (the DigitalOcean Droplet) copies the two folders you created to Docker containers to make them available to Docker. The two folders are: + +- `caddy_config`: Holds the Caddy configuration files. +- `local_files`: A folder for files you upload or add using n8n. + +### Create Docker volumes + +To persist the Caddy cache between restarts and speed up start times, create [a Docker volume](https://docs.docker.com/storage/volumes/){:target="_blank" .external-link} that Docker reuses between restarts: + +```shell +sudo docker volume create caddy_data +``` + +Create a Docker volume for the n8n data: + +```shell +sudo docker volume create n8n_data +``` + +## Set up DNS + +n8n typically operates on a subdomain. Create a DNS record with your provider for the subdomain and point it to the IP address of the Droplet. The exact steps for this depend on your DNS provider, but typically you need to create a new "A" record for the n8n subdomain. DigitalOcean provide [An Introduction to DNS Terminology, Components, and Concepts](https://www.digitalocean.com/community/tutorials/an-introduction-to-dns-terminology-components-and-concepts){:target="_blank" .external-link}. + +## Open ports + +n8n runs as a web application, so the Droplet needs to allow incoming access to traffic on port 80 for non-secure traffic, and port 443 for secure traffic. + +Open the following ports in the Droplet's firewall by running the following two commands: + +```shell +sudo ufw allow 80 +sudo ufw allow 443 +``` + +## Configure n8n + +n8n needs some environment variables set to pass to the application running in the Docker container. The example `.env` file contains placeholders you need to replace with values of your own. + +Open the file with the following command: + +```shell +nano .env +``` + +The file contains inline comments to help you know what to change. + +Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. + +## The Docker Compose file + +The Docker Compose file (`docker-compose.yml`) defines the services the application needs, in this case Caddy and n8n. + +- The Caddy service definition defines the ports it uses and the local volumes to copy to the containers. +- The n8n service definition defines the ports it uses, the environment variables n8n needs to run (some defined in the `.env` file), and the volumes it needs to copy to the containers. + +The Docker Compose file uses the environment variables set in the `.env` file, so you shouldn't need to change it's content, but to take a look, run the following command: + +```shell +nano docker-compose.yml +``` + +## Configure Caddy + +Caddy needs to know which domains it should serve, and which port to expose to the outside world. Edit the `Caddyfile` file in the `caddy_config` folder. + +```shell +nano caddy_config/Caddyfile +``` + +Change the placeholder domain to yours. If you followed the steps to name the subdomain n8n, your full domain is similar to `n8n.example.com`. The `n8n` in the `reverse_proxy` setting tells Caddy to use the service definition defined in the `docker-compose.yml` file: + +```text +n8n.. { + reverse_proxy n8n:5678 { + flush_interval -1 + } +} +``` + +If you were to use `automate.example.com`, your `Caddyfile` may look something like: + +```text +automate.example.com { + reverse_proxy n8n:5678 { + flush_interval -1 + } +} +``` + +## Start Docker Compose + +Start n8n and Caddy with the following command: + +```shell +sudo docker compose up -d +``` + +This may take a few minutes. + +## Test your setup + +In your browser, open the URL formed of the subdomain and domain name defined earlier. Enter the user name and password defined earlier, and you should be able to access n8n. + +## Stop n8n and Caddy + +You can stop n8n and Caddy with the following command: + +```shell +sudo docker compose stop +``` +## Updating + +--8<-- "_snippets/self-hosting/installation/docker-compose-updating.md" + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/docker-compose.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +description: Install and run n8n using Docker Compose +--- + +# Docker-Compose + +If you have already installed Docker and Docker-Compose, then you can start with [step 3](#3-dns-setup). + +You can find Docker Compose configurations for various architectures in the [n8n-hosting repository](https://github.com/n8n-io/n8n-hosting). + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## 1. Install Docker and Docker Compose + +How you install Docker and Docker Compose can vary depending on the Linux distribution you use. You can find detailed instructions in both the [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installation documentation. The following example is for Ubuntu: + +```bash +# Remove incompatible or out of date Docker implementations if they exist +for pkg in docker.io docker-doc docker-compose docker-compose-v2 podman-docker containerd runc; do sudo apt-get remove $pkg; done +# Install prereq packages +sudo apt-get update +sudo apt-get install ca-certificates curl +# Download the repo signing key +sudo install -m 0755 -d /etc/apt/keyrings +sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc +sudo chmod a+r /etc/apt/keyrings/docker.asc +# Configure the repository +echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null + +# Update and install Docker and Docker Compose +sudo apt-get update +sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin +``` + +Verify that Docker and Docker Compose are available by typing: + +```bash +docker --version +docker compose version +``` + +## 2. Optional: Non-root user access + +You can optionally grant access to run Docker without the `sudo` command. + +To grant access to the user that you're currently logged in with (assuming they have `sudo` access), run: + +```bash +sudo usermod -aG docker ${USER} +# Register the `docker` group memebership with current session without changing your primary group +exec sg docker newgrp +``` + +To grant access to a different user, type the following, substituting `` with the appropriate username: + +```bash +sudo usermod -aG docker +``` + +You will need to run `exec sg docker newgrp` from any of that user's existing sessions for it to access the new group permissions. + +You can verify that your current session recognizes the `docker` group by typing: + +```bash +groups +``` + +## 3. DNS setup + +To host n8n online or on a network, create a dedicated subdomain pointed at your server. + +Add an A record to route the subdomain accordingly: + +* **Type**: A +* **Name**: `n8n` (or the desired subdomain) +* **IP address**: (your server's IP address) + +## 4. Create an `.env` file + +Create a project directory to store your n8n environment configuration and Docker Compose files and navigate inside: + +```bash +mkdir n8n-compose +cd n8n-compose +``` + +Inside the `n8n-compose` directory, create an `.env` file to customize your n8n instance's details. Change it to match your own information: + +```bash title=".env file" +# DOMAIN_NAME and SUBDOMAIN together determine where n8n will be reachable from +# The top level domain to serve from +DOMAIN_NAME=example.com + +# The subdomain to serve from +SUBDOMAIN=n8n + +# The above example serve n8n at: https://n8n.example.com + +# Optional timezone to set which gets used by Cron and other scheduling nodes +# New York is the default value if not set +GENERIC_TIMEZONE=Europe/Berlin + +# The email address to use for the TLS/SSL certificate creation +SSL_EMAIL=user@example.com +``` + +## 5. Create local files directory + +Inside your project directory, create a directory called `local-files` for sharing files between the n8n instance and the host system (for example, using the [Read/Write Files from Disk node](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md)): + +```bash +mkdir local-files +``` + +The Docker Compose file below can automatically create this directory, but doing it manually ensures that it's created with the right ownership and permissions. + +## 6. Create Docker Compose file + +Create a `compose.yaml` file. Paste the following in the file: + +```yaml title="compose.yaml file" +services: + traefik: + image: "traefik" + restart: always + command: + - "--api.insecure=true" + - "--providers.docker=true" + - "--providers.docker.exposedbydefault=false" + - "--entrypoints.web.address=:80" + - "--entrypoints.web.http.redirections.entryPoint.to=websecure" + - "--entrypoints.web.http.redirections.entrypoint.scheme=https" + - "--entrypoints.websecure.address=:443" + - "--certificatesresolvers.mytlschallenge.acme.tlschallenge=true" + - "--certificatesresolvers.mytlschallenge.acme.email=${SSL_EMAIL}" + - "--certificatesresolvers.mytlschallenge.acme.storage=/letsencrypt/acme.json" + ports: + - "80:80" + - "443:443" + volumes: + - traefik_data:/letsencrypt + - /var/run/docker.sock:/var/run/docker.sock:ro + + n8n: + image: docker.n8n.io/n8nio/n8n + restart: always + ports: + - "127.0.0.1:5678:5678" + labels: + - traefik.enable=true + - traefik.http.routers.n8n.rule=Host(`${SUBDOMAIN}.${DOMAIN_NAME}`) + - traefik.http.routers.n8n.tls=true + - traefik.http.routers.n8n.entrypoints=web,websecure + - traefik.http.routers.n8n.tls.certresolver=mytlschallenge + - traefik.http.middlewares.n8n.headers.SSLRedirect=true + - traefik.http.middlewares.n8n.headers.STSSeconds=315360000 + - traefik.http.middlewares.n8n.headers.browserXSSFilter=true + - traefik.http.middlewares.n8n.headers.contentTypeNosniff=true + - traefik.http.middlewares.n8n.headers.forceSTSHeader=true + - traefik.http.middlewares.n8n.headers.SSLHost=${DOMAIN_NAME} + - traefik.http.middlewares.n8n.headers.STSIncludeSubdomains=true + - traefik.http.middlewares.n8n.headers.STSPreload=true + - traefik.http.routers.n8n.middlewares=n8n@docker + environment: + - N8N_HOST=${SUBDOMAIN}.${DOMAIN_NAME} + - N8N_PORT=5678 + - N8N_PROTOCOL=https + - NODE_ENV=production + - WEBHOOK_URL=https://${SUBDOMAIN}.${DOMAIN_NAME}/ + - GENERIC_TIMEZONE=${GENERIC_TIMEZONE} + volumes: + - n8n_data:/home/node/.n8n + - ./local-files:/files + +volumes: + n8n_data: + traefik_data: +``` + +The above Docker Compose file configures two containers: one for n8n, and one to run [traefik](https://github.com/traefik/traefik), an application proxy to manage TLS/SSL certificates and handle routing. + +It also creates and mounts two [Docker Volumes](https://docs.docker.com/engine/storage/volumes/) and mounts the `local-files` directory you created earlier: + + | Name | Type | Container mount | Description | + |-----------------|-------------------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------| + | `n8n_data` | [Volume](https://docs.docker.com/engine/storage/volumes/) | `/home/node/.n8n` | Where n8n saves its SQLite database file and encryption key. | + | `traefik_data` | [Volume](https://docs.docker.com/engine/storage/volumes/) | `/letsencrypt` | Where traefik saves the TLS/SSL certificate data. | + | `./local-files` | [Bind](https://docs.docker.com/engine/storage/bind-mounts/) | `/files` | A local directory shared between the n8n instance and host. In n8n, use the `/files` path to read from and write to this directory. | + +## 7. Start Docker Compose + +You can now start n8n by typing: + +```bash +sudo docker compose up -d +``` + +To stop the container, type: + +```bash +sudo docker compose stop +``` + +## 8. Done + +You can now reach n8n using the subdomain + domain combination you defined in your `.env` file configuration. The above example would result in `https://n8n.example.com`. + +n8n is only accessible using secure HTTPS, not over plain HTTP. + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/google-cloud.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Hosting n8n on Google Cloud + +This hosting guide shows you how to self-host n8n on Google Cloud (GCP). It uses n8n with Postgres as a database backend using Kubernetes to manage the necessary resources and reverse proxy. + +## Prerequisites + +- The [gcloud command line tool](https://cloud.google.com/sdk/gcloud/){:target="_blank" .external-link} +- The [gke-gcloud-auth-plugin](https://cloud.google.com/blog/products/containers-kubernetes/kubectl-auth-changes-in-gke){:target="_blank" .external-link} (install the gcloud CLI first) + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Hosting options + +Google Cloud offers several options suitable for hosting n8n, including Cloud Run (optimized for running containers), Compute Engine (VMs), and Kubernetes Engine (containers running with Kubernetes). + +This guide uses the Google Kubernetes Engine (GKE) as the hosting option. Using Kubernetes requires some additional complexity and configuration, but is the best method for scaling n8n as demand changes. + +Most of the steps in this guide use the Google Cloud UI, but you can also use the [gcloud command line tool](https://cloud.google.com/sdk/gcloud/){:target="_blank" .external-link} instead to undertake all the steps. + +## Create project + +GCP encourages you to create projects to logically organize resources and configuration. Create a new project for your n8n deployment from your Google Cloud Console: select the project dropdown menu and then the **NEW PROJECT** button. Then select the newly created project. As you follow the other steps in this guide, make sure you have the correct project selected. + +## Enable the Kubernetes Engine API + +GKE isn't enabled by default. Search for "Kubernetes" in the top search bar and select "Kubernetes Engine" from the results. + +Select **ENABLE** to enable the Kubernetes Engine API for this project. + +## Create a cluster + +From the [GKE service page](https://console.cloud.google.com/kubernetes/list/overview){:target=_blank .external-link}, select **Clusters** > **CREATE**. Make sure you select the "Standard" cluster option, n8n doesn't work with an "Autopilot" cluster. You can leave the cluster configuration on defaults unless there's anything specifically you need to change, such as location. + +## Set Kubectl context + +The rest of the steps in this guide require you to set the GCP instance as the Kubectl context. You can find the connection details for a cluster instance by opening its details page and selecting **CONNECT**. The displayed code snippet shows a connection string for the gcloud CLI tool. Paste and run the code snippet in the gcloud CLI to change your local Kubernetes settings to use the new gcloud cluster. + +## Clone configuration repository + +Kubernetes and n8n require a series of configuration files. You can clone these from [this repository](https://github.com/n8n-io/n8n-kubernetes-hosting/tree/gcp){:target=_blank .external-link} locally. The following steps explain the file configuration and how to add your information. + +Clone the repository with the following command: + +```shell +git clone https://github.com/n8n-io/n8n-kubernetes-hosting.git -b gcp +``` + +And change directory to the root of the repository you cloned: + +```shell +cd n8n-kubernetes-hosting +``` + +## Configure Postgres + +For larger scale n8n deployments, Postgres provides a more robust database backend than SQLite. + +### Create a volume for persistent storage + +To maintain data between pod restarts, the Postgres deployment needs a persistent volume. Running Postgres on GCP requires a specific Kubernetes Storage Class. You can read [this guide](https://cloud.google.com/architecture/deploying-highly-available-postgresql-with-gke){:target="_blank" .external-link} for specifics, but the `storage.yaml` manifest creates it for you. You may want to change the regions to create the storage in under the `allowedTopologies` > `matchedLabelExpressions` > `values` key. By default, they're set to `us-central`. + +```yaml +… +allowedTopologies: + - matchLabelExpressions: + - key: failure-domain.beta.kubernetes.io/zone + values: + - us-central1-b + - us-central1-c +``` + +### Postgres environment variables + +Postgres needs some environment variables set to pass to the application running in the containers. + +The example `postgres-secret.yaml` file contains placeholders you need to replace with your own values. Postgres will use these details when creating the database.. + +The `postgres-deployment.yaml` manifest then uses the values from this manifest file to send to the application pods. + +## Configure n8n + +### Create a volume for file storage + +While not essential for running n8n, using persistent volumes is required for: + +* Using nodes that interact with files, such as the binary data node. +* If you want to persist [manual n8n encryption keys](/hosting/configuration/environment-variables/deployment.md) between restarts. This saves a file containing the key into file storage during startup. + +The `n8n-claim0-persistentvolumeclaim.yaml` manifest creates this, and the n8n Deployment mounts that claim in the `volumes` section of the `n8n-deployment.yaml` manifest. + +```yaml +… +volumes: + - name: n8n-claim0 + persistentVolumeClaim: + claimName: n8n-claim0 +… +``` + +### Pod resources + +[Kubernetes lets you](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) optionally specify the minimum resources application containers need and the limits they can run to. The example YAML files cloned above contain the following in the `resources` section of the `n8n-deployment.yaml` and `postgres-deployment.yaml` files: + +```yaml +… +resources: + requests: + memory: "250Mi" + limits: + memory: "500Mi" +… +``` + +This defines a minimum of 250mb per container, a maximum of 500mb, and lets Kubernetes handle CPU. You can change these values to match your own needs. As a guide, here are the resources values for the n8n cloud offerings: + +--8<-- "_snippets/self-hosting/installation/suggested-pod-resources.md" + +### Optional: Environment variables + +You can configure n8n settings and behaviors using environment variables. + +Create an `n8n-secret.yaml` file. Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. + +## Deployments + +The two deployment manifests (`n8n-deployment.yaml` and `postgres-deployment.yaml`) define the n8n and Postgres applications to Kubernetes. + +The manifests define the following: + +- Send the environment variables defined to each application pod +- Define the container image to use +- Set resource consumption limits with the `resources` object +- The `volumes` defined earlier and `volumeMounts` to define the path in the container to mount volumes. +- Scaling and restart policies. The example manifests define one instance of each pod. You should change this to meet your needs. + +## Services + +The two service manifests (`postgres-service.yaml` and `n8n-service.yaml`) expose the services to the outside world using the Kubernetes load balancer using ports 5432 and 5678 respectively. + +## Send to Kubernetes cluster + +Send all the manifests to the cluster with the following command: + +```shell +kubectl apply -f . +``` + +/// note | Namespace error +You may see an error message about not finding an "n8n" namespace as that resources isn't ready yet. You can run the same command again, or apply the namespace manifest first with the following command: + +```shell +kubectl apply -f namespace.yaml +``` +/// + + +## Set up DNS + +n8n typically operates on a subdomain. Create a DNS record with your provider for the subdomain and point it to the IP address of the n8n service. Find the IP address of the n8n service from the **Services & Ingress** menu item of the cluster you want to use under the **Endpoints** column. + +/// note | GKE and IP addresses +[Read this GKE tutorial](https://cloud.google.com/kubernetes-engine/docs/tutorials/configuring-domain-name-static-ip#configuring_your_domain_name_records){:target="_blank" .external-link} for more details on how reserved IP addresses work with GKE and Kubernetes resources. +/// +## Delete resources + +Remove the resources created by the manifests with the following command: + +```shell +kubectl delete -f . +``` + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/heroku.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Hosting n8n on Heroku + +This hosting guide shows you how to self-host n8n on Heroku. It uses: + + +- [Docker Compose](https://docs.docker.com/compose/){:target="_blank" .external-link} to create and define the application components and how they work together. +- [Heroku's PostgreSQL service](https://devcenter.heroku.com/categories/heroku-postgres){:target="_blank" .external-link} to host n8n's data storage. +- A **Deploy to Heroku** button offering a one click, with minor configuration, deployment. + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + + +## Use the deployment template to create a Heroku project + +The quickest way to get started with deploying n8n to Heroku is using the **Deploy to Heroku** button: + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://dashboard.heroku.com/new?template=https://github.com/n8n-io/n8n-heroku/tree/main) + +This opens the **Create New App** page on Heroku. Set a name for the project, and choose the region to deploy the project to. + +### Configure environment variables + +Heroku pre-fills the configuration options defined in the `env` section of the `app.json` file, which also sets default values for the environment variables n8n uses. + +You can change any of these values to suit your needs. You must change the following values: + +- **N8N_ENCRYPTION_KEY**, which n8n uses to [encrypt user account details](/hosting/configuration/environment-variables/deployment.md) before saving to the database. +- **WEBHOOK_URL** should match the application name you create to ensure that webhooks have the correct URL. + +### Deploy n8n + +Select **Deploy app**. + +After Heroku builds and deploys the app it provides links to **Manage App** or **View** the application. + +/// note | Heroku and DNS +Refer to the [Heroku documentation](https://devcenter.heroku.com/categories/networking-dns){:target="_blank" .external-link} to find out how to connect your domain to a Heroku application. +/// +## Changing the deployment template + +You can make changes to the deployment template by forking the [repository](https://github.com/n8n-io/n8n-heroku){:target=_blank .external-link} and deploying from you fork. + +### The Dockerfile + +By default the Dockerfile pulls the latest n8n image, if you want to use a different or fixed version, then update the image tag on the top line of the `Dockerfile`. + +### Heroku and exposing ports + +Heroku doesn't allow Docker-based applications to define an exposed port with the `EXPOSE` command. Instead, Heroku provides a `PORT` environment variable that it dynamically populates at application runtime. The `entrypoint.sh` file overrides the default Docker image command to instead set the port variable that Heroku provides. You can then access n8n on port 80 in a web browser. + +/// note | Docker limitations with Heroku +[Read this guide](https://devcenter.heroku.com/articles/container-registry-and-runtime#unsupported-dockerfile-commands){:target="_blank" .external-link} for more details on the limitations of using Docker with Heroku. +/// +### Configuring Heroku + +The `heroku.yml` file defines the application you want to create on Heroku. It consists of two sections: + +* `setup` > `addons` defines the Heroku addons to use. In this case, the PostgreSQL database addon. +* The `build` section defines how Heroku builds the application. In this case it uses the Docker buildpack to build a `web` service based on the supplied `Dockerfile`. + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/hetzner.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Hosting n8n on Hetzner cloud + +This hosting guide shows you how to self-host n8n on a Hetzner cloud server. It uses: + +* [Caddy](https://caddyserver.com){:target="_blank" .external-link} (a reverse proxy) to allow access to the Server from the internet. +* [Docker Compose](https://docs.docker.com/compose/){:target="_blank" .external-link} to create and define the application components and how they work together. + +--8<-- "_snippets/self-hosting/warning.md" + +--8<-- "_snippets/self-hosting/installation/latest-next-version.md" + +## Create a server + +1. [Log in](https://console.hetzner.cloud/){:target=_blank .external-link} to the Hetzner Cloud Console. +2. Select the project to host the server, or create a new project by selecting **+ NEW PROJECT**. +3. Select **+ CREATE SERVER** on the project tile you want to add it to. + +You can change most of the settings to suit your needs, but as this guide uses Docker to run the application, under the **Image** section, select "Docker CE" from the **APPS** tab. + +/// note | Type +When creating the server, Hetzner asks you to choose a plan. For most usage levels, the CPX11 type is enough. +/// +/// note | SSH keys +Hetzner lets you choose between SSH and password-based authentication. SSH is more secure. The rest of this guide assumes you are using SSH. +/// +## Log in to your server + +The rest of this guide requires you to log in to the server using a terminal with SSH. Refer to [Access with SSH/rsync/BorgBackup](https://docs.hetzner.com/robot/storage-box/access/access-ssh-rsync-borg){:target="_blank" .external-link} for more information. You can find the public IP in the listing of the servers in your project. + +## Install Docker Compose + +The Hetzner Docker app image doesn't have Docker compose installed. Install it with the following commands: + +```shell +apt update && apt -y upgrade +apt install docker-compose-plugin +``` + +## Clone configuration repository + +Docker Compose, n8n, and Caddy require a series of folders and configuration files. You can clone these from [this repository](https://github.com/n8n-io/n8n-docker-caddy){:target=_blank .external-link} into the root user folder of the server. The following steps will tell you which file to change and what changes to make. + +Clone the repository with the following command: + +```shell +git clone https://github.com/n8n-io/n8n-docker-caddy.git +``` + +And change directory to the root of the repository you cloned: + +```shell +cd n8n-docker-caddy +``` + +## Default folders and files + +The host operating system (the server) copies the two folders you created to Docker containers to make them available to Docker. The two folders are: + +- `caddy_config`: Holds the Caddy configuration files. +- `local_files`: A folder for files you upload or add using n8n. + +### Create Docker volume + +To persist the Caddy cache between restarts and speed up start times, create [a Docker volume](https://docs.docker.com/storage/volumes/){:target="_blank" .external-link} that Docker reuses between restarts: + +```shell +docker volume create caddy_data +``` + +Create a Docker volume for the n8n data: + +```shell +sudo docker volume create n8n_data +``` + +## Set up DNS + +n8n typically operates on a subdomain. Create a DNS record with your provider for the subdomain and point it to the IP address of the server. The exact steps for this depend on your DNS provider, but typically you need to create a new "A" record for the n8n subdomain. DigitalOcean provide [An Introduction to DNS Terminology, Components, and Concepts](https://www.digitalocean.com/community/tutorials/an-introduction-to-dns-terminology-components-and-concepts){:target="_blank" .external-link}. + +## Open ports + +n8n runs as a web application, so the server needs to allow incoming access to traffic on port 80 for non-secure traffic, and port 443 for secure traffic. + +Open the following ports in the server's firewall by running the following two commands: + +```shell +sudo ufw allow 80 +sudo ufw allow 443 +``` + +## Configure n8n + +n8n needs some environment variables set to pass to the application running in the Docker container. The example `.env` file contains placeholders you need to replace with values of your own. + +Open the file with the following command: + +```shell +nano .env +``` + +The file contains inline comments to help you know what to change. + +Refer to [Environment variables](/hosting/configuration/environment-variables/index.md) for n8n environment variables details. + +## The Docker Compose file + +The Docker Compose file (`docker-compose.yml`) defines the services the application needs, in this case Caddy and n8n. + +- The Caddy service definition defines the ports it uses and the local volumes to copy to the containers. +- The n8n service definition defines the ports it uses, the environment variables n8n needs to run (some defined in the `.env` file), and the volumes it needs to copy to the containers. + +The Docker Compose file uses the environment variables set in the `.env` file, so you shouldn't need to change it's content, but to take a look, run the following command: + +```shell +nano docker-compose.yml +``` + +## Configure Caddy + +Caddy needs to know which domains it should serve, and which port to expose to the outside world. Edit the `Caddyfile` file in the `caddy_config` folder. + +```shell +nano caddy_config/Caddyfile +``` + +Change the placeholder subdomain to yours. If you followed the steps to name the subdomain n8n, your full domain is similar to `n8n.example.com`. The `n8n` in the `reverse_proxy` setting tells Caddy to use the service definition defined in the `docker-compose.yml` file: + +```text +n8n.. { + reverse_proxy n8n:5678 { + flush_interval -1 + } +} +``` + +## Start Docker Compose + +Start n8n and Caddy with the following command: + +```shell +docker compose up -d +``` + +This may take a few minutes. + +## Test your setup + +In your browser, open the URL formed of the subdomain and domain name defined earlier. Enter the user name and password defined earlier, and you should be able to access n8n. + +## Stop n8n and Caddy + +You can stop n8n and Caddy with the following command: + +```shell +sudo docker compose stop +``` + +## Updating + +--8<-- "_snippets/self-hosting/installation/docker-compose-updating.md" + +## Next steps + +--8<-- "_snippets/self-hosting/installation/server-setups-next-steps.md" + + +# hosting/installation/server-setups/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Server setups + +Self-host with Docker Compose: + +* [Digital Ocean](/hosting/installation/server-setups/digital-ocean.md) +* [Heroku](/hosting/installation/server-setups/heroku.md) +* [Hetzner Cloud](/hosting/installation/server-setups/hetzner.md) + +Starting points for a Kubernetes setup: + +* [AWS](/hosting/installation/server-setups/aws.md) +* [Azure](/hosting/installation/server-setups/azure.md) +* [Google Cloud Platform](/hosting/installation/server-setups/google-cloud.md) + +Configuration guides to help you get started on other platforms: + +* [Docker Compose](/hosting/installation/server-setups/docker-compose.md) + + +# hosting/installation/updating.md + +--- +# https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Best practices for updating your self-hosted n8n +title: Update self-hosted n8n +contentType: explanation +tags: + - update npm + - update docker +hide: + - tags +--- + +# Update self-hosted n8n + +It's important to keep your n8n version up to date. This ensures you get the latest features and fixes. + +Some tips when updating: + +--8<-- "_snippets/manage-cloud/updating-best-practices.md" + +For instructions on how to update, refer to the documentation for your installation method: + +* [Installed with npm](/hosting/installation/npm.md) +* [Installed with Docker](/hosting/installation/docker.md) + + +# hosting/logging-monitoring/logging.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Logging in n8n + +Logging is an important feature for debugging. n8n uses the [winston](https://www.npmjs.com/package/winston){:target=_blank .external-link} logging library. + +/// note | Log streaming +n8n Self-hosted Enterprise tier includes [Log streaming](/log-streaming.md), in addition to the logging options described in this document. +/// +## Setup + +To set up logging in n8n, you need to set the following environment variables (you can also set the values in the [configuration file](/hosting/configuration/environment-variables/index.md)) + +| Setting in the configuration file | Using environment variables | Description | +|-----------------------------------|-----------------------------|-------------| +| n8n.log.level | N8N_LOG_LEVEL | The log output level. The available options are (from lowest to highest level) are error, warn, info, and debug. The default value is `info`. You can learn more about these options [here](#log-levels). | +| n8n.log.output | N8N_LOG_OUTPUT | Where to output logs. The available options are `console` and `file`. Multiple values can be used separated by a comma (`,`). `console` is used by default. | +| n8n.log.file.location | N8N_LOG_FILE_LOCATION | The log file location, used only if log output is set to file. By default, `/logs/n8n.log` is used. | +| n8n.log.file.maxsize | N8N_LOG_FILE_SIZE_MAX | The maximum size (in MB) for each log file. By default, n8n uses 16 MB. | +| n8n.log.file.maxcount | N8N_LOG_FILE_COUNT_MAX | The maximum number of log files to keep. The default value is 100. This value should be set when using workers. | + + +```bash +# Set the logging level to 'debug' +export N8N_LOG_LEVEL=debug + +# Set log output to both console and a log file +export N8N_LOG_OUTPUT=console,file + +# Set a save location for the log file +export N8N_LOG_FILE_LOCATION=/home/jim/n8n/logs/n8n.log + +# Set a 50 MB maximum size for each log file +export N8N_LOG_FILE_MAXSIZE=50 + +# Set 60 as the maximum number of log files to be kept +export N8N_LOG_FILE_MAXCOUNT=60 +``` + +### Log levels + +n8n uses standard log levels to report: + +- `silent`: outputs nothing at all +- `error`: outputs only errors and nothing else +- `warn`: outputs errors and warning messages +- `info`: contains useful information about progress +- `debug`: the most verbose output. n8n outputs a lot of information to help you debug issues. + + +## Development + +During development, adding log messages is a good practice. It assists in debugging errors. To configure logging for development, follow the guide below. + +### Implementation details + +n8n uses the `LoggerProxy` class, located in the `workflow` package. Calling the `LoggerProxy.init()` by passing in an instance of `Logger`, initializes the class before the usage. + +The initialization process happens only once. The [`start.ts`](https://github.com/n8n-io/n8n/blob/master/packages/cli/src/commands/start.ts) file already does this process for you. If you are creating a new command from scratch, you need to initialize the `LoggerProxy` class. + +Once the `Logger` implementation gets created in the `cli` package, it can be obtained by calling the `getInstance` convenience method from the exported module. + +Check the [start.ts](https://github.com/n8n-io/n8n/blob/master/packages/cli/src/commands/start.ts) file to learn more about how this process works. + +### Adding logs + +Once the `LoggerProxy` class gets initialized in the project, you can import it to any other file and add logs. + +Convenience methods are provided for all logging levels, so new logs can be added whenever needed using the format `Logger.('', ...meta)`, where `meta` represents any additional properties desired beyond `message`. + +In the example above, we use the standard log levels described [above](#log-levels). The `message` argument is a string, and `meta` is a data object. + +```js +// You have to import the LoggerProxy. We rename it to Logger to make it easier + +import { + LoggerProxy as Logger +} from 'n8n-workflow'; + +// Info-level logging of a trigger function, with workflow name and workflow ID as additional metadata properties + +Logger.info(`Polling trigger initiated for workflow "${workflow.name}"`, {workflowName: workflow.name, workflowId: workflow.id}); +``` + +When creating new loggers, some useful standards to keep in mind are: + +- Craft log messages to be as human-readable as possible. For example, always wrap names in quotes. +- Duplicating information in the log message and metadata, like workflow name in the above example, can be useful as messages are easier to search and metadata enables easier filtering. +- Include multiple IDs (for example, `executionId`, `workflowId`, and `sessionId`) throughout all logs. +- Use node types instead of node names (or both) as this is more consistent, and so easier to search. + +## Front-end logs + +As of now, front-end logs aren't available. Using `Logger` or `LoggerProxy` would yield errors in the `editor-ui` package. This functionality will get implemented in the future versions. + + +# hosting/logging-monitoring/monitoring.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Get metrics for a health check +contentType: howto +--- + +# Monitoring + +There are three API endpoints you can call to check the status of your instance: `/healthz`, `healthz/readiness`, and `/metrics`. + + +## healthz and healthz/readiness + +The `/healthz` endpoint returns a standard HTTP status code. 200 indicates the instance is reachable. It doesn't indicate DB status. It's available for both self-hosted and Cloud users. + +Access the endpoint: + +``` +/healthz +``` + +The `/healthz/readiness` endpoint is similar to the `/healthz` endpoint, but it returns a HTTP status code of 200 if the DB is connected and migrated and therefore the instance is ready to accept traffic. + +Access the endpoint: + +``` +/healthz/readiness +``` + + +## metrics + +The `/metrics` endpoint provides more detailed information about the current status of the instance. + +Access the endpoint: + +``` +/metrics +``` + +/// info | Feature availability +The `/metrics` endpoint isn't available on n8n Cloud. +/// + +## Enable metrics and healthz for self-hosted n8n + +The `/metrics` and `/healthz` endpoints are disabled by default. To enable them, configure your n8n instance: + +```shell +# metrics +N8N_METRICS=true +# healthz +QUEUE_HEALTH_CHECK_ACTIVE=true +``` + +Refer to [Configuration methods](/hosting/configuration/configuration-methods.md) for more information on how to configure your instance using environment variables. + + +# hosting/scaling/binary-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Scaling binary data in n8n +description: How to handle large files without degrading n8n's performance. +contentType: howto +--- + +# Binary data + +Binary data is any file-type data, such as image files or documents generated or processed during the execution of a workflow. + +## Enable filesystem mode + +When handling binary data, n8n keeps the data in memory by default. This can cause crashes when working with large files. + +To avoid this, change the `N8N_DEFAULT_BINARY_DATA_MODE` [environment variable](/hosting/configuration/environment-variables/binary-data.md) to `filesystem`. This causes n8n to save data to disk, instead of using memory. + +If you're using queue mode, keep this to `default`. n8n doesn't support filesystem mode with queue mode. + +## Binary data pruning + +n8n executes binary data pruning as part of execution data pruning. Refer to [Execution data | Enable data pruning](/hosting/scaling/execution-data.md#enable-data-pruning) for details. + +If you configure multiple binary data modes, binary data pruning operates on the active binary data mode. For example, if your instance stored data in S3, and you later switched to filesystem mode, n8n only prunes binary data in the filesystem. Refer to [External storage](/hosting/scaling/external-storage.md#usage) for details. + + +# hosting/scaling/concurrency-control.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Self-hosted concurrency control + +/// info | Only for self-hosted n8n +This document is for self-hosted concurrency control. Read [Cloud concurrency](/manage-cloud/concurrency.md) to learn how concurrency works with n8n Cloud accounts. +/// + +In regular mode, n8n doesn't limit how many production executions may run at the same time. This can lead to a scenario where too many concurrent executions thrash the event loop, causing performance degradation and unresponsiveness. + +To prevent this, you can set a concurrency limit for production executions in regular mode. Use this to control how many production executions run concurrently, and queue up any concurrent production executions over the limit. These executions remain in the queue until concurrency capacity frees up, and are then processed in FIFO order. + +Concurrency control is disabled by default. To enable it: + +```sh +export N8N_CONCURRENCY_PRODUCTION_LIMIT=20 +``` + +Keep in mind: + +- Concurrency control applies only to production executions: those started from a webhook or [trigger](/glossary.md#trigger-node-n8n) node. It doesn't apply to any other kinds, such as manual executions, sub-workflow executions, error executions, or started from CLI. +- You can't retry queued executions. Cancelling or deleting a queued execution also removes it from the queue. +- On instance startup, n8n resumes queued executions up to the concurrency limit and re-enqueues the rest. + +- To monitor concurrency control, watch logs for executions being added to the queue and released. In a future version, n8n will show concurrency control in the UI. + + +When you enable concurrency control, you can view the number of active executions and the configured limit at the top of a project's or workflow's executions tab. + +## Comparison to queue mode + +In queue mode, you can control how many jobs a worker may run concurrently using the [`--concurrency` flag](/hosting/scaling/queue-mode.md#configure-worker-concurrency). + +Concurrency control in queue mode is a separate mechanism from concurrency control in regular mode, but the environment variable `N8N_CONCURRENCY_PRODUCTION_LIMIT` controls both of them. In queue mode, n8n takes the limit from this variable if set to a value other than `-1`, falling back to the `--concurrency` flag or its default. + + + +# hosting/scaling/execution-data.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Execution data + +Depending on your executions settings and volume, your n8n database can grow in size and run out of storage. + +To avoid this, n8n recommends that you don't save unnecessary data, and enable pruning of old executions data. + +To do this, configure the corresponding [environment variables](/hosting/configuration/environment-variables/executions.md). + +## Reduce saved data + +/// note | Configuration at workflow level +You can also configure these settings on an individual workflow basis using the [workflow settings](/workflows/settings.md). +/// +You can select which executions data n8n saves. For example, you can save only executions that result in an `Error`. + +```sh +# npm +# Save executions ending in errors +export EXECUTIONS_DATA_SAVE_ON_ERROR=all + +# Save successful executions +export EXECUTIONS_DATA_SAVE_ON_SUCCESS=all + +# Don't save node progress for each execution +export EXECUTIONS_DATA_SAVE_ON_PROGRESS=false + +# Don't save manually launched executions +export EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS=false + +``` + +```sh +# Docker +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -e EXECUTIONS_DATA_SAVE_ON_ERROR=all \ + -e EXECUTIONS_DATA_SAVE_ON_SUCCESS=none \ + -e EXECUTIONS_DATA_SAVE_ON_PROGRESS=true \ + -e EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS=false \ + docker.n8n.io/n8nio/n8n +``` + +```yaml +# Docker Compose +n8n: + environment: + - EXECUTIONS_DATA_SAVE_ON_ERROR=all + - EXECUTIONS_DATA_SAVE_ON_SUCCESS=none + - EXECUTIONS_DATA_SAVE_ON_PROGRESS=true + - EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS=false +``` + +## Enable data pruning + +You can enable data pruning to automatically delete finished executions after a given time. If you don't set `EXECUTIONS_DATA_MAX_AGE`, 336 hours (14 days) is the default. + +You can choose to prune finished executions data before the time set in `EXECUTIONS_DATA_MAX_AGE`, using `EXECUTIONS_DATA_PRUNE_MAX_COUNT`. This sets a maximum number of executions to store in the database. Once you reach the limit, n8n starts to delete the oldest execution records. This can help with database performance issues, especially if you use SQLite. The database size can still exceed the limit you set: old executions that haven't finished running don't get deleted, even if they would otherwise be subject to deletion. + +```sh +# npm +# Activate automatic data pruning +export EXECUTIONS_DATA_PRUNE=true + +# Number of hours after execution that n8n deletes data +export EXECUTIONS_DATA_MAX_AGE=168 + +# Number of executions to store +export EXECUTIONS_DATA_PRUNE_MAX_COUNT=50000 +``` + +```sh +# Docker +docker run -it --rm \ + --name n8n \ + -p 5678:5678 \ + -e EXECUTIONS_DATA_PRUNE=true \ + -e EXECUTIONS_DATA_MAX_AGE=168 \ + docker.n8n.io/n8nio/n8n +``` + +```yaml +# Docker Compose +n8n: + environment: + - EXECUTIONS_DATA_PRUNE=true + - EXECUTIONS_DATA_MAX_AGE=168 + - EXECUTIONS_DATA_PRUNE_MAX_COUNT=50000 +``` + +/// note | SQLite +If you run n8n using the default SQLite database, the disk space of any pruned data isn't automatically freed up but rather reused for future executions data. To free up this space configure the `DB_SQLITE_VACUUM_ON_STARTUP` [environment variable](/hosting/configuration/environment-variables/database.md#sqlite) or manually run the [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target=_blank .external-link} operation. +/// + +--8<-- "_snippets/self-hosting/scaling/binary-data-pruning.md" + + +# hosting/scaling/external-storage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: External storage of binary data for your n8n instance. +contentType: howto +tags: + - external storage + - storage +hide: + - tags +search: + boost: 1.5 +--- + +# External storage + +/// info | Feature availability + +* Available on Self-hosted Enterprise plans +* If you want access to this feature on Cloud Enterprise, [contact n8n](https://n8n-community.typeform.com/to/y9X2YuGa){:target=_blank .external-link}. +/// + +n8n can store binary data produced by workflow executions externally. This feature is useful to avoid relying on the filesystem for storing large amounts of binary data. + +n8n will introduce external storage for other data types in the future. + +## Storing n8n's binary data in S3 + +n8n supports [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html){:target=_blank .external-link} as an external store for binary data produced by workflow executions. You can use other S3-compatible services like Cloudflare R2 and Backblaze B2, but n8n doesn't officially support these. + +/// info | Enterprise-tier feature +You will need an [Enterprise license key](/license-key.md) for external storage. If your license key expires and you remain on S3 mode, the instance will be able to read from, but not write to, the S3 bucket. +/// + +### Setup + +Create and configure a bucket following the [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html){:target=_blank .external-link}. You can use the following policy, replacing `` with the name of the bucket you created: + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "VisualEditor0", + "Effect": "Allow", + "Action": ["s3:*"], + "Resource": ["arn:aws:s3:::", "arn:aws:s3:::/*"] + } + ] +} +``` + +Set a bucket-level lifecycle configuration so that S3 automatically deletes old binary data. n8n delegates pruning of binary data to S3, so setting a lifecycle configuration is required unless you want to preserve binary data indefinitely. + +Once you finish creating the bucket, you will have a host, bucket name and region, and an access key ID and secret access key. You need to set them in n8n's environment: + +```sh +export N8N_EXTERNAL_STORAGE_S3_HOST=... # example: s3.us-east-1.amazonaws.com +export N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME=... +export N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION=... +export N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY=... +export N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET=... +``` + +/// note | No region +If your provider doesn't require a region, you can set `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` to `'auto'`. +/// +Tell n8n to store binary data in S3: + +```sh +export N8N_AVAILABLE_BINARY_DATA_MODES=filesystem,s3 +export N8N_DEFAULT_BINARY_DATA_MODE=s3 +``` + + +/// note | Auth autodetection +To automatically detect credentials to authenticate your S3 calls, set `N8N_EXTERNAL_STORAGE_S3_AUTH_AUTO_DETECT` to `true`. This will use the default [credential provider chain](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-credentials-node.html#credchain). +/// + +Restart the server to load the new configuration. + +### Usage + +After you enable S3, n8n writes and reads any new binary data to and from the S3 bucket. n8n writes binary data to your S3 bucket in this format: + +``` +workflows/{workflowId}/executions/{executionId}/binary_data/{binaryFileId} +``` + +n8n continues to read older binary data stored in the filesystem from the filesystem, if `filesystem` remains listed as an option in `N8N_AVAILABLE_BINARY_DATA_MODES`. + +If you store binary data in S3 and later switch to filesystem mode, the instance continues to read any data stored in S3, as long as `s3` remains listed in `N8N_AVAILABLE_BINARY_DATA_MODES` and your S3 credentials remain valid. + +--8<-- "_snippets/self-hosting/scaling/binary-data-pruning.md" + + +# hosting/scaling/memory-errors.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Memory-related errors + +n8n doesn't restrict the amount of data each node can fetch and process. While this gives you freedom, it can lead to errors when workflow executions require more memory than available. This page explains how to identify and avoid these errors. + +/// note | Only for self-hosted n8n +This page describes memory-related errors when [self-hosting n8n](/hosting/index.md). Visit [Cloud data management](/manage-cloud/cloud-data-management.md) to learn about memory limits for [n8n Cloud](/manage-cloud/overview.md). +/// + +## Identifying out of memory situations + +n8n provides error messages that warn you in some out of memory situations. For example, messages such as **Execution stopped at this node (n8n may have run out of memory while executing it)**. + +Error messages including **Problem running workflow**, **Connection Lost**, or **503 Service Temporarily Unavailable** suggest that an n8n instance has become unavailable. + +When self-hosting n8n, you may also see error messages such as **Allocation failed - JavaScript heap out of memory** in your server logs. + +On n8n Cloud, or when using n8n's Docker image, n8n restarts automatically when encountering such an issue. However, when running n8n with npm you might need to restart it manually. + +## Typical causes + +Such problems occur when a workflow execution requires more memory than available to an n8n instance. Factors increasing the memory usage for a workflow execution include: + +- Amount of [JSON data](/data/data-structure.md). +- Size of binary data. +- Number of nodes in a workflow. +- Some nodes are memory-heavy: the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node and the older Function node can increase memory consumption significantly. +- Manual or automatic workflow executions: manual executions increase memory consumption as n8n makes a copy of the data for the frontend. +- Additional workflows running at the same time. + +## Avoiding out of memory situations + +When encountering an out of memory situation, there are two options: either increase the amount of memory available to n8n or reduce the memory consumption. + +### Increase available memory + +When self-hosting n8n, increasing the amount of memory available to n8n means provisioning your n8n instance with more memory. This may incur additional costs with your hosting provider. + +On n8n cloud you need to upgrade to a larger plan. + +### Reduce memory consumption + +This approach is more complex and means re-building the workflows causing the issue. This section provides some guidelines on how to reduce memory consumption. Not all suggestions are applicable to all workflows. + +--8<-- "_snippets/self-hosting/scaling/reduce-memory-consumption.md" + +### Increase old memory + +This applies to self-hosting n8n. When encountering **JavaScript heap out of memory** errors, it's often useful to allocate additional memory to the old memory section of the V8 JavaScript engine. To do this, set the appropriate [V8 option](https://nodejs.org/api/cli.html#--max-old-space-sizesize-in-megabytes){:target=_blank .external-link} `--max-old-space-size=SIZE` either through the CLI or through the `NODE_OPTIONS` [environment variable](https://nodejs.org/api/cli.html#node_optionsoptions){:target=_blank .external-link}. + + +# hosting/scaling/overview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Scaling n8n + +When running n8n at scale, with a large number of users, workflows, or executions, you need to change your n8n configuration to ensure good performance. + +n8n can run in different [modes](/hosting/scaling/queue-mode.md) depending on your needs. The `queue` mode provides the best scalability. Refer to [Queue mode](/hosting/scaling/queue-mode.md) for configuration details. + +You can configure data saving and pruning to improve database performance. Refer to [Execution data](/hosting/scaling/execution-data.md) for details. + + +# hosting/scaling/performance-benchmarking.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: n8n performance and resource consumption benchmarking. +contentType: explanation +--- + +# Performance and benchmarking + +n8n can handle up to 220 workflow executions per second on a single instance, with the ability to scale up further by adding more instances. + +This document outlines n8n's performance benchmarking. It describes the factors that affect performance, and includes two example benchmarks. + +## Performance factors + +The performance of n8n depends on factors including: + +* The workflow type +* The resources available to n8n +* How you configure n8n's scaling options + + +## Run your own benchmarking + +To get an accurate estimate for your use case, run n8n's [benchmarking framework](https://github.com/n8n-io/n8n/tree/master/packages/%40n8n/benchmark){:target=_blank .external-link}. The repository contains more information about the benchmarking. + +## Example: Single instance performance + +This test measures how response time increases as requests per second increase. It looks at the response time when calling the Webhook Trigger node. + +Setup: + +- Hardware: ECS c5a.large instance (4GB RAM) +- n8n setup: Single n8n instance (running in main mode, with Postgres database) +- Workflow: Webhook Trigger node, Edit Fields node + +
+ ![Graph showing n8n response times by requests per second](/_images/hosting/scaling/benchmarking-single-instance-100-250.png) +
This graph shows the percentage of requests to the Webhook Trigger node getting a response within 100 seconds, and how that varies with load. Under higher loads n8n usually still processes the data, but takes over 100s to respond.
+
+ + + +## Example: Multi-instance performance + +This test measures how response time increases as requests per second increase. It looks at the response time when calling the Webhook Trigger node. + +Setup: + +- Hardware: seven ECS c5a.4xlarge instances (8GB RAM each) +- n8n setup: two webhook instances, four worker instances, one database instance (MySQL), one main instance running n8n and Redis +- Workflow: Webhook Trigger node, Edit Fields node +- Multi-instance setups use [Queue mode](/hosting/scaling/queue-mode.md) + +
+ ![Graph showing n8n response times by requests per second](/_images/hosting/scaling/benchmarking-multi-instance-500-2500.png) +
This graph shows the percentage of requests to the Webhook Trigger node getting a response within 100 seconds, and how that varies with load. Under higher loads n8n usually still processes the data, but takes over 100s to respond.
+
+ + + +# hosting/scaling/queue-mode.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Queue mode + +You can run n8n in different modes depending on your needs. The queue mode provides the best scalability. + +/// note | Binary data storage +n8n doesn't support queue mode with binary data storage in filesystem. If your workflows need to persist binary data in queue mode, you can use [S3 external storage](./external-storage.md). +/// + +## How it works + +When running in queue mode, you have multiple n8n instances set up, with one main instance receiving workflow information (such as triggers) and the worker instances performing the executions. + +Each worker is its own Node.js instance, running in `main` mode, but able to handle multiple simultaneous workflow executions due to their high IOPS (input-output operations per second). + +By using worker instances and running in queue mode, you can scale n8n up (by adding workers) and down (by removing workers) as needed to handle the workload. + +This is the process flow: + +1. The main n8n instance handles timers and webhook calls, generating (but not running) a workflow execution. +1. It passes the execution ID to a message broker, [Redis](#start-redis), which maintains the queue of pending executions and allows the next available worker to pick them up. +1. A worker in the pool picks up message from Redis. +1. The worker uses the execution ID to get workflow information from the database. +1. After completing the workflow execution, the worker: + - Writes the results to the database. + - Posts to Redis, saying that the execution has finished. +1. Redis notifies the main instance. + + +!["Diagram showing the flow of data between the main n8n instance, Redis, the n8n workers, and the n8n database"](/_images/hosting/scaling/queue-mode-flow.png) + +## Configuring workers + +Workers are n8n instances that do the actual work. They receive information from the main n8n process about the workflows that have to get executed, execute the workflows, and update the status after each execution is complete. + +### Set encryption key + +n8n automatically generates an encryption key upon first startup. You can also provide your own custom key using [environment variable](/hosting/configuration/environment-variables/index.md) if desired. + +The encryption key of the main n8n instance must be shared with all worker and webhooks processor nodes to ensure these worker nodes are able to access credentials stored in the database. + +Set the encryption key for each worker node in a [configuration file](/hosting/configuration/configuration-methods.md) or by setting the corresponding environment variable: + +```bash +export N8N_ENCRYPTION_KEY= +``` + +### Set executions mode + +/// note | Database considerations +n8n recommends using Postgres 13+. Running n8n with execution mode set to `queue` with an SQLite database isn't recommended. +/// + +Set the environment variable `EXECUTIONS_MODE` to `queue` on the main instance and any workers using the following command. + +```bash +export EXECUTIONS_MODE=queue +``` + +Alternatively, you can set `executions.mode` to `queue` in the [configuration file](/hosting/configuration/environment-variables/index.md). + +### Start Redis + +/// note | Running Redis on a separate machine +You can run Redis on a separate machine, just make sure that it's accessible by the n8n instance. +/// + +To run Redis in a Docker container, follow the instructions below: + +Run the following command to start a Redis instance: + +``` +docker run --name some-redis -p 6379:6379 -d redis +``` + +By default, Redis runs on `localhost` on port `6379` with no password. Based on your Redis configuration, set the following configurations for the main n8n process. These will allow n8n to interact with Redis. + +| Using configuration file | Using environment variables | Description | +| ------ | ------ | ----- | +| `queue.bull.redis.host:localhost` | `QUEUE_BULL_REDIS_HOST=localhost` | By default, Redis runs on `localhost`. | +| `queue.bull.redis.port:6379` | `QUEUE_BULL_REDIS_PORT=6379` | The default port is `6379`. If Redis is running on a different port, configure the value. | + +You can also set the following optional configurations: + +| Using configuration file | Using environment variables | Description | +| ------ | ------ | ----- | +| `queue.bull.redis.username:USERNAME` | `QUEUE_BULL_REDIS_USERNAME` | By default, Redis doesn't require a username. If you're using a specific user, configure it variable. | +| `queue.bull.redis.password:PASSWORD` | `QUEUE_BULL_REDIS_PASSWORD` | By default, Redis doesn't require a password. If you're using a password, configure it variable. | +| `queue.bull.redis.db:0` | `QUEUE_BULL_REDIS_DB` | The default value is `0`. If you change this value, update the configuration. | +| `queue.bull.redis.timeoutThreshold:10000ms` | `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Tells n8n how long it should wait if Redis is unavailable before exiting. The default value is `10000` (ms). | +| `queue.bull.gracefulShutdownTimeout:30` | `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | A graceful shutdown timeout for workers to finish executing jobs before terminating the process. The default value is `30` seconds. | + + +Now you can start your n8n instance and it will connect to your Redis instance. + +### Start workers + +You will need to start worker processes to allow n8n to execute workflows. If you want to host workers on a separate machine, install n8n on the machine and make sure that it's connected to your Redis instance and the n8n database. + +Start worker processes by running the following command from the root directory: + +``` +./packages/cli/bin/n8n worker +``` + +If you're using Docker, use the following command: + +``` +docker run --name n8n-queue -p 5679:5678 docker.n8n.io/n8nio/n8n worker +``` + +You can set up multiple worker processes. Make sure that all the worker processes have access to Redis and the n8n database. + +#### Worker server + +Each worker process runs a server that exposes optional endpoints: + +- `/healthz`: returns whether the worker is up, if you enable the `QUEUE_HEALTH_CHECK_ACTIVE` environment variable +- `/healthz/readiness`: returns whether worker's DB and Redis connections are ready, if you enable the `QUEUE_HEALTH_CHECK_ACTIVE` environment variable +- [credentials overwrite endpoint](https://docs.n8n.io/embed/configuration/#credential-overwrites) +- [`/metrics`](https://docs.n8n.io/hosting/configuration/configuration-examples/prometheus/) + +#### View running workers + +/// info | Feature availability +* Available on Self-hosted Enterprise plans. +* If you want access to this feature on Cloud Enterprise, [contact n8n](https://n8n-community.typeform.com/to/y9X2YuGa){:target=_blank .external-link}. +/// + +You can view running workers and their performance metrics in n8n by selecting **Settings** > **Workers**. + +## Running n8n with queues + +When running n8n with queues, all the production workflow executions get processed by worker processes. This means that even the webhook calls get delegated to the worker processes, which might add some overhead and extra latency. + +Redis acts as the message broker, and the database persists data, so access to both is required. Running a distributed system with this setup over SQLite isn't supported. + +/// note | Migrate data +If you want to migrate data from one database to another, you can use the Export and Import commands. Refer to the [CLI commands for n8n](/hosting/cli-commands.md#export-workflows-and-credentials) documentation to learn how to use these commands. +/// + +## Webhook processors + +/// note | Keep in mind +Webhook processes rely on Redis and need the `EXECUTIONS_MODE` environment variable set too. Follow the [configure the workers](#configuring-workers) section above to setup webhook processor nodes. +/// + +Webhook processors are another layer of scaling in n8n. Configuring the webhook processor is optional, and allows you to scale the incoming webhook requests. + +This method allows n8n to process a huge number of parallel requests. All you have to do is add more webhook processes and workers accordingly. The webhook process will listen to requests on the same port (default: `5678`). Run these processes in containers or separate machines, and have a load balancing system to route requests accordingly. + +n8n doesn't recommend adding the main process to the load balancer pool. If you add the main process to the pool, it will receive requests and possibly a heavy load. This will result in degraded performance for editing, viewing, and interacting with the n8n UI. + +You can start the webhook processor by executing the following command from the root directory: + +``` +./packages/cli/bin/n8n webhook +``` + +If you're using Docker, use the following command: + +``` +docker run --name n8n-queue -p 5679:5678 -e "EXECUTIONS_MODE=queue" docker.n8n.io/n8nio/n8n webhook +``` + +### Configure webhook URL + +To configure your webhook URL, execute the following command on the machine running the main n8n instance: + +```bash +export WEBHOOK_URL=https://your-webhook-url.com +``` + +You can also set this value in the configuration file. + +### Configure load balancer + +When using multiple webhook processes you will need a load balancer to route requests. If you are using the same domain name for your n8n instance and the webhooks, you can set up your load balancer to route requests as follows: + +- Redirect any request that matches `/webhook/*` to the webhook servers pool +- All other paths (the n8n internal API, the static files for the editor, etc.) should get routed to the main process + +**Note:** The default URL for manual workflow executions is `/webhook-test/*`. Make sure that these URLs route to your main process. + +You can change this path in the configuration file `endpoints.webhook` or using the `N8N_ENDPOINT_WEBHOOK` environment variable. If you change these, update your load balancer accordingly. + +### Disable webhook processing in the main process (optional) + +You have webhook processors to execute the workflows. You can disable the webhook processing in the main process. This will make sure to execute all webhook executions in the webhook processors. In the configuration file set `endpoints.disableProductionWebhooksOnMainProcess` to `true` so that n8n doesn't process webhook requests on the main process. + +Alternatively, you can use the following command: + +```bash +export N8N_DISABLE_PRODUCTION_MAIN_PROCESS=true +``` + +When disabling the webhook process in the main process, run the main process and don't add it to the load balancer's webhook pool. + +## Configure worker concurrency + +You can define the number of jobs a worker can run in parallel by using the `concurrency` flag. It defaults to `10`. To change it: + +```bash +n8n worker --concurrency=5 +``` + +## Concurrency and scaling recommendations + +n8n recommends setting concurrency to 5 or higher for your worker instances. Setting low concurrency values with a large numbers of workers can exhaust your database's connection pool, leading to processing delays and failures. + +## Multi-main setup + +/// info | Feature availability +* Available on Self-hosted Enterprise plans. +* If you want access to this feature on Cloud Enterprise, [contact n8n](https://n8n-community.typeform.com/to/y9X2YuGa){:target=_blank .external-link}. +/// + +In queue mode you can run more than one `main` process for high availability. + +In a single-mode setup, the `main` process does two sets of tasks: + +- **regular tasks**, such as running the API, serving the UI, and listening for webhooks, and +- **at-most-once tasks**, such as running non-HTTP triggers (timers, pollers, and persistent connections like RabbitMQ and IMAP), and pruning executions and binary data. + +In a multi-main setup, there are two kinds of `main` processes: + +- **followers**, which run **regular tasks**, and +- the **leader**, which runs **both regular and at-most-once tasks**. + +### Leader designation + +In a multi-main setup, all main instances handle the leadership process transparently to users. In case the current leader becomes unavailable, for example because it crashed or its event loop became too busy, other followers can take over. If the previous leader becomes responsive again, it becomes a follower. + +### Configuring multi-main setup + +To deploy n8n in multi-main setup, ensure: + +- All `main` processes are running in queue mode and are connected to Postgres and Redis. +- All `main` and `worker` processes are running the same version of n8n. +- All `main` processes have set the environment variable `N8N_MULTI_MAIN_SETUP_ENABLED` to `true`. +- All `main` processes are running behind a load balancer with session persistence (sticky sessions) enabled. + +If needed, you can adjust the leader key options: + +| Using configuration file | Using environment variables | Description | +| ------ | ------ | ----- | +| `multiMainSetup.ttl:10` | `N8N_MULTI_MAIN_SETUP_KEY_TTL=10` | Time to live (in seconds) for leader key in multi-main setup. | +| `multiMainSetup.interval:3` | `N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL=3` | Interval (in seconds) for leader check in multi-main setup. | + + + + +# hosting/securing/blocking-nodes.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Block access to nodes +description: "Prevent your n8n users from accessing specific nodes." +contentType: howto +--- + +# Block access to nodes + +For security reasons, you may want to block your users from accessing or working with specific n8n nodes. This is helpful if your users might be untrustworthy. + +Use the `NODES_EXCLUDE` environment variable to prevent your users from accessing specific nodes. + +## Exclude nodes + +Update your `NODES_EXCLUDE` environment variable to include an array of strings containing any nodes you want to block your users from using. + +For example, setting the variable this way: + +``` +NODES_EXCLUDE: "[\"n8n-nodes-base.executeCommand\", \"n8n-nodes-base.readWriteFile\"]" +``` + +Blocks the [Execute Command](/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/index.md) and [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) nodes. + +Your n8n users won't be able to search for or use these nodes. + +## Suggested nodes to block + +The nodes that can pose security risks vary based on your use case and user profile. Here are some nodes you might want to start with: + +* [Execute Command](/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/index.md) +* [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) + +## Related resources + +Refer to [Nodes environment variables](/hosting/configuration/environment-variables/nodes.md) for more information on this environment variable. + +Refer to [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. + + +# hosting/securing/disable-public-api.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Disable the public REST API +description: "Disable the n8n public REST API to prevent others from using it." +contentType: howto +--- + +# Disable the public REST API + +The [n8n public REST API](/api/index.md) allows you to programmatically perform many of the same tasks as you can in the n8n GUI. + +If you don't plan on using this API, n8n recommends disabling it to improve the security of your n8n installation. + +To disable the [public REST API](/api/index.md), set the `N8N_PUBLIC_API_DISABLED` environment variable to `true`, for example: + +```bash +export N8N_PUBLIC_API_DISABLED=true +``` + +## Disable the API playground + +To disable the [API playground](/api/using-api-playground.md), set the `N8N_PUBLIC_API_SWAGGERUI_DISABLED` environment variable to `true`, for example: + +```bash +export N8N_PUBLIC_API_SWAGGERUI_DISABLED=true +``` + +## Related resources + +Refer to [Deployment environment variables](/hosting/configuration/environment-variables/deployment.md) for more information on these environment variables. + +Refer to [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. + + +# hosting/securing/hardening-task-runners.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Hardening task runners +description: "Harden task runners for better isolation for your self-hosted n8n instance." +contentType: howto +--- + +# Hardening task runners + +[Task runners](/hosting/configuration/task-runners.md) are responsible for executing code from the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). While Code node executions are secure, you can follow these recommendations to further harden your task runners. + +## Run task runners as sidecars in external mode + +To increase the isolation between the core n8n process and code in the Code node, run task runners in [external mode](/hosting/configuration/task-runners.md#setting-up-external-mode). External task runners launch as separate containers, providing a fully isolated environment to execute the JavaScript defined in the Code node. + + +# hosting/securing/overview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Securing n8n +contentType: overview +--- + +# Securing n8n + +Securing your n8n instance can take several forms. + +At a high level, you can: + +* Conduct a [security audit](/hosting/securing/security-audit.md) to identify security risks. +* [Set up SSL](/hosting/securing/set-up-ssl.md) to enforce secure connections. +* [Set up Single Sign-On](/hosting/securing/set-up-sso.md) for user account management. +* Use [two-factor authentication (2FA)](/user-management/two-factor-auth.md) for your users. + +More granularly, consider blocking or opting out of features or data collection you don't want: + +* [Disable the public API](/hosting/securing/disable-public-api.md) if you aren't using it. +* [Opt out of data collection](/hosting/securing/telemetry-opt-out.md) of the anonymous data n8n collects automatically. +* [Block certain nodes](/hosting/securing/blocking-nodes.md) from being available to your users. + +# hosting/securing/security-audit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Security audit +description: "Run a security audit on your n8n instance." +contentType: howto +--- + +# Security audit + +You can run a security audit on your n8n instance, to detect common security issues. + +## Run an audit + +You can run an audit using the CLI, the public API, or the n8n node. + + +### CLI + +Run `n8n audit`. + +### API + +Make a `POST` call to the `/audit` endpoint. You must authenticate as the instance owner. + +### n8n node + +Add the [n8n node](/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md) to your workflow. Select **Resource** > **Audit** and **Operation** > **Generate**. + +## Report contents + +The audit generates five risk reports: + +### Credentials + +This report shows: + +* Credentials not used in a workflow. +* Credentials not used in an active workflow. +* Credentials not use in a recently active workflow. + +### Database + +This report shows: + +* Expressions used in **Execute Query** fields in SQL nodes. +* Expressions used in **Query Parameters** fields in SQL nodes. +* Unused **Query Parameters** fields in SQL nodes. + +### File system + +This report lists nodes that interact with the file system. + +### Nodes + +This report shows: + +* Official risky nodes. These are n8n built in nodes. You can use them to fetch and run any code on the host system, which exposes the instance to exploits. You can view the list in [n8n code | Audit constants](https://github.com/n8n-io/n8n/blob/master/packages/cli/src/security-audit/constants.ts#L51){:target=_blank .external-link}, under `OFFICIAL_RISKY_NODE_TYPES`. +* Community nodes. +* Custom nodes. + +### Instance + +This report shows: + +* Unprotected webhooks in the instance. +* Missing security settings +* If your instance is outdated. + + +# hosting/securing/set-up-ssl.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Set up SSL +description: "Set up SSL for your self-hosted n8n instance." +contentType: howto +--- + +# Set up SSL + +There are two methods to support TLS/SSL in n8n. + +## Use a reverse proxy (recommended) + +Use a reverse proxy like [Traefik](https://doc.traefik.io/traefik/){:target=_blank .external-link} or a Network Load Balancer (NLB) in front of the n8n instance. This should also take care of certificate renewals. + +Refer to [Security | Data encryption](https://n8n.io/legal/#security){:target=_blank .external-link} for more information. + +## Pass certificates into n8n directly + +You can also choose to pass certificates into n8n directly. To do so, set the `N8N_SSL_CERT` and `N8N_SSL_KEY` environment variables to point to your generated certificate and key file. + +You'll need to make sure the certificate stays renewed and up to date. + +Refer to [Deployment environment variables](/hosting/configuration/environment-variables/deployment.md) for more information on these variables and [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. + + +# hosting/securing/set-up-sso.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Set up SAML SSO +description: "Set up SAML Single Sign-On for your self-hosted n8n instance." +contentType: howto +--- + +# Set up SAML Single Sign-On (SSO) + +--8<-- "_snippets/user-management/saml-overview.md" + + +# hosting/securing/telemetry-opt-out.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Opt out of data collection +description: "Opt out of data telemetry collection on your n8n instance." +contentType: howto +--- + +# Data collection + +n8n collects some anonymous data from self-hosted n8n installations. Use the instructions below to opt out of data telemetry collection. + +## Collected data + +Refer to [Privacy | Data collection in self-hosted n8n](/privacy-security/privacy.md#data-collection-in-self-hosted-n8n) for details on the data n8n collects. + +## How collection works + +Your n8n instance sends most data to n8n as the events that generate it occur. Workflow execution counts and an instance pulse are sent periodically (every 6 hours). These data types mostly fall into n8n telemetry collection. + +## Opting out of data collection + +n8n enables telemetry collection by default. To disable it, configure the following environment variables. + +### Opt out of telemetry events + +To opt out of telemetry events, set the `N8N_DIAGNOSTICS_ENABLED` environment variable to false, for example: + +```bash +export N8N_DIAGNOSTICS_ENABLED=false +``` + +### Opt out of checking for new versions of n8n + +To opt out of checking for new versions of n8n, set the `N8N_VERSION_NOTIFICATIONS_ENABLED` environment variable to false, for example: + +```bash +export N8N_VERSION_NOTIFICATIONS_ENABLED=false +``` + +## Disable all connection to n8n servers + +If you want to fully prevent all communication with n8n's servers, refer to [Isolate n8n](/hosting/configuration/configuration-examples/isolation.md). + +## Related resources + +Refer to [Deployment environment variables](/hosting/configuration/environment-variables/deployment.md) for more information on these environment variables. + +Refer to [Configuration](/hosting/configuration/configuration-methods.md) for more information on setting environment variables. + + +# hosting/starter-kits/ai-starter-kit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Self-hosted AI Starter Kit +description: Use n8n's curated self-hosted AI Starter Kit to get a list of AI elements to quickly start building AI workflows. +contentType: howto +--- + +# Self-hosted AI Starter Kit + +The Self-hosted AI Starter Kit is an open, docker compose template that bootstraps a fully featured Local AI and Low Code development environment. + +Curated by [n8n](https://github.com/n8n-io), it combines the self-hosted n8n platform with a list of compatible AI products and components to get you started building self-hosted AI workflows. + +## What’s included + +✅ [**Self-hosted n8n**](/hosting/index.md): Low-code platform with over 400 integrations and advanced AI components. + +✅ [**Ollama**](https://ollama.com/){:target=_blank .external-link}: Cross-platform LLM platform to install and run the latest local LLMs. + +✅ [**Qdrant**](https://qdrant.tech/){:target=_blank .external-link}: Open-source, high performance vector store with a comprehensive API. + +✅ [**PostgreSQL**](https://www.postgresql.org/){:target=_blank .external-link}: The workhorse of the Data Engineering world, handles large amounts of data safely. + +## What you can build + +⭐️ [AI Agents](/glossary.md#ai-agent){ data-preview} that can schedule appointments + +⭐️ Summaries of company PDFs without leaking data + +⭐️ Smarter Slackbots for company communications and IT-ops + +⭐️ Private, low-cost analyses of financial documents + +## Get the kit + + +Head to [the GitHub repository](https://github.com/n8n-io/self-hosted-ai-starter-kit){:target=_blank .external-link} to clone the repo and get started! + + +/// note | For testing only +n8n designed this kit to help you get started with self-hosted AI workflows. While it’s not fully optimized for production environments, it combines robust components that work well together for proof-of-concept projects. Customize it to meet your needs. Secure and harden it before using in production. +/// diff --git a/llms/integrations.md b/llms/integrations.md new file mode 100644 index 00000000000..1bd7c14fa44 --- /dev/null +++ b/llms/integrations.md @@ -0,0 +1,52343 @@ + + +# integrations/builtin/app-nodes/index.md + +--- +title: Actions library +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Actions library + +This section provides information about n8n's Actions. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.actionnetwork.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Action Network node documentation +description: Learn how to use the Action Network node in n8n. Follow technical documentation to integrate Action Network node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Action Network node + +Use the Action Network node to automate work in Action Network, and integrate Action Network with other applications. n8n has built-in support for a wide range of Action Network features, including creating, updating, and deleting events, people, tags, and signatures. + +On this page, you'll find a list of operations the Action Network node supports, and links to more resources. + +/// note | Credentials +Refer to [Action Network credentials](/integrations/builtin/credentials/actionnetwork.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Attendance + * Create + * Get + * Get All +* Event + * Create + * Get + * Get All +* Person + * Create + * Get + * Get All + * Update +* Person Tag + * Add + * Remove +* Petition + * Create + * Get + * Get All + * Update +* Signature + * Create + * Get + * Get All + * Update +* Tag + * Create + * Get + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'action-network') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.activecampaign.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ActiveCampaign node documentation +description: Learn how to use the ActiveCampaign node in n8n. Follow technical documentation to integrate ActiveCampaign node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# ActiveCampaign node + +Use the ActiveCampaign node to automate work in ActiveCampaign, and integrate ActiveCampaign with other applications. n8n has built-in support for a wide range of ActiveCampaign features, including creating, getting, updating, and deleting accounts, contact, orders, e-commerce customers, connections, lists, tags, and deals. + +On this page, you'll find a list of operations the ActiveCampaign node supports and links to more resources. + +/// note | Credentials +Refer to [ActiveCampaign credentials](/integrations/builtin/credentials/activecampaign.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Account + * Create an account + * Delete an account + * Get data of an account + * Get data of all accounts + * Update an account +* Account Contact + * Create an association + * Delete an association + * Update an association +* Contact + * Create a contact + * Delete a contact + * Get data of a contact + * Get data of all contact + * Update a contact +* Contact List + * Add contact to a list + * Remove contact from a list +* Contact Tag + * Add a tag to a contact + * Remove a tag from a contact +* Connection + * Create a connection + * Delete a connection + * Get data of a connection + * Get data of all connections + * Update a connection +* Deal + * Create a deal + * Delete a deal + * Get data of a deal + * Get data of all deals + * Update a deal + * Create a deal note + * Update a deal note +* E-commerce Order + * Create a order + * Delete a order + * Get data of a order + * Get data of all orders + * Update a order +* E-Commerce Customer + * Create a E-commerce Customer + * Delete a E-commerce Customer + * Get data of a E-commerce Customer + * Get data of all E-commerce Customer + * Update a E-commerce Customer +* E-commerce Order Products + * Get data of all order products + * Get data of a ordered product + * Get data of an order's products +* List + * Get all lists +* Tag + * Create a tag + * Delete a tag + * Get data of a tag + * Get data of all tags + * Update a tag + +## Templates and examples + + +[[ templatesWidget(page.title, 'activecampaign') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.adalo.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Adalo node documentation +description: Learn how to use the Adalo node in n8n. Follow technical documentation to integrate Adalo node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Adalo node + +Use the Adalo node to automate work in Adalo, and integrate Adalo with other applications. n8n has built-in support for a wide range of Adalo features, including like creating, getting, updating and deleting databases, records, and collections. + +On this page, you'll find a list of operations the Adalo node supports and links to more resources. + +/// note | Credentials +Refer to [Adalo credentials](/integrations/builtin/credentials/adalo.md) for guidance on setting up authentication. +/// + +## Operations + +* Collection + * Create + * Delete + * Get + * Get Many + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'adalo') ]] + +## Related resources + +Refer to [Adalo's documentation](https://help.adalo.com/){:target=_blank .external-link} for more information on using Adalo. Their [External Collections with APIs](https://help.adalo.com/integrations/external-collections-with-apis){:target=_blank .external-link} page gives more detail about what you can do with Adalo collections. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.affinity.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Affinity node documentation +description: Learn how to use the Affinity node in n8n. Follow technical documentation to integrate Affinity node into your workflows. +contentType: [integration, reference] +--- + +# Affinity node + +Use the Affinity node to automate work in Affinity, and integrate Affinity with other applications. n8n has built-in support for a wide range of Affinity features, including creating, getting, updating and deleting lists, entries, organization, and persons. + +On this page, you'll find a list of operations the Affinity node supports and links to more resources. + +/// note | Credentials +Refer to [Affinity credentials](/integrations/builtin/credentials/affinity.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* List + * Get a list + * Get all lists +* List Entry + * Create a list entry + * Delete a list entry + * Get a list entry + * Get all list entries +* Organization + * Create an organization + * Delete an organization + * Get an organization + * Get all organizations + * Update an organization +* Person + * Create a person + * Delete a person + * Get a person + * Get all persons + * Update a person + +## Templates and examples + + +[[ templatesWidget(page.title, 'affinity') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.agilecrm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Agile CRM node documentation +description: Learn how to use the Agile CRM node in n8n. Follow technical documentation to integrate Agile CRM node into your workflows. +contentType: [integration, reference] +--- + +# Agile CRM node + +Use the Agile CRM node to automate work in Agile CRM, and integrate Agile CRM with other applications. n8n has built-in support for a wide range of Agile CRM features, including creating, getting, updating and deleting companies, contracts, and deals. + +On this page, you'll find a list of operations the Agile CRM node supports and links to more resources. + +/// note | Credentials +Refer to [Agile CRM credentials](/integrations/builtin/credentials/agilecrm.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Company + * Create a new company + * Delete a company + * Get a company + * Get all companies + * Update company properties +* Contact + * Create a new contact + * Delete a contact + * Get a contact + * Get all contacts + * Update contact properties +* Deal + * Create a new deal + * Delete a deal + * Get a deal + * Get all deals + * Update deal properties + +## Templates and examples + + +[[ templatesWidget(page.title, 'agile-crm') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Airtable node common issues +description: Documentation for common issues and questions in the Airtable node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Airtable node common issues + +Here are some common errors and issues with the [Airtable node](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md) and steps to resolve or troubleshoot them. + +## Forbidden - perhaps check your credentials + +This error displays when trying to perform actions not permitted by your current level of access. The full text looks something like this: + +``` +There was a problem loading the parameter options from server: "Forbidden - perhaps check your credentials?" +``` + +The error most often displays when the credential you're using doesn't have the scopes it requires on the resources you're attempting to manage. + +Refer to the [Airtable credentials](/integrations/builtin/credentials/airtable.md) and [Airtables scopes documentation](https://airtable.com/developers/web/api/scopes) for more information. + +## Service is receiving too many requests from you + +Airtable has a hard API limit on the number of requests generated using personal access tokens. + +If you send more than five requests per second per base, you will receive a 429 error, indicating that you have sent too many requests. You will have to wait 30 seconds before resuming requests. This same limit applies for sending more than 50 requests across all bases per access token. + +You can find out more in the [Airtable's rate limits documentation](https://airtable.com/developers/web/api/rate-limits). If you find yourself running into rate limits with the Airtable node, consider implementing one of the suggestions on the [handling rate limits](/integrations/builtin/rate-limits.md) page. + + +# integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Airtable node documentation +description: Learn how to use the Airtable node in n8n. Follow technical documentation to integrate Airtable node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Airtable node + +Use the Airtable node to automate work in Airtable, and integrate Airtable with other applications. n8n has built-in support for a wide range of Airtable features, including creating, reading, listing, updating and deleting tables. + +On this page, you'll find a list of operations the Airtable node supports and links to more resources. + +/// note | Credentials +Refer to [Airtable credentials](/integrations/builtin/credentials/airtable.md) for guidance on setting up authentication. +/// + +## Operations + +* Append the data to a table +* Delete data from a table +* List data from a table +* Read data from a table +* Update data in a table + +## Templates and examples + + +[[ templatesWidget(page.title, 'airtable') ]] + +## Related resources + +n8n provides a trigger node for Airtable. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.airtabletrigger.md). + +Refer to [Airtable's documentation](https://airtable.com/developers/web/api/introduction){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +## Node reference + +### Get the Record ID + +To fetch data for a particular record, you need the Record ID. There are two ways to get the Record ID. + +### Create a Record ID column in Airtable + +To create a `Record ID` column in your table, refer to this [article](https://support.airtable.com/docs/finding-airtable-ids){:target=_blank .external-link}. You can then use this Record ID in your Airtable node. + +### Use the List operation + +To get the Record ID of your record, you can use the **List** operation of the Airtable node. This operation will return the Record ID along with the fields. You can then use this Record ID in your Airtable node. + +### Filter records when using the List operation + +To filter records from your Airtable base, use the **Filter By Formula** option. For example, if you want to return all the users that belong to the organization `n8n`, follow the steps mentioned below: + +1. Select 'List' from the **Operation** dropdown list. +2. Enter the base ID and the table name in the **Base ID** and **Table** field, respectively. +3. Click on **Add Option** and select 'Filter By Formula' from the dropdown list. +4. Enter the following formula in the **Filter By Formula** field: `{Organization}='n8n'`. + +Similarly, if you want to return all the users that don't belong to the organization `n8n`, use the following formula: `NOT({Organization}='n8n')`. + +Refer to the Airtable [documentation](https://support.airtable.com/hc/en-us/articles/203255215-Formula-Field-Reference){:target=_balnk .external-link} to learn more about the formulas. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.airtop.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Airtop node documentation +description: Learn how to use the Airtop node in n8n. Follow technical documentation to integrate Airtop node into your workflows. +contentType: [integration, reference] +--- + +# Airtop node + +Use the Airtop node to automate work in Airtop, and integrate Airtop with other applications. n8n has built-in support for a wide range of Airtop features, enabling you to control a cloud-based web browser for tasks like querying, scraping, and interacting with web pages. + +On this page, you'll find a list of operations the Airtop node supports, and links to more resources. + +/// note | Credentials +Refer to [Airtop credentials](/integrations/builtin/credentials/airtop.md) for guidance on setting up authentication. +/// + + +## Operations + +* Session + * Create session + * Save profile on termination + * Terminate session +* Window + * Create a new browser window + * Load URL + * Take screenshot + * Close window +* Extraction + * Query page + * Query page with pagination + * Smart scrape page +* Interaction + * Click an element + * Hover on an element + * Type + + +## Templates and examples + + +[[ templatesWidget(page.title, 'airtop') ]] + + +## Related resources + +Refer to [Airtop's documentation](https://docs.airtop.ai/api-reference/airtop-api) for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +Contact [Airtop's Support](https://docs.airtop.ai/guides/misc/support) for assistance or to create a feature request. + +## Node reference + +### Create a session and window + +Create an Airtop browser session to get a **Session ID**, then use it to create a new browser window. After this, you can use any extraction or interaction operation. + +### Extract content + +Extract content from a web browser using these operations: + +- **Query page**: Extract information from the current window. +- **Query page with pagination**: Extract information from pages with pagination or infinite scrolling. +- **Smart scrape page**: Get the window content as markdown. + +Get JSON responses by using the **JSON Output Schema** parameter in query operations. + +### Interacting with pages + +Click, hover, or type on elements by describing the element you want to interact with. + +### Terminate a session + +End your session to save resources. Sessions are automatically terminated based on the **Idle Timeout** set in the **Create Session** operation or can be manually terminated using the **Terminate Session** operation. + + +# integrations/builtin/app-nodes/n8n-nodes-base.amqp.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AMQP Sender node documentation +description: Learn how to use the AMQP Sender node in n8n. Follow technical documentation to integrate AMQP Sender node into your workflows. +contentType: [integration, reference] +--- + +# AMQP Sender node + +Use 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. + +On this page, you'll find a list of operations the AMQP Sender node supports and links to more resources. + +/// note | Credentials +Refer to [AMQP Sender credentials](/integrations/builtin/credentials/amqp.md) for guidance on setting up authentication. +/// + +## Operations + +- Send message + +## Templates and examples + + +[[ templatesWidget(page.title, 'amqp-sender') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.apitemplateio.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: APITemplate.io node documentation +description: Learn how to use the APITemplate.io node in n8n. Follow technical documentation to integrate APITemplate.io node into your workflows. +contentType: [integration, reference] +--- + +# APITemplate.io node + +Use the APITemplate.io node to automate work in APITemplate.io, and integrate APITemplate.io with other applications. n8n has built-in support for a wide range of APITemplate.io features, including getting and creating accounts and PDF. + +On this page, you'll find a list of operations the APITemplate.io node supports and links to more resources. + +/// note | Credentials +Refer to [APITemplate.io credentials](/integrations/builtin/credentials/apitemplateio.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Account + * Get +* Image + * Create +* PDF + * Create + +## Templates and examples + + +[[ templatesWidget(page.title, 'apitemplateio') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.asana.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Asana node documentation +description: Learn how to use the Asana node in n8n. Follow technical documentation to integrate Asana node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Asana node + +Use the Asana node to automate work in Asana, and integrate Asana with other applications. n8n has built-in support for a wide range of Asana features, including creating, updating, deleting, and getting users, tasks, projects, and subtasks. + +On this page, you'll find a list of operations the Asana node supports and links to more resources. + +/// note | Credentials +Refer to [Asana credentials](/integrations/builtin/credentials/asana.md) for guidance on setting up authentication. +/// + +/// note | Update to 1.22.2 or above +Due to changes in Asana's API, some operations in this node stopped working on 17th January 2023. Upgrade to n8n 1.22.2 or above. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Project + * Create a new project + * Delete a project + * Get a project + * Get all projects + * Update a project +* Subtask + * Create a subtask + * Get all subtasks +* Task + * Create a task + * Delete a task + * Get a task + * Get all tasks + * Move a task + * Search for tasks + * Update a task +* Task Comment + * Add a comment to a task + * Remove a comment from a task +* Task Tag + * Add a tag to a task + * Remove a tag from a task +* Task Project + * Add a task to a project + * Remove a task from a project +* User + * Get a user + * Get all users + +## Templates and examples + + +[[ templatesWidget(page.title, 'asana') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.automizy.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Automizy node documentation +description: Learn how to use the Automizy node in n8n. Follow technical documentation to integrate Automizy node into your workflows. +contentType: [integration, reference] +--- + +# Automizy node + +Use the Automizy node to automate work in Automizy, and integrate Automizy with other applications. n8n has built-in support for a wide range of Automizy features, including creating, reading, listing, updating, deleting contacts, and lists. + +On this page, you'll find a list of operations the Automizy node supports and links to more resources. + +/// note | Credentials +Refer to [Automizy credentials](/integrations/builtin/credentials/automizy.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create a contact + * Delete a contact + * Get a contact + * Get all contacts + * Update a contact +* List + * Create a list + * Delete a list + * Get a list + * Get all lists + * Update a list + +## Templates and examples + + +[[ templatesWidget(page.title, 'automizy') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.autopilot.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Autopilot node documentation +description: Learn how to use the Autopilot node in n8n. Follow technical documentation to integrate Autopilot node into your workflows. +contentType: [integration, reference] +--- + +# Autopilot node + +Use the Autopilot node to automate work in Autopilot, and integrate Autopilot with other applications. n8n has built-in support for a wide range of Autopilot features, including creating, deleting, and updating contacts, as well as adding contacts to a list. + +On this page, you'll find a list of operations the Autopilot node supports and links to more resources. + +/// warning | Autopilot branding change +Autopilot has become Ortto. The Autopilot credentials and nodes are only compatible with Autopilot, not the new Ortto API. +/// +/// note | Credentials +Refer to [Autopilot credentials](/integrations/builtin/credentials/autopilot.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create/Update a contact + * Delete a contact + * Get a contact + * Get all contacts +* Contact Journey + * Add contact to list +* Contact List + * Add contact to list + * Check if contact is on list + * Get all contacts on list + * Remove a contact from a list +* List + * Create a list + * Get all lists + +## Templates and examples + + +[[ templatesWidget(page.title, 'autopilot') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awscertificatemanager.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Certificate Manager node documentation +description: Learn how to use the AWS Certificate Manager node in n8n. Follow technical documentation to integrate AAWS Certificage Manager node into your workflows. +contentType: [integration, reference] +--- + +# AWS Certificate Manager node + +Use the AWS Certificate Manager node to automate work in AWS Certificate Manager, and integrate AWS Certificate Manager with other applications. n8n has built-in support for a wide range of AWS Certificate Manager features, including creating, deleting, getting, and renewing SSL certificates. + +On this page, you'll find a list of operations the AWS Certificate Manager node supports and links to more resources. + +/// note | Credentials +Refer to [AWS Certificate Manager credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +## Operations + +* Certificate + * Delete + * Get + * Get Many + * Get Metadata + * Renew + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-certificate-manager') ]] + +## Related resources + +Refer to [AWS Certificate Manager's documentation](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html){:target=_blank .external-link} for more information on this service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awscomprehend.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Comprehend node documentation +description: Learn how to use the AWS Comprehend node in n8n. Follow technical documentation to integrate AWS Comprehend node into your workflows. +contentType: [integration, reference] +--- + +# AWS Comprehend node + +Use the AWS Comprehend node to automate work in AWS Comprehend, and integrate AWS Comprehend with other applications. n8n has built-in support for a wide range of AWS Comprehend features, including identifying and analyzing texts. + +On this page, you'll find a list of operations the AWS Comprehend node supports and links to more resources. + +/// note | Credentials +Refer to [AWS Comprehend credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +## Operations + +**Text** + +- Identify the dominant language +- Analyse the sentiment of the text + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-comprehend') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awsdynamodb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS DynamoDB node documentation +description: Learn how to use the AWS DynamoDB node in n8n. Follow technical documentation to integrate AWS DynamoDB node into your workflows. +contentType: [integration, reference] +--- + +# AWS DynamoDB node + +Use the AWS DynamoDB node to automate work in AWS DynamoDB, and integrate AWS DynamoDB with other applications. n8n has built-in support for a wide range of AWS DynamoDB features, including creating, reading, updating, deleting items, and records on a database. + +On this page, you'll find a list of operations the AWS DynamoDB node supports and links to more resources. + +/// note | Credentials +Refer to [AWS credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +## Operations + +* Item + * Create a new record, or update the current one if it already exists (upsert/put) + * Delete an item + * Get an item + * Get all items + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-dynamodb') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awselb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Elastic Load Balancing node documentation +description: Learn how to use the AWS Elastic Load Balancing node in n8n. Follow technical documentation to integrate AWS Elastic Load Balancing node into your workflows. +contentType: [integration, reference] +--- + +# AWS Elastic Load Balancing node + +Use the AWS Elastic Load Balancing node to automate work in AWS ELB, and integrate AWS ELB with other applications. n8n has built-in support for a wide range of AWS ELB features, including adding, getting, removing, deleting certificates and load balancers. + +On this page, you'll find a list of operations the AWS ELB node supports and links to more resources. + +/// note | Credentials +Refer to [AWS ELB credentials](/integrations/builtin/credentials/aws.md){:target=_blank .external-link} for guidance on setting up authentication. +/// + +## Operations + +* Listener Certificate + * Add + * Get Many + * Remove +* Load Balancer + * Create + * Delete + * Get + * Get Many + +This node supports creating and managing application and network load balancers. It doesn't currently support gateway load balancers. + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-elb') ]] + +## Related resources + +Refer to [AWS ELB's documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/what-is-load-balancing.html){:target=_blank .external-link} for more information on this service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awslambda.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Lambda node documentation +description: Learn how to use the AWS Lambda node in n8n. Follow technical documentation to integrate AWS Lambda node into your workflows. +contentType: [integration, reference] +--- + +# AWS Lambda node + +Use the AWS Lambda node to automate work in AWS Lambda, and integrate AWS Lambda with other applications. n8n has built-in support for a wide range of AWS Lambda features, including invoking functions. + +On this page, you'll find a list of operations the AWS Lambda node supports and links to more resources. + +/// note | Credentials +Refer to [AWS Lambda credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Invoke a function + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-lambda') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awsrekognition.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Rekognition node documentation +description: Learn how to use the AWS Rekognition node in n8n. Follow technical documentation to integrate AWS Rekognition node into your workflows. +contentType: [integration, reference] +--- + +# AWS Rekognition node + +Use the AWS Rekognition node to automate work in AWS Rekognition, and integrate AWS Rekognition with other applications. n8n has built-in support for a wide range of AWS Rekognition features, including analyzing images. + +On this page, you'll find a list of operations the AWS Rekognition node supports and links to more resources. + +/// note | Credentials +Refer to [AWS Rekognition credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +## Operations + +**Image** + +- Analyze + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-rekognition') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awss3.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS S3 node documentation +description: Learn how to use the AWS S3 node in n8n. Follow technical documentation to integrate AWS S3 node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# AWS S3 node + +Use the AWS S3 node to automate work in AWS S3, and integrate AWS S3 with other applications. n8n has built-in support for a wide range of AWS S3 features, including creating and deleting buckets, copying and downloading files, as well as getting folders. + +On this page, you'll find a list of operations the AWS S3 node supports and links to more resources. + +/// note | Credentials +Refer to [AWS credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Bucket + * Create a bucket + * Delete a bucket + * Get all buckets + * Search within a bucket +* File + * Copy a file + * Delete a file + * Download a file + * Get all files + * Upload a file +* Folder + * Create a folder + * Delete a folder + * Get all folders + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-s3') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awsses.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS SES node documentation +description: Learn how to use the AWS SES node in n8n. Follow technical documentation to integrate AWS SES node into your workflows. +contentType: [integration, reference] +--- + +# AWS SES node + +Use the AWS SES node to automate work in AWS SES, and integrate AWS SES with other applications. n8n has built-in support for a wide range of AWS SES features, including creating, getting, deleting, sending, updating, and adding templates and emails. + +On this page, you'll find a list of operations the AWS SES node supports and links to more resources. + +/// note | Credentials +Refer to [AWS SES credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Custom Verification Email + * Create a new custom verification email template + * Delete an existing custom verification email template + * Get the custom email verification template + * Get all the existing custom verification email templates for your account + * Add an email address to the list of identities + * Update an existing custom verification email template. +* Email + * Send + * Send Template +* Template + * Create a template + * Delete a template + * Get a template + * Get all templates + * Update a template + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-ses') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awssns.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS SNS node documentation +description: Learn how to use the AWS SNS node in n8n. Follow technical documentation to integrate AWS SNS node into your workflows. +contentType: [integration, reference] +--- + +# AWS SNS node + +Use the AWS SNS node to automate work in AWS SNS, and integrate AWS SNS with other applications. n8n has built-in support for a wide range of AWS SNS features, including publishing messages. + +On this page, you'll find a list of operations the AWS SNS node supports and links to more resources. + +/// note | Credentials +Refer to [AWS SNS credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +## Operations + +* Publish a message to a topic + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-sns') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awssqs.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS SQS node documentation +description: Learn how to use the AWS SQS node in n8n. Follow technical documentation to integrate AWS SQS node into your workflows. +contentType: [integration, reference] +--- + +# AWS SQS node + +Use the AWS SQS node to automate work in AWS SNS, and integrate AWS SQS with other applications. n8n has built-in support for a wide range of AWS SQS features, including sending messages. + +On this page, you'll find a list of operations the AWS SQS node supports and links to more resources. + +/// note | Credentials +Refer to [AWS SQS credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +## Operations + +* Send a message to a queue. + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-sqs') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awstextract.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Textract node documentation +description: Learn how to use the AWS Textract node in n8n. Follow technical documentation to integrate AWS Textract node into your workflows. +contentType: [integration, reference] +--- + +# AWS Textract node + +Use the AWS Textract node to automate work in AWS Textract, and integrate AWS Textract with other applications. n8n has built-in support for a wide range of AWS Textract features, including analyzing invoices. + +On this page, you'll find a list of operations the AWS Textract node supports and links to more resources. + +/// note | Credentials +Refer to [AWS Textract credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +- Analyze Receipt or Invoice + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-textract') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.awstranscribe.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Transcribe node documentation +description: Learn how to use the AWS Transcribe node in n8n. Follow technical documentation to integrate AWS Transcribe node into your workflows. +contentType: [integration, reference] +--- + +# AWS Transcribe node + +Use the AWS Transcribe node to automate work in AWS Transcribe, and integrate AWS Transcribe with other applications. n8n has built-in support for a wide range of AWS Transcribe features, including creating, deleting, and getting transcription jobs. + +On this page, you'll find a list of operations the AWS Transcribe node supports and links to more resources. + +/// note | Credentials +Refer to [AWS Transcribe credentials](/integrations/builtin/credentials/aws.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +**Transcription Job** + +- Create a transcription job +- Delete a transcription job +- Get a transcription job +- Get all transcriptions job + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-transcribe') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.azurecosmosdb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Azure Cosmos DB node documentation +description: Learn how to use the Azure Cosmos DB node in n8n. Follow technical documentation to integrate Azure Cosmos DB node into your workflows. +contentType: [integration, reference] +--- + +# Azure Cosmos DB node + +Use the Azure Cosmos DB node to automate work in Azure Cosmos DB and integrate Azure Cosmos DB with other applications. n8n has built-in support for a wide range of Azure Cosmos DB features, which includes creating, getting, updating, and deleting containers and items. + +On this page, you'll find a list of operations the Azure Cosmos DB node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/azurecosmosdb.md). +/// + + +## Operations + +* **Container**: + * **Create** + * **Delete** + * **Get** + * **Get Many** +* **Item**: + * **Create** + * **Delete** + * **Get** + * **Get Many** + * **Execute Query** + * **Update** + +## Templates and examples + + +[[ templatesWidget(page.title, 'azure-cosmos-db') ]] + +## Related resources + + +Refer to [Azure Cosmos DB's documentation](https://learn.microsoft.com/en-us/rest/api/cosmos-db/) for more information about the service. + + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.azurestorage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Azure Storage node documentation +description: Learn how to use the Azure Storage node in n8n. Follow technical documentation to integrate Azure Storage node into your workflows. +contentType: [integration, reference] +--- + +# Azure Storage node + +The Azure Storage node has built-in support for a wide range of features, which includes creating, getting, and deleting blobs and containers. Use this node to automate work within the Azure Storage service or integrate it with other services in your workflow. + +On this page, you'll find a list of operations the Azure Storage node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/azurestorage.md). +/// + + +## Operations + +* **Blob** + * **Create blob**: Create a new blob or replace an existing one. + * **Delete blob**: Delete an existing blob. + * **Get blob**: Retrieve data for a specific blob. + * **Get many blobs**: Retrieve a list of blobs. +* **Container** + * **Create container**: Create a new container. + * **Delete container**: Delete an existing container. + * **Get container**: Retrieve data for a specific container. + * **Get many containers**: Retrieve a list of containers. + +## Templates and examples + + +[[ templatesWidget(page.title, 'azure-storage') ]] + +## Related resources + + +Refer to [Microsoft's Azure Storage documentation](https://learn.microsoft.com/en-us/rest/api/storageservices/) for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.bamboohr.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: BambooHR node documentation +description: Learn how to use the BambooHR node in n8n. Follow technical documentation to integrate BambooHR node into your workflows. +contentType: [integration, reference] +--- + +# BambooHR node + +Use the BambooHR node to automate work in BambooHR, and integrate BambooHR with other applications. n8n has built-in support for a wide range of BambooHR features, including creating, deleting, downloading, and getting company reports, employee documents, and files. + +On this page, you'll find a list of operations the BambooHR node supports and links to more resources. + +/// note | Credentials +Refer to [BambooHR credentials](/integrations/builtin/credentials/bamboohr.md) for guidance on setting up authentication. +/// + +## Operations + +* Company Report + * Get a company report +* Employee + * Create an employee + * Get an employee + * Get all employees + * Update an employee +* Employee Document + * Delete an employee document + * Download an employee document + * Get all employee document + * Update an employee document + * Upload an employee document +* File + * Delete a company file + * Download a company file + * Get all company files + * Update a company file + * Upload a company file + +## Templates and examples + + +[[ templatesWidget(page.title, 'bamboohr') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.bannerbear.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Bannerbear node documentation +description: Learn how to use the Bannerbear node in n8n. Follow technical documentation to integrate Bannerbear node into your workflows. +contentType: [integration, reference] +--- + +# Bannerbear node + +Use the Bannerbear node to automate work in Bannerbear, and integrate Bannerbear with other applications. n8n has built-in support for a wide range of Bannerbear features, including creating and getting images and templates. + +On this page, you'll find a list of operations the Bannerbear node supports and links to more resources. + +/// note | Credentials +Refer to [Bannerbear credentials](/integrations/builtin/credentials/bannerbear.md) for guidance on setting up authentication. +/// + +## Operations + +* Image + * Create an image + * Get an image +* Template + * Get a template + * Get all templates + +## Templates and examples + + +[[ templatesWidget(page.title, 'bannerbear') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.baserow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Baserow node documentation +description: Learn how to use the Baserow node in n8n. Follow technical documentation to integrate Baserow node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Baserow node + +Use the Baserow node to automate work in Baserow, and integrate Baserow with other applications. n8n has built-in support for a wide range of Baserow features, including creating, getting, retrieving, and updating rows. + +On this page, you'll find a list of operations the Baserow node supports and links to more resources. + +/// note | Credentials +Refer to [Baserow credentials](/integrations/builtin/credentials/baserow.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Row + * Create a row + * Delete a row + * Retrieve a row + * Retrieve all rows + * Update a row + +## Templates and examples + + +[[ templatesWidget(page.title, 'baserow') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.beeminder.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Beeminder node documentation +description: Learn how to use the Beeminder node in n8n. Follow technical documentation to integrate Beeminder node into your workflows. +contentType: [integration, reference] +--- + +# Beeminder node + +Use the Beeminder node to automate work in Beeminder, and integrate Beeminder with other applications. n8n has built-in support for a wide range of Beeminder features, including creating, deleting, and updating data points. + +On this page, you'll find a list of operations the Beeminder node supports and links to more resources. + +/// note | Credentials +Refer to [Beeminder credentials](/integrations/builtin/credentials/beeminder.md) for guidance on setting up authentication. +/// + +## Operations + +**data point** +- Create data point for a goal +- Delete a data point +- Get all data points for a goal +- Update a data point + +## Templates and examples + + +[[ templatesWidget(page.title, 'beeminder') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.bitly.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Bitly node documentation +description: Learn how to use the Bitly node in n8n. Follow technical documentation to integrate Bitly node into your workflows. +contentType: [integration, reference] +--- + +# Bitly node + +Use the Bitly node to automate work in Bitly, and integrate Bitly with other applications. n8n has built-in support for a wide range of Bitly features, including creating, getting, and updating links. + +On this page, you'll find a list of operations the Bitly node supports and links to more resources. + +/// note | Credentials +Refer to [Bitly credentials](/integrations/builtin/credentials/bitly.md) for guidance on setting up authentication. +/// + +## Operations + +* Link + * Create a link + * Get a link + * Update a link + +## Templates and examples + + +[[ templatesWidget(page.title, 'bitly') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.bitwarden.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Bitwarden node documentation +description: Learn how to use the Bitwarden node in n8n. Follow technical documentation to integrate Bitwarden node into your workflows. +contentType: [integration, reference] +--- + +# Bitwarden node + +Use the Bitwarden node to automate work in Bitwarden, and integrate Bitwarden with other applications. n8n has built-in support for a wide range of Bitwarden features, including creating, getting, deleting, and updating collections, events, groups, and members. + +On this page, you'll find a list of operations the Bitwarden node supports and links to more resources. + +/// note | Credentials +Refer to [Bitwarden credentials](/integrations/builtin/credentials/bitwarden.md) for guidance on setting up authentication. +/// + +## Operations + +* Collection + * Delete + * Get + * Get All + * Update +* Event + * Get All +* Group + * Create + * Delete + * Get + * Get All + * Get Members + * Update + * Update Members +* Member + * Create + * Delete + * Get + * Get All + * Get Groups + * Update + * Update Groups + +## Templates and examples + + +[[ templatesWidget(page.title, 'bitwarden') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.box.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Box node documentation +description: Learn how to use the Box node in n8n. Follow technical documentation to integrate Box node into your workflows. +contentType: [integration, reference] +--- + +# Box node + +Use the Box node to automate work in Box, and integrate Box with other applications. n8n has built-in support for a wide range of Box features, including creating, copying, deleting, searching, uploading, and downloading files and folders. + +On this page, you'll find a list of operations the Box node supports and links to more resources. + +/// note | Credentials +Refer to [Box credentials](/integrations/builtin/credentials/box.md) for guidance on setting up authentication. +/// + + +## Operations + +* File + * Copy a file + * Delete a file + * Download a file + * Get a file + * Search files + * Share a file + * Upload a file +* Folder + * Create a folder + * Get a folder + * Delete a folder + * Search files + * Share a folder + * Update folder + +## Templates and examples + + +[[ templatesWidget(page.title, 'box') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.brandfetch.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Brandfetch node documentation +description: Learn how to use the Brandfetch node in n8n. Follow technical documentation to integrate Brandfetch node into your workflows. +contentType: [integration, reference] +--- + +# Brandfetch node + +Use the Brandfetch node to automate work in Brandfetch, and integrate Brandfetch with other applications. n8n has built-in support for a wide range of Brandfetch features, including returning a company’s information. + +On this page, you'll find a list of operations the Brandfetch node supports and links to more resources. + +/// note | Credentials +Refer to [Brandfetch credentials](/integrations/builtin/credentials/brandfetch.md) for guidance on setting up authentication. +/// + +## Operations + +* Return a company's colors +* Return a company's data +* Return a company's fonts +* Return a company's industry +* Return a company's logo & icon + +## Templates and examples + + +[[ templatesWidget(page.title, 'brandfetch') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.brevo.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Brevo node documentation +description: Learn how to use the Brevo node in n8n. Follow technical documentation to integrate Brevo node into your workflows. +contentType: [integration, reference] +--- + +# Brevo node + +Use the Brevo node to automate work in Brevo, and integrate Brevo with other applications. n8n has built-in support for a wide range of Brevo features, including creating, updating, deleting, and getting contacts, attributes, as well as sending emails. + +On this page, you'll find a list of operations the Brevo node supports and links to more resources. + +/// note | Credentials +Refer to [Brevo credentials](/integrations/builtin/credentials/brevo.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create + * Create or Update + * Delete + * Get + * Get All + * Update +* Contact Attribute + * Create + * Delete + * Get All + * Update +* Email + * Send + * Send Template +* Sender + * Create + * Delete + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'brevo') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.bubble.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Bubble node documentation +description: Learn how to use the Bubble node in n8n. Follow technical documentation to integrate Bubble node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Bubble node + +Use the Bubble node to automate work in Bubble, and integrate Bubble with other applications. n8n has built-in support for a wide range of Bubble features, including creating, deleting, getting, and updating objects. + +On this page, you'll find a list of operations the Bubble node supports and links to more resources. + +/// note | Credentials +Refer to [Bubble credentials](/integrations/builtin/credentials/bubble.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Object + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'bubble') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.chargebee.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Chargebee node documentation +description: Learn how to use the Chargebee node in n8n. Follow technical documentation to integrate Chargebee node into your workflows. +contentType: [integration, reference] +--- + +# Chargebee node + +Use the Chargebee node to automate work in Chargebee, and integrate Chargebee with other applications. n8n has built-in support for a wide range of Chargebee features, including creating customers, returning invoices, and canceling subscriptions. + +On this page, you'll find a list of operations the Chargebee node supports and links to more resources. + +/// note | Credentials +Refer to [Chargebee credentials](/integrations/builtin/credentials/chargebee.md) for guidance on setting up authentication. +/// + +## Operations + +* Customer + * Create a customer +* Invoice + * Return the invoices + * Get URL for the invoice PDF +* Subscription + * Cancel a subscription + * Delete a subscription + +## Templates and examples + + +[[ templatesWidget(page.title, 'chargebee') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.circleci.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: CircleCI node documentation +description: Learn how to use the CircleCI node in n8n. Follow technical documentation to integrate CircleCI node into your workflows. +contentType: [integration, reference] +--- + +# CircleCI node + +Use the CircleCI node to automate work in CircleCI, and integrate CircleCI with other applications. n8n has built-in support for a wide range of CircleCI features, including getting and triggering pipelines. + +On this page, you'll find a list of operations the CircleCI node supports and links to more resources. + +/// note | Credentials +Refer to [CircleCI credentials](/integrations/builtin/credentials/circleci.md) for guidance on setting up authentication. +/// + +## Operations + +* Pipeline + * Get a pipeline + * Get all pipelines + * Trigger a pipeline + +## Templates and examples + + +[[ templatesWidget(page.title, 'circleci') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.ciscowebex.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Webex by Cisco node documentation +description: Learn how to use the Webex by Cisco node in n8n. Follow technical documentation to integrate Webex by Cisco node into your workflows. +contentType: [integration, reference] +--- + +# Webex by Cisco node + +Use the Webex by Cisco node to automate work in Webex, and integrate Webex with other applications. n8n has built-in support for a wide range of Webex features, including creating, getting, updating, and deleting meetings and messages. + +On this page, you'll find a list of operations the Webex node supports and links to more resources. + +/// note | Credentials +Refer to [Webex credentials](/integrations/builtin/credentials/ciscowebex.md) for guidance on setting up authentication. +/// +/// note | Examples and Templates +For usage examples and templates to help you get started, take a look at n8n's [Webex integrations](https://n8n.io/integrations/webex-by-cisco/){:target=_blank .external-link} list. +/// + +## Operations + +* Meeting + * Create + * Delete + * Get + * Get All + * Update +* Message + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'webex-by-cisco') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.clearbit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Clearbit node documentation +description: Learn how to use the Clearbit node in n8n. Follow technical documentation to integrate Clearbit node into your workflows. +contentType: [integration, reference] +--- + +# Clearbit node + +Use the Clearbit node to automate work in Clearbit, and integrate Clearbit with other applications. n8n has built-in support for a wide range of Clearbit features, including autocompleting and looking up companies and persons. + +On this page, you'll find a list of operations the Clearbit node supports and links to more resources. + +/// note | Credentials +Refer to [Clearbit credentials](/integrations/builtin/credentials/clearbit.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Auto-complete company names and retrieve logo and domain + * Look up person and company data based on an email or domain +* Person + * Look up a person and company data based on an email or domain + +## Templates and examples + + +[[ templatesWidget(page.title, 'clearbit') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.clickup.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ClickUp node documentation +description: Learn how to use the ClickUp node in n8n. Follow technical documentation to integrate ClickUp node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# ClickUp node + +Use the ClickUp node to automate work in ClickUp, and integrate ClickUp with other applications. n8n has built-in support for a wide range of ClickUp features, including creating, getting, deleting, and updating folders, checklists, tags, comments, and goals. + +On this page, you'll find a list of operations the ClickUp node supports and links to more resources. + +/// note | Credentials +Refer to [ClickUp credentials](/integrations/builtin/credentials/clickup.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Checklist + * Create a checklist + * Delete a checklist + * Update a checklist +* Checklist Item + * Create a checklist item + * Delete a checklist item + * Update a checklist item +* Comment + * Create a comment + * Delete a comment + * Get all comments + * Update a comment +* Folder + * Create a folder + * Delete a folder + * Get a folder + * Get all folders + * Update a folder +* Goal + * Create a goal + * Delete a goal + * Get a goal + * Get all goals + * Update a goal +* Goal Key Result + * Create a key result + * Delete a key result + * Update a key result +* List + * Create a list + * Retrieve list's custom fields + * Delete a list + * Get a list + * Get all lists + * Get list members + * Update a list +* Space Tag + * Create a space tag + * Delete a space tag + * Get all space tags + * Update a space tag +* Task + * Create a task + * Delete a task + * Get a task + * Get all tasks + * Get task members + * Set a custom field + * Update a task +* Task List + * Add a task to a list + * Remove a task from a list +* Task Tag + * Add a tag to a task + * Remove a tag from a task +* Task Dependency + * Create a task dependency + * Delete a task dependency +* Time Entry + * Create a time entry + * Delete a time entry + * Get a time entry + * Get all time entries + * Start a time entry + * Stop the current running timer + * Update a time Entry +* Time Entry Tag + * Add tag to time entry + * Get all time entry tags + * Remove tag from time entry + +## Templates and examples + + +[[ templatesWidget(page.title, 'clickup') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.clockify.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Clockify node documentation +description: Learn how to use the Clockify node in n8n. Follow technical documentation to integrate Clockify node into your workflows. +contentType: [integration, reference] +--- + +# Clockify node + +Use the Clockify node to automate work in Clockify, and integrate Clockify with other applications. n8n has built-in support for a wide range of Clockify features, including creating, updating, getting, and deleting tasks, time entries, projects, and tags. + +On this page, you'll find a list of operations the Clockify node supports and links to more resources. + +/// note | Credentials +Refer to [Clockify credentials](/integrations/builtin/credentials/clockify.md) for guidance on setting up authentication. +/// + +## Operations + +* Project + * Create a project + * Delete a project + * Get a project + * Get all projects + * Update a project +* Tag + * Create a tag + * Delete a tag + * Get all tags + * Update a tag +* Task + * Create a task + * Delete a task + * Get a task + * Get all tasks + * Update a task +* Time Entry + * Create a time entry + * Delete a time entry + * Get time entry + * Update a time entry + +## Templates and examples + + +[[ templatesWidget(page.title, 'clockify') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.cloudflare.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Cloudflare node documentation +description: Learn how to use the Cloudflare node in n8n. Follow technical documentation to integrate Cloudflare node into your workflows. +contentType: [integration, reference] +--- + +# Cloudflare node + +Use the Cloudflare node to automate work in Cloudflare, and integrate Cloudflare with other applications. n8n has built-in support for a wide range of Cloudflare features, including deleting, getting, and uploading zone certificates. + +On this page, you'll find a list of operations the Cloudflare node supports and links to more resources. + +/// note | Credentials +Refer to [Cloudflare credentials](/integrations/builtin/credentials/cloudflare.md) for guidance on setting up authentication. +/// + +## Operations + +* Zone Certificate + * Delete + * Get + * Get Many + * Upload + +## Templates and examples + + +[[ templatesWidget(page.title, 'cloudflare') ]] + +## Related resources + +Refer to [Cloudflare's API documentation on zone-level authentication](https://api.cloudflare.com/#zone-level-authenticated-origin-pulls-properties){:target=_blank .external-link} for more information on this service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.cockpit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Cockpit node documentation +description: Learn how to use the Cockpit node in n8n. Follow technical documentation to integrate Cockpit node into your workflows. +contentType: [integration, reference] +--- + +# Cockpit node + +Use the Cockpit node to automate work in Cockpit, and integrate Cockpit with other applications. n8n has built-in support for a wide range of Cockpit features, including creating a collection entry, storing data from a form submission, and getting singletons. + +On this page, you'll find a list of operations the Cockpit node supports and links to more resources. + +/// note | Credentials +Refer to [Cockpit credentials](/integrations/builtin/credentials/cockpit.md) for guidance on setting up authentication. +/// + +## Operations + +* Collection + * Create a collection entry + * Get all collection entries + * Update a collection entry +* Form + * Store data from a form submission +* Singleton + * Get a singleton + +## Templates and examples + + +[[ templatesWidget(page.title, 'cockpit') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.coda.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Coda node documentation +description: Learn how to use the Coda node in n8n. Follow technical documentation to integrate Coda node into your workflows. +contentType: [integration, reference] +--- + +# Coda node + +Use the Coda node to automate work in Coda, and integrate Coda with other applications. n8n has built-in support for a wide range of Coda features, including creating, getting, and deleting controls, formulas, tables, and views. + +On this page, you'll find a list of operations the Coda node supports and links to more resources. + +/// note | Credentials +Refer to [Coda credentials](/integrations/builtin/credentials/coda.md) for guidance on setting up authentication. +/// + +## Operations + +* Control + * Get a control + * Get all controls +* Formula + * Get a formula + * Get all formulas +* Table + * Create/Insert a row + * Delete one or multiple rows + * Get all columns + * Get all the rows + * Get a column + * Get a row + * Pushes a button +* View + * Delete view row + * Get a view + * Get all views + * Get all views columns + * Get all views rows + * Update row + * Push view button + +## Templates and examples + + +[[ templatesWidget(page.title, 'coda') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.coingecko.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: CoinGecko node documentation +description: Learn how to use the CoinGecko node in n8n. Follow technical documentation to integrate CoinGecko node into your workflows. +contentType: [integration, reference] +--- + +# CoinGecko node + +Use the CoinGecko node to automate work in CoinGecko, and integrate CoinGecko with other applications. n8n has built-in support for a wide range of CoinGecko features, including getting coins and events. + +On this page, you'll find a list of operations the CoinGecko node supports and links to more resources. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Coin + * Get a candlestick open-high-low-close chart for the selected currency + * Get current data for a coin + * Get all coins + * Get historical data (name, price, market, stats) at a given date for a coin + * Get prices and market related data for all trading pairs that match the selected currency + * Get historical market data include price, market cap, and 24h volume (granularity auto) + * Get the current price of any cryptocurrencies in any other supported currencies that you need + * Get coin tickers +* Event + * Get all events + +## Templates and examples + + +[[ templatesWidget(page.title, 'coingecko') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.contentful.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Contentful node documentation +description: Learn how to use the Contentful node in n8n. Follow technical documentation to integrate Contentful node into your workflows. +contentType: [integration, reference] +--- + +# Contentful node + +Use the Contentful node to automate work in Contentful, and integrate Contentful with other applications. n8n has built-in support for a wide range of Contentful features, including getting assets, content types, entries, locales, and space. + +On this page, you'll find a list of operations the Contentful node supports and links to more resources. + +/// note | Credentials +Refer to [Contentful credentials](/integrations/builtin/credentials/contentful.md) for guidance on setting up authentication. +/// + +## Operations + +* Asset + * Get + * Get All +* Content Type + * Get +* Entry + * Get + * Get All +* Locale + * Get All +* Space + * Get + +## Templates and examples + + +[[ templatesWidget(page.title, 'contentful') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.convertkit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ConvertKit node documentation +description: Learn how to use the ConvertKit node in n8n. Follow technical documentation to integrate ConvertKit node into your workflows. +contentType: [integration, reference] +--- + +# ConvertKit node + +Use the ConvertKit node to automate work in ConvertKit, and integrate ConvertKit with other applications. n8n has built-in support for a wide range of ConvertKit features, including creating and deleting custom fields, getting tags, and adding subscribers. + +On this page, you'll find a list of operations the ConvertKit node supports and links to more resources. + +/// note | Credentials +Refer to [ConvertKit credentials](/integrations/builtin/credentials/convertkit.md) for guidance on setting up authentication. +/// + +## Operations + +* Custom Field + * Create a field + * Delete a field + * Get all fields + * Update a field +* Form + * Add a subscriber + * Get all forms + * List subscriptions to a form including subscriber data +* Sequence + * Add a subscriber + * Get all sequences + * Get all subscriptions to a sequence including subscriber data +* Tag + * Create a tag + * Get all tags +* Tag Subscriber + * Add a tag to a subscriber + * List subscriptions to a tag including subscriber data + * Delete a tag from a subscriber + +## Templates and examples + + +[[ templatesWidget(page.title, 'convertkit') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.copper.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Copper node documentation +description: Learn how to use the Copper node in n8n. Follow technical documentation to integrate Copper node into your workflows. +contentType: [integration, reference] +--- + +# Copper node + +Use the Copper node to automate work in Copper, and integrate Copper with other applications. n8n has built-in support for a wide range of Copper features, including getting, updating, deleting, and creating companies, customer sources, leads, projects and tasks. + +On this page, you'll find a list of operations the Copper node supports and links to more resources. + +/// note | Credentials +Refer to [Copper credentials](/integrations/builtin/credentials/copper.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Create + * Delete + * Get + * Get All + * Update +* Customer Source + * Get All +* Lead + * Create + * Delete + * Get + * Get All + * Update +* Opportunity + * Create + * Delete + * Get + * Get All + * Update +* Person + * Create + * Delete + * Get + * Get All + * Update +* Project + * Create + * Delete + * Get + * Get All + * Update +* Task + * Create + * Delete + * Get + * Get All + * Update +* User + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'copper') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.cortex.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Cortex node documentation +description: Learn how to use the Cortex node in n8n. Follow technical documentation to integrate Cortex node into your workflows. +contentType: [integration, reference] +--- + +# Cortex node + +Use the Cortex node to automate work in Cortex, and integrate Cortex with other applications. n8n has built-in support for a wide range of Cortex features, including executing analyzers, and responders, as well as getting job details. + +On this page, you'll find a list of operations the Cortex node supports and links to more resources. + +/// note | Credentials +Refer to [Cortex credentials](/integrations/builtin/credentials/cortex.md) for guidance on setting up authentication. +/// + +## Operations + +* Analyzer + * Execute Analyzer +* Job + * Get job details + * Get job report +* Responder + * Execute Responder + +## Templates and examples + + +[[ templatesWidget(page.title, 'cortex') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.cratedb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: CrateDB node documentation +description: Learn how to use the CrateDB node in n8n. Follow technical documentation to integrate CrateDB node into your workflows. +contentType: [integration, reference] +--- + +# CrateDB node + +Use the CrateDB node to automate work in CrateDB, and integrate CrateDB with other applications. n8n has built-in support for a wide range of CrateDB features, including executing, inserting, and updating rows in the database. + +On this page, you'll find a list of operations the CrateDB node supports and links to more resources. + +/// note | Credentials +Refer to [CrateDB credentials](/integrations/builtin/credentials/cratedb.md) for guidance on setting up authentication. +/// + +## Operations + +* Execute an SQL query +* Insert rows in database +* Update rows in database + +## Templates and examples + + +[[ templatesWidget(page.title, 'cratedb') ]] + +## Node reference + +### Specify a column's data type + +To specify a column's data type, append the column name with `:type`, where `type` is the data type you want for the column. For example, if you want to specify the type `int` for the column **id** and type `text` for the column **name**, you can use the following snippet in the **Columns** field: `id:int,name:text`. + + + + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.crowddev.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: crowd.dev node documentation +description: Learn how to use the crowd.dev node in n8n. Follow technical documentation to integrate crowd.dev node into your workflows. +contentType: [integration, reference] +--- + +# crowd.dev node + +Use the crowd.dev node to automate work in crowd.dev and integrate crowd.dev with other applications. n8n has built-in support for a wide range of crowd.dev features, which includes creating, updating, and deleting members, notes, organizations, and tasks. + +On this page, you'll find a list of operations the crowd.dev node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/crowddev.md). +/// + +## Operations + +* Activity + * Create or Update with a Member + * Create +* Automation + * Create + * Destroy + * Find + * List + * Update +* Member + * Create or Update + * Delete + * Find + * Update +* Note + * Create + * Delete + * Find + * Update +* Organization + * Create + * Delete + * Find + * Update +* Task + * Create + * Delete + * Find + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'crowddev') ]] + +## Related resources + +n8n provides a trigger node for crowd.dev. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.crowddevtrigger.md). + +Refer to [crowd.dev's documentation](https://docs.crowd.dev/reference/getting-started-with-crowd-dev-api){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.customerio.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Customer.io node documentation +description: Learn how to use the Customer.io node in n8n. Follow technical documentation to integrate Customer.io node into your workflows. +contentType: [integration, reference] +--- + +# Customer.io node + +Use the Customer.io node to automate work in Customer.io, and integrate Customer.io with other applications. n8n has built-in support for a wide range of Customer.io features, including creating and updating customers, tracking events, and getting campaigns. + +On this page, you'll find a list of operations the Customer.io node supports and links to more resources. + +/// note | Credentials +Refer to [Customer.io credentials](/integrations/builtin/credentials/customerio.md) for guidance on setting up authentication. +/// + +## Operations + +* Customer + * Create/Update a customer. + * Delete a customer. +* Event + * Track a customer event. + * Track an anonymous event. +* Campaign + * Get + * Get All + * Get Metrics +* Segment + * Add Customer + * Remove Customer + +## Templates and examples + + +[[ templatesWidget(page.title, 'customerio') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.deepl.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: DeepL node documentation +description: Learn how to use the DeepL node in n8n. Follow technical documentation to integrate DeepL node into your workflows. +contentType: [integration, reference] +--- + +# DeepL node + +Use the DeepL node to automate work in DeepL, and integrate DeepL with other applications. n8n has built-in support for a wide range of DeepL features, including translating languages. + +On this page, you'll find a list of operations the DeepL node supports and links to more resources. + +/// note | Credentials +Refer to [DeepL credentials](/integrations/builtin/credentials/deepl.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Language + * Translate data + +## Templates and examples + + +[[ templatesWidget(page.title, 'deepl') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.demio.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Demio node documentation +description: Learn how to use the Demio node in n8n. Follow technical documentation to integrate Demio node into your workflows. +contentType: [integration, reference] +--- + +# Demio node + +Use the Demio node to automate work in Demio, and integrate Demio with other applications. n8n has built-in support for a wide range of Demio features, including getting, and registering events and reports. + +On this page, you'll find a list of operations the Demio node supports and links to more resources. + +/// note | Credentials +Refer to [Demio credentials](/integrations/builtin/credentials/demio.md) for guidance on setting up authentication. +/// + +## Operations + +* Event + * Get an event + * Get all events + * Register someone to an event +* Report + * Get an event report + +## Templates and examples + + +[[ templatesWidget(page.title, 'demio') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.dhl.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: DHL node documentation +description: Learn how to use the DHL node in n8n. Follow technical documentation to integrate DHL node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# DHL node + +Use the DHL node to automate work in DHL, and integrate DHL with other applications. n8n has built-in support for a wide range of DHL features, including tracking shipment. + +On this page, you'll find a list of operations the DHL node supports and links to more resources. + +/// note | Credentials +Refer to [DHL credentials](/integrations/builtin/credentials/dhl.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Shipment + * Get Tracking Details + +## Templates and examples + + +[[ templatesWidget(page.title, 'dhl') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.discord/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Discord node common issues +description: Documentation for common issues and questions in the Discord node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Discord node common issues + +Here are some common errors and issues with the [Discord node](/integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md) and steps to resolve or troubleshoot them. + +## Add extra fields to embeds + +Discord messages can optionally include embeds, a rich preview component that can include a title, description, image, link, and more. + +The Discord node supports embeds when using the **Send** operation on the **Message** resource. Select **Add Embeds** to set extra fields including Description, Author, Title, URL, and URL Image. + +To add fields that aren't included by default, set **Input Method** to **Raw JSON**. From here, add a JSON object to the **Value** parameter defining the [field names](https://discord.com/developers/docs/resources/message#embed-object) and values you want to include. + +For example, to include `footer` and `fields`, neither of which are available using the **Enter Fields** Input Method, you could use a JSON object like this: + +```json +{ + "author": "My Name", + "url": "https://discord.js.org", + "fields": [ + { + "name": "Regular field title", + "value": "Some value here" + } + ], + "footer": { + "text": "Some footer text here", + "icon_url": "https://i.imgur.com/AfFp7pu.png" + } +} +``` + +You can learn more about embeds in [Using Webhooks and Embeds | Discord](https://discord.com/safety/using-webhooks-and-embeds). + +If you experience issues when working with embeds with the Discord node, you can use the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) with your existing Discord credentials to `POST` to the following URL: + +``` +https://discord.com/api/v10/channels//messages +``` + +In the body, include your embed information in the message content like this: + +```json +{ + "content": "Test", + "embeds": [ + { + "author": "My Name", + "url": "https://discord.js.org", + "fields": [ + { + "name": "Regular field title", + "value": "Some value here" + } + ], + "footer": { + "text": "Some footer text here", + "icon_url": "https://i.imgur.com/AfFp7pu.png" + } + } + ] +} +``` + +## Mention users and channels + +To mention users and channels in Discord messages, you need to format your message according to [Discord's message formatting guidelines](https://discord.com/developers/docs/reference#message-formatting). + +To mention a user, you need to know the Discord user's user ID. Keep in mind that the user ID is different from the user's display name. Similarly, you need a channel ID to link to a specific channel. + +You can learn how to enable developer mode and copy the user or channel IDs in [Discord's documentation on finding User/Server/Message IDs](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID). + +Once you have the user or channel ID, you can format your message with the following syntax: + +* **User**: `<@USER_ID>` +* **Channel**: `<#CHANNEL_ID>` +* **Role**: `<@&ROLE_ID>` + + +# integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Discord node documentation +description: Learn how to use the Discord node in n8n. Follow technical documentation to integrate Discord node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Discord node + +Use the Discord node to automate work in Discord, and integrate Discord with other applications. n8n has built-in support for a wide range of Discord features, including sending messages in a Discord channel and managing channels. + +On this page, you'll find a list of operations the Discord node supports and links to more resources. + +/// note | Credentials +Refer to [Discord credentials](/integrations/builtin/credentials/discord.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + + + +- Channel + - Create + - Delete + - Get + - Get Many + - Update +- Message + - Delete + - Get + - Get Many + - React with Emoji + - Send + * Send and Wait for Response +- Member + - Get Many + - Role Add + - Role Remove + +--8<-- "_snippets/integrations/builtin/send-and-wait-operation.md" + + + +## Templates and examples + + +[[ templatesWidget(page.title, 'discord') ]] + +## Related resources + +Refer to [Discord's documentation](https://discord.com/developers/docs/intro){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.discord/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.discourse.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Discourse node documentation +description: Learn how to use the Discourse node in n8n. Follow technical documentation to integrate Discourse node into your workflows. +contentType: [integration, reference] +--- + +# Discourse node + +Use the Discourse node to automate work in Discourse, and integrate Discourse with other applications. n8n has built-in support for a wide range of Discourse features, including creating, getting, updating, and removing categories, groups, posts, and users. + +On this page, you'll find a list of operations the Discourse node supports and links to more resources. + +/// note | Credentials +Refer to [Discourse credentials](/integrations/builtin/credentials/discourse.md) for guidance on setting up authentication. +/// + +## Operations + +* Category + * Create a category + * Get all categories + * Update a category +* Group + * Create a group + * Get a group + * Get all groups + * Update a group +* Post + * Create a post + * Get a post + * Get all posts + * Update a post +* User + * Create a user + * Get a user + * Get all users +* User Group + * Create a user to group + * Remove user from group + +## Templates and examples + + +[[ templatesWidget(page.title, 'discourse') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.disqus.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Disqus node documentation +description: Learn how to use the Disqus node in n8n. Follow technical documentation to integrate Disqus node into your workflows. +contentType: [integration, reference] +--- + +# Disqus node + +Use the Disqus node to automate work in Disqus, and integrate Disqus with other applications. n8n has built-in support for a wide range of Disqus features, including returning forums. + +On this page, you'll find a list of operations the Disqus node supports and links to more resources. + +/// note | Credentials +Refer to [Disqus credentials](/integrations/builtin/credentials/disqus.md) for guidance on setting up authentication. +/// + +## Operations + +* Forum + * Return forum details + * Return a list of categories within a forum + * Return a list of threads within a forum + * Return a list of posts within a forum + +## Templates and examples + + +[[ templatesWidget(page.title, 'disqus') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.drift.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Drift node documentation +description: Learn how to use the Drift node in n8n. Follow technical documentation to integrate Drift node into your workflows. +contentType: [integration, reference] +--- + +# Drift node + +Use the Drift node to automate work in Drift, and integrate Drift with other applications. n8n has built-in support for a wide range of Drift features, including creating, updating, deleting, and getting contacts. + +On this page, you'll find a list of operations the Drift node supports and links to more resources. + +/// note | Credentials +Refer to [Drift credentials](/integrations/builtin/credentials/drift.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create a contact + * Get custom attributes + * Delete a contact + * Get a contact + * Update a contact + +## Templates and examples + + +[[ templatesWidget(page.title, 'drift') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.dropbox.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Dropbox node documentation +description: Learn how to use the Dropbox node in n8n. Follow technical documentation to integrate Dropbox node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Dropbox node + +Use the Dropbox node to automate work in Dropbox, and integrate Dropbox with other applications. n8n has built-in support for a wide range of Dropbox features, including creating, downloading, moving, and copying files and folders. + +On this page, you'll find a list of operations the Dropbox node supports and links to more resources. + +/// note | Credentials +Refer to [Dropbox credentials](/integrations/builtin/credentials/dropbox.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* File + * Copy a file + * Delete a file + * Download a file + * Move a file + * Upload a file +* Folder + * Copy a folder + * Create a folder + * Delete a folder + * Return the files and folders in a given folder + * Move a folder +* Search + * Query + +## Templates and examples + + +[[ templatesWidget(page.title, 'dropbox') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.dropcontact.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Dropcontact node documentation +description: Learn how to use the Dropcontact node in n8n. Follow technical documentation to integrate Dropcontact node into your workflows. +contentType: [integration, reference] +--- + +# Dropcontact node + +Use the Dropcontact node to automate work in Dropcontact, and integrate Dropcontact with other applications. n8n has built-in support for a wide range of Dropcontact features, including fetching contacts. + +On this page, you'll find a list of operations the Dropcontact node supports and links to more resources. + +/// note | Credentials +Refer to [Dropcontact credentials](/integrations/builtin/credentials/dropcontact.md) for guidance on setting up authentication. +/// + +## Operations + +**Contact** +- Enrich +- Fetch Request + +## Templates and examples + + +[[ templatesWidget(page.title, 'dropcontact') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.egoi.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: E-goi node documentation +description: Learn how to use the E=goi node in n8n. Follow technical documentation to integrate E=goi node into your workflows. +contentType: [integration, reference] +--- + +# E-goi node + +Use the E-goi node to automate work in E-goi, and integrate E-goi with other applications. n8n has built-in support for a wide range of E-goi features, including creating, updating, deleting, and getting contacts. + +On this page, you'll find a list of operations the E-goi node supports and links to more resources. + +/// note | Credentials +Refer to [E-goi credentials](/integrations/builtin/credentials/egoi.md) for guidance on setting up authentication. +/// + +## Operations + +**Contact** + +- Create a member +- Get a member +- Get all members +- Update a member + +## Templates and examples + + +[[ templatesWidget(page.title, 'e-goi') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.elasticsearch.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Elasticsearch node documentation +description: Learn how to use the Elasticsearch node in n8n. Follow technical documentation to integrate Elasticsearch node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Elasticsearch node + +Use the Elasticsearch node to automate work in Elasticsearch, and integrate Elasticsearch with other applications. n8n has built-in support for a wide range of Elasticsearch features, including creating, updating, deleting, and getting documents and indexes. + +On this page, you'll find a list of operations the Elasticsearch node supports and links to more resources. + +/// note | Credentials +Refer to [Elasticsearch credentials](/integrations/builtin/credentials/elasticsearch.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Document + * Create a document + * Delete a document + * Get a document + * Get all documents + * Update a document +* Index + * Create + * Delete + * Get + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'elasticsearch') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.elasticsecurity.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Elastic Security node documentation +description: Learn how to use the Elastic Security node in n8n. Follow technical documentation to integrate Elastic Security node into your workflows. +contentType: [integration, reference] +--- + +# Elastic Security node + +Use the Elastic Security node to automate work in Elastic Security, and integrate Elastic Security with other applications. n8n's has built-in support for a wide range of Elastic Security features, including creating, updating, deleting, retrieving, and getting cases. + +On this page, you'll find a list of operations the Elastic Security node supports and links to more resources. + +/// note | Credentials +Refer to [Elastic Security credentials](/integrations/builtin/credentials/elasticsecurity.md) for guidance on setting up authentication. +/// + +## Operations + +* Case + * Create a case + * Delete a case + * Get a case + * Retrieve all cases + * Retrieve a summary of all case activity + * Update a case +* Case Comment + * Add a comment to a case + * Get a case comment + * Retrieve all case comments + * Remove a comment from a case + * Update a comment in a case +* Case Tag + * Add a tag to a case + * Remove a tag from a case +* Connector + * Create a connector + +## Templates and examples + + +[[ templatesWidget(page.title, 'elastic-security') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.emelia.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Emelia node documentation +description: Learn how to use the Emelia node in n8n. Follow technical documentation to integrate Emelia node into your workflows. +contentType: [integration, reference] +--- + +# Emelia node + +Use the Emelia node to automate work in Emelia, and integrate Emelia with other applications. n8n has built-in support for a wide range of Emelia features, including creating campaigns, and adding contacts to a list. + +On this page, you'll find a list of operations the Emelia node supports and links to more resources. + +/// note | Credentials +Refer to [Emelia credentials](/integrations/builtin/credentials/emelia.md) for guidance on setting up authentication. +/// + +## Operations + +* Campaign + * Add Contact + * Create + * Get + * Get All + * Pause + * Start +* Contact List + * Add + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'emelia') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.erpnext.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ERPNext node documentation +description: Learn how to use the ERPNext node in n8n. Follow technical documentation to integrate ERPNext node into your workflows. +contentType: [integration, reference] +--- + +# ERPNext node + +Use the ERPNext node to automate work in ERPNext, and integrate ERPNext with other applications. n8n has built-in support for a wide range of ERPNext features, including creating, updating, retrieving, and deleting documents. + +On this page, you'll find a list of operations the ERPNext node supports and links to more resources. + +/// note | Credentials +Refer to [ERPNext credentials](/integrations/builtin/credentials/erpnext.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +**Document** +- Create a document +- Delete a document +- Retrieve a document +- Retrieve all documents +- Update a document + +## Templates and examples + + +[[ templatesWidget(page.title, 'erpnext') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Facebook Graph API node documentation +description: Learn how to use the Facebook Graph API node in n8n. Follow technical documentation to integrate Facebook Graph API node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Facebook Graph API node + +Use the Facebook Graph API node to automate work in Facebook Graph API, and integrate Facebook Graph API with other applications. n8n has built-in support for a wide range of Facebook Graph API features, including using queries GET POST DELETE for several parameters like host URL, request methods and much more. + +On this page, you'll find a list of operations the Facebook Graph API node supports and links to more resources. + +/// note | Credentials +Refer to [Facebook Graph API credentials](/integrations/builtin/credentials/facebookgraph.md) for guidance on setting up authentication. +/// + +## Operations + +* **Default** + * GET + * POST + * DELETE +* **Video Uploads** + * GET + * POST + * DELETE + + +### Parameters + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +* **Host URL**: The host URL for the request. The following options are available: + * **Default**: Requests are passed to the `graph.facebook.com` host URL. Used for the majority of requests. + * **Video**: Requests are passed to the `graph-video.facebook.com` host URL. Used for video upload requests only. +* **HTTP Request Method**: The method to be used for this request, from the following options: + * **GET** + * **POST** + * **DELETE** +* **Graph API Version**: The version of the [Facebook Graph API](https://developers.facebook.com/docs/graph-api/changelog) to be used for this request. +* **Node**: The node on which to operate, for example `//feed`. Read more about it in the [official Facebook Developer documentation](https://developers.facebook.com/docs/graph-api/using-graph-api). +* **Edge**: Edge of the node on which to operate. Edges represent collections of objects which are attached to the node. +* **Ignore SSL Issues**: Toggle to still download the response even if SSL certificate validation isn't possible. +* **Send Binary File**: Available for `POST` operations. If enabled binary data is sent as the body. Requires setting the following: + * **Input Binary Field**: Name of the binary property which contains the data for the file to be uploaded. + +## Templates and examples + + +[[ templatesWidget(page.title, 'facebook-graph-api') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.filemaker.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: FileMaker node documentation +description: Learn how to use the FileMaker node in n8n. Follow technical documentation to integrate FileMaker node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# FileMaker node + +Use the FileMaker node to automate work in FileMaker, and integrate FileMaker with other applications. n8n has built-in support for a wide range of FileMaker features, including creating, finding, getting, editing, and duplicating files. + +On this page, you'll find a list of operations the FileMaker node supports and links to more resources. + +/// note | Credentials +Refer to [FileMaker credentials](/integrations/builtin/credentials/filemaker.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +- Find Records +- Get Records +- Get Records by Id +- Perform Script +- Create Record +- Edit Record +- Duplicate Record +- Delete Record + +## Templates and examples + + +[[ templatesWidget(page.title, 'filemaker') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.flow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Flow node documentation +description: Learn how to use the Flow node in n8n. Follow technical documentation to integrate Flow node into your workflows. +contentType: [integration, reference] +--- + +# Flow node + +Use the Flow node to automate work in Flow, and integrate Flow with other applications. n8n has built-in support for a wide range of Flow features, including creating, updating, and getting tasks. + +On this page, you'll find a list of operations the Flow node supports and links to more resources. + +/// note | Credentials +Refer to [Flow credentials](/integrations/builtin/credentials/flow.md) for guidance on setting up authentication. +/// + +## Operations + +* Task + * Create a new task + * Update a task + * Get a task + * Get all the tasks + +## Templates and examples + + +[[ templatesWidget(page.title, 'flow') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.freshdesk.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Freshdesk node documentation +description: Learn how to use the Freshdesk node in n8n. Follow technical documentation to integrate Freshdesk node into your workflows. +contentType: [integration, reference] +--- + +# Freshdesk node + +Use the Freshdesk node to automate work in Freshdesk and integrate Freshdesk with other applications. n8n has built-in support for a wide range of Freshdesk features, including creating, updating, deleting, and getting contacts and tickets. + +On this page, you'll find a list of operations the Freshdesk node supports and links to more resources. + +/// note | Credentials +Refer to [Freshdesk credentials](/integrations/builtin/credentials/freshdesk.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create a new contact + * Delete a contact + * Get a contact + * Get all contacts + * Update a contact +* Ticket + * Create a new ticket + * Delete a ticket + * Get a ticket + * Get all tickets + * Update a ticket + +## Templates and examples + + +[[ templatesWidget(page.title, 'freshdesk') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.freshservice.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Freshservice node documentation +description: Learn how to use the Freshservice node in n8n. Follow technical documentation to integrate Freshservice node into your workflows. +contentType: [integration, reference] +--- + +# Freshservice node + +Use the Freshservice node to automate work in Freshservice and integrate Freshservice with other applications. n8n has built-in support for a wide range of Freshdesk features, including creating, updating, deleting, and getting agent information and departments. + +On this page, you'll find a list of operations the Freshservice node supports and links to more resources. + +/// note | Credentials +Refer to [Freshservice credentials](/integrations/builtin/credentials/freshservice.md) for guidance on setting up authentication. +/// + +## Operations + +* Agent + * Create an agent + * Delete an agent + * Retrieve an agent + * Retrieve all agents + * Update an agent +* Agent Group + * Create an agent group + * Delete an agent group + * Retrieve an agent group + * Retrieve all agent groups + * Update an agent group +* Agent Role + * Retrieve an agent role + * Retrieve all agent roles +* Announcement + * Create an announcement + * Delete an announcement + * Retrieve an announcement + * Retrieve all announcements + * Update an announcement +* Asset Type + * Create an asset type + * Delete an asset type + * Retrieve an asset type + * Retrieve all asset types + * Update an asset type +* Change + * Create a change + * Delete a change + * Retrieve a change + * Retrieve all changes + * Update a change +* Department + * Create a department + * Delete a department + * Retrieve a department + * Retrieve all departments + * Update a department +* Location + * Create a location + * Delete a location + * Retrieve a location + * Retrieve all locations + * Update a location +* Problem + * Create a problem + * Delete a problem + * Retrieve a problem + * Retrieve all problems + * Update a problem +* Product + * Create a product + * Delete a product + * Retrieve a product + * Retrieve all products + * Update a product +* Release + * Create a release + * Delete a release + * Retrieve a release + * Retrieve all releases + * Update a release +* Requester + * Create a requester + * Delete a requester + * Retrieve a requester + * Retrieve all requesters + * Update a requester +* Requester Group + * Create a requester group + * Delete a requester group + * Retrieve a requester group + * Retrieve all requester groups + * Update a requester group +* Software + * Create a software application + * Delete a software application + * Retrieve a software application + * Retrieve all software applications + * Update a software application +* Ticket + * Create a ticket + * Delete a ticket + * Retrieve a ticket + * Retrieve all tickets + * Update a ticket + +## Templates and examples + + +[[ templatesWidget(page.title, 'freshservice') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.freshworkscrm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Freshworks CRM node documentation +description: Learn how to use the Freshworks CRM node in n8n. Follow technical documentation to integrate Freshworks CRM node into your workflows. +contentType: [integration, reference] +--- + +# Freshworks CRM node + +Use the Freshworks CRM node to automate work in Freshworks CRM, and integrate Freshworks CRM with other applications. n8n has built-in support for a wide range of Freshworks CRM features, including creating, updating, deleting, and retrieve, accounts, appointments, contacts, deals, notes, sales activity and more. + +On this page, you'll find a list of operations the Freshworks CRM node supports and links to more resources. + +/// note | Credentials +Refer to [Freshworks CRM credentials](/integrations/builtin/credentials/freshworkscrm.md) for guidance on setting up authentication. +/// + +## Operations + +* Account + * Create an account + * Delete an account + * Retrieve an account + * Retrieve all accounts + * Update an account +* Appointment + * Create an appointment + * Delete an appointment + * Retrieve an appointment + * Retrieve all appointments + * Update an appointment +* Contact + * Create a contact + * Delete a contact + * Retrieve a contact + * Retrieve all contacts + * Update a contact +* Deal + * Create a deal + * Delete a deal + * Retrieve a deal + * Retrieve all deals + * Update a deal +* Note + * Create a note + * Delete a note + * Update a note +* Sales Activity + * Retrieve a sales activity + * Retrieve all sales activities +* Task + * Create a task + * Delete a task + * Retrieve a task + * Retrieve all tasks + * Update a task + +## Templates and examples + + +[[ templatesWidget(page.title, 'freshworks-crm') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.getresponse.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: GetResponse node documentation +description: Learn how to use the GetResponse node in n8n. Follow technical documentation to integrate GetResponse node into your workflows. +contentType: [integration, reference] +--- + +# GetResponse node + +Use the GetResponse node to automate work in GetResponse, and integrate GetResponse with other applications. n8n has built-in support for a wide range of GetResponse features, including creating, updating, deleting, and getting contacts. + +On this page, you'll find a list of operations the GetResponse node supports and links to more resources. + +/// note | Credentials +Refer to [GetResponse credentials](/integrations/builtin/credentials/getresponse.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create a new contact + * Delete a contact + * Get a contact + * Get all contacts + * Update contact properties + +## Templates and examples + + +[[ templatesWidget(page.title, 'getresponse') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.ghost.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Ghost node documentation +description: Learn how to use the Ghost node in n8n. Follow technical documentation to integrate Ghost node into your workflows. +contentType: [integration, reference] +--- + +# Ghost node + +Use the Ghost node to automate work in Ghost, and integrate Ghost with other applications. n8n has built-in support for a wide range of Ghost features, including creating, updating, deleting, and getting posts for the Admin and content API. + +On this page, you'll find a list of operations the Ghost node supports and links to more resources. + +/// note | Credentials +Refer to [Ghost credentials](/integrations/builtin/credentials/ghost.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +### Admin API + +* **Post** + * Create a post + * Delete a post + * Get a post + * Get all posts + * Update a post + + +### Content API + +* **Post** + * Get a post + * Get all posts + +## Templates and examples + + +[[ templatesWidget(page.title, 'ghost') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.github.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: GitHub node documentation +description: Learn how to use the GitHub node in n8n. Follow technical documentation to integrate GitHub node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# GitHub node + +Use the GitHub node to automate work in GitHub, and integrate GitHub with other applications. n8n has built-in support for a wide range of GitHub features, including creating, updating, deleting, and editing files, repositories, issues, releases, and users. + +On this page, you'll find a list of operations the GitHub node supports and links to more resources. + +/// note | Credentials +Refer to [GitHub credentials](/integrations/builtin/credentials/github.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* File + * Create + * Delete + * Edit + * Get + * List +* Issue + * Create + * Create Comment + * Edit + * Get + * Lock +* Organization + * Get Repositories +* Release + * Create + * Delete + * Get + * Get Many + * Update +* Repository + * Get + * Get Issues + * Get License + * Get Profile + * Get Pull Requests + * List Popular Paths + * List Referrers +* Review + * Create + * Get + * Get Many + * Update +* User + * Get Repositories + * Invite +* Workflow + * Disable + * Dispatch + * Enable + * Get + * Get Usage + * List + +## Templates and examples + + +[[ templatesWidget(page.title, 'github') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.gitlab.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: GitLab node documentation +description: Learn how to use the GitLab node in n8n. Follow technical documentation to integrate GitLab node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# GitLab node + +Use the GitLab node to automate work in GitLab, and integrate GitLab with other applications. n8n has built-in support for a wide range of GitLab features, including creating, updating, deleting, and editing issues, repositories, releases and users. + +On this page, you'll find a list of operations the GitLab node supports and links to more resources. + +/// note | Credentials +Refer to [GitLab credentials](/integrations/builtin/credentials/gitlab.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* File + * Create + * Delete + * Edit + * Get + * List +* Issue + * Create a new issue + * Create a new comment on an issue + * Edit an issue + * Get the data of a single issue + * Lock an issue +* Release + * Create a new release + * Delete a new release + * Get a new release + * Get all releases + * Update a new release +* Repository + * Get the data of a single repository + * Returns issues of a repository +* User + * Returns the repositories of a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'gitlab') ]] + +## Related resources + +Refer to [GitLab's documentation](https://docs.gitlab.com/ee/api/rest/){:target=_blank .external-link} for more information about the service. + +n8n provides a trigger node for GitLab. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.gitlabtrigger.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gmail node common issues +description: Documentation for common issues and questions in the Gmail node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: critical +--- + +# Gmail node common issues + +Here are some common errors and issues with the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) and steps to resolve or troubleshoot them. + +## Remove the n8n attribution from sent messages + +If you're using the node to [send a message](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#send-a-message) or [reply to a message](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#reply-to-a-message), the node appends this statement to the end of the email: + +> This email was sent automatically with n8n + +To remove this attribution: + +1. In the node's **Options** section, select **Add option**. +2. Select **Append n8n attribution**. +3. Turn the toggle off. + +Refer to [Send options](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#send-options) and [Reply options](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#reply-options) for more information. + +## Forbidden - perhaps check your credentials + +This error displays next to certain dropdowns in the node, like the **Label Names or IDs** dropdown. The full text looks something like this: + +``` +There was a problem loading the parameter options from server: "Forbidden - perhaps check your credentials?" +``` + +The error most often displays when you're using a Google Service Account as the credential and the credential doesn't have **Impersonate a User** turned on. + +Refer to [Google Service Account: Finish your n8n credential](/integrations/builtin/credentials/google/service-account.md#finish-your-n8n-credential) for more information. + +## 401 unauthorized error + +The full text of the error looks like this: + +``` +401 - {"error":"unauthorized_client","error_description":"Client is unauthorized to retrieve access tokens using this method, or client not authorized for any of the scopes requested."} +``` + + +This error occurs when there's an issue with the credential you're using and its scopes or permissions. + +To resolve: + +1. For [OAuth2](/integrations/builtin/credentials/google/oauth-single-service.md) credentials, make sure you've enabled the Gmail API in **APIs & Services > Library**. Refer to [Google OAuth2 Single Service - Enable APIs](/integrations/builtin/credentials/google/oauth-single-service.md#enable-apis) for more information. +2. For [Service Account](/integrations/builtin/credentials/google/service-account.md) credentials: + 1. [Enable domain-wide delegation](/integrations/builtin/credentials/google/service-account.md#enable-domain-wide-delegation). + 2. Make sure you add the Gmail API as part of the domain-wide delegation configuration. + +## Bad request - please check your parameters + +This error most often occurs if you enter a Message ID, Thread ID, or Label ID that doesn't exist. + +Try a **Get** operation with the ID to confirm it exists. + + +# integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gmail node Draft Operations documentation +description: Learn how to use the Draft Operations of the Gmail node in n8n. Follow technical documentation to integrate Draft Operations into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Gmail node Draft Operations + +Use the Draft operations to create, delete, or get a draft or list drafts in Gmail. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) for more information on the Gmail node itself. + +## Create a draft + +Use this operation to create a new draft. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Draft**. +* **Operation**: Select **Create**. +* **Subject**: Enter the subject line. +* Select the **Email Type**. Choose from **Text** or **HTML**. +* **Message**: Enter the email message body. + +### Create draft options + +Use these options to further refine the node's behavior: + +* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment. + * For multiple properties, enter a comma-separated list. +* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **From Alias Name or ID**: Select an alias to send the draft from. This field populates based on the credential you selected in the parameters. +* **Send Replies To**: Enter an email address to set as the reply to address. +* **Thread ID**: If you want this draft attached to a thread, enter the ID for that thread. +* **To Email**: Enter one or more email addresses for recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. + +Refer to the [Gmail API Method: users.drafts.create](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create){:target=_blank .external-link} documentation for more information. + +## Delete a draft + +Use this operation to delete a draft. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Draft**. +* **Operation**: Select **Delete**. +* **Draft ID**: Enter the ID of the draft you wish to delete. + +Refer to the [Gmail API Method: users.drafts.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/delete){:target=_blank .external-link} documentation for more information. + +## Get a draft + +Use this operation to get a single draft. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Draft**. +* **Operation**: Select **Get**. +* **Draft ID**: Enter the ID of the draft you wish to get information about. + +### Get draft options + +Use these options to further refine the node's behavior: + +* **Attachment Prefix**: Enter a prefix for the name of the binary property the node should write any attachments to. n8n adds an index starting with `0` to the prefix. For example, if you enter `attachment_' as the prefix, the first attachment saves to 'attachment_0'. +* **Download Attachments**: Select whether the node should download the draft's attachments (turned on) or not (turned off). + +Refer to the [Gmail API Method: users.drafts.get](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/get){:target=_blank .external-link} documentation for more information. + + +## Get Many drafts + + +Use this operation to get two or more drafts. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Draft**. +* **Operation**: Select **Get Many**. +* **Return All**: Choose whether the node returns all drafts (turned on) or only up to a set limit (turned off). +* **Limit**: Enter the maximum number of drafts to return. Only used if you've turned off **Return All**. + + +### Get Many drafts options + + +Use these options to further refine the node's behavior: + +* **Attachment Prefix**: Enter a prefix for the name of the binary property the node should write any attachments to. n8n adds an index starting with `0` to the prefix. For example, if you enter `attachment_' as the prefix, the first attachment saves to 'attachment_0'. +* **Download Attachments**: Select whether the node should download the draft's attachments (turned on) or not (turned off). +* **Include Spam and Trash**: Select whether the node should get drafts in the Spam and Trash folders (turned on) or not (turned off). + +Refer to the [Gmail API Method: users.drafts.list](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/list){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gmail node documentation +description: Learn how to use the Gmail node in n8n. Follow technical documentation to integrate Gmail node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Gmail node + +Use the Gmail node to automate work in Gmail, and integrate Gmail with other applications. n8n has built-in support for a wide range of Gmail features, including creating, updating, deleting, and getting drafts, messages, labels, thread. + +On this page, you'll find a list of operations the Gmail node supports and links to more resources. + +/// note | Credentials +Refer to [Google credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* **Draft** + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md#create-a-draft) a draft + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md#delete-a-draft) a draft + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md#get-a-draft) a draft + * [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/draft-operations.md#get-many-drafts) drafts +* **Label** + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md#create-a-label) a label + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md#delete-a-label) a label + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md#get-a-label) a label + * [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md#get-many-labels) labels +* **Message** + * [**Add Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#add-label-to-a-message) to a message + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#delete-a-message) a message + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#get-a-message) a message + * [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#get-many-messages) messages + * [**Mark as Read**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#mark-as-read) + * [**Mark as Unread**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#mark-as-unread) + * [**Remove Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#remove-label-from-a-message) from a message + * [**Reply**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#reply-to-a-message) to a message + * [**Send**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md#send-a-message) a message +* **Thread** + * [**Add Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#add-label-to-a-thread) to a thread + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#delete-a-thread) a thread + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#get-a-thread) a thread + * [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#get-many-threads) threads + * [**Remove Label**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#remove-label-from-a-thread) from thread + * [**Reply**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#reply-to-a-message) to a message + * [**Trash**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#trash-a-thread) a thread + * [**Untrash**](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#untrash-a-thread) a thread + +## Templates and examples + + +[[ templatesWidget(page.title, 'gmail') ]] + +## Related resources + +Refer to Google's [Gmail API documentation](https://developers.google.com/gmail/api) for detailed information about the API that this node integrates with. + +n8n provides a trigger node for Gmail. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/index.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.gmail/label-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gmail node Label Operations documentation +description: Learn how to use the Label Operations of the Gmail node in n8n. Follow technical documentation to integrate Label Operations into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Gmail node Label Operations + +Use the Label operations to create, delete, or get a label or list labels in Gmail. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) for more information on the Gmail node itself. + +## Create a label + +Use this operation to create a new label. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Label**. +* **Operation**: Select **Create**. +* **Name**: Enter a display name for the label. + +### Create label options + +Use these options to further refine the node's behavior: + +* **Label List Visibility**: Sets the visibility of the label in the label list in the Gmail web interface. Choose from: + * **Hide**: Don't show the label in the label list. + * **Show** (default): Show the label in the label list. + * **Show if Unread**: Show the label if there are any unread messages with that label. +* **Message List Visibility**: Sets the visibility of messages with this label in the message list in the Gmail web interface. Choose whether to **Show** or **Hide** messages with this label. + +Refer to the [Gmail API Method: users.labels.create](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/create){:target=_blank .external-link} documentation for more information. + +## Delete a label + +Use this operation to delete an existing label. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Label**. +* **Operation**: Select **Delete**. +* **Label ID**: Enter the ID of the label you want to delete. + +Refer to the [Gmail API Method: users.labels.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/delete){:target=_blank .external-link} documentation for more information. + +## Get a label + +Use this operation to get an existing label. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Label**. +* **Operation**: Select **Get**. +* **Label ID**: Enter the ID of the label you want to get. + +Refer to the [Gmail API Method: users.labels.get](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/get){:target=_blank .external-link} documentation for more information. + + +## Get Many labels + + +Use this operation to get two or more labels. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Label**. +* **Operation**: Select **Get Many**. +* **Return All**: Choose whether the node returns all labels (turned on) or only up to a set limit (turned off). +* **Limit**: Enter the maximum number of labels to return. Only used if you've turned off **Return All**. + +Refer to the [Gmail API Method: users.labels.list](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.gmail/message-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gmail node Message Operations documentation +description: Learn how to use the Message Operations of the Gmail node in n8n. Follow technical documentation to integrate Message Operations into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Gmail node Message Operations + +Use the Message operations to send, reply to, delete, mark read or unread, add a label to, remove a label from, or get a message or get a list of messages in Gmail. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) for more information on the Gmail node itself. + +## Add Label to a message + +Use this operation to add one or more labels to a message. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Add Label**. +* **Message ID**: Enter the ID of the message you want to add the label to. +* **Label Names or IDs**: Select the Label names you want to add or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected. + + +Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information. + + +## Delete a message + +Use this operation to immediately and permanently delete a message. + +/// note | Permanent deletion +This operation can't be undone. For recoverable deletions, use the [Thread Trash operation](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md#trash-a-thread) instead. +/// + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Delete**. +* **Message ID**: Enter the ID of the message you want to delete. + +Refer to the [Gmail API Method: users.messages.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/delete){:target=_blank .external-link} documentation for more information. + +## Get a message + +Use this operation to get a single message. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Get**. +* **Message ID**: Enter the ID of the message you wish to retrieve. +* **Simplify**: Choose whether to return a simplified version of the response (turned on) or the raw data (turned off). Default is on. + * This is the same as setting the `format` for the API call to `metadata`, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject. + +Refer to the [Gmail API Method: users.messages.get](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/get){:target=_blank .external-link} documentation for more information. + + +## Get Many messages + + +Use this operation to get two or more messages. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Get Many**. +* **Return All**: Choose whether the node returns all messages (turned on) or only up to a set limit (turned off). +* **Limit**: Enter the maximum number of messages to return. Only used if you've turned off **Return All**. +* **Simplify**: Choose whether to return a simplified version of the response (turned on) or the raw data (turned off). Default is on. + * This is the same as setting the `format` for the API call to `metadata`, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject. + + +### Get Many messages filters + + +Use these filters to further refine the node's behavior: + +* **Include Spam and Trash**: Select whether the node should get messages in the Spam and Trash folders (turned on) or not (turned off). +* **Label Names or IDs**: Only return messages with the selected labels added to them. Select the Label names you want to apply or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected. +* **Search**: Enter Gmail search refine filters, like `from:`, to filter the messages returned. Refer to [Refine searches in Gmail](https://support.google.com/mail/answer/7190?hl=en){:target=_blank .external-link} for more information. +* **Read Status**: Choose whether to receive **Unread and read emails**, **Unread emails only** (default), or **Read emails only**. +* **Received After**: Return only those emails received after the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string. +* **Received Before**: Return only those emails received before the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string. +* **Sender**: Enter an email or a part of a sender name to return messages from only that sender. + +Refer to the [Gmail API Method: users.messages.list](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list){:target=_blank .external-link} documentation for more information. + +## Mark as Read + +Use this operation to mark a message as read. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Mark as Read**. +* **Message ID**: Enter the ID of the message you wish to mark as read. + + +Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information. + + +## Mark as Unread + +Use this operation to mark a message as unread. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Mark as Unread**. +* **Message ID**: Enter the ID of the message you wish to mark as unread. + + +Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information. + + +## Remove Label from a message + +Use this operation to remove one or more labels from a message. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Remove Label**. +* **Message ID**: Enter the ID of the message you want to remove the label from. +* **Label Names or IDs**: Select the Label names you want to remove or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected. + + +Refer to the [Gmail API Method: users.messages.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify){:target=_blank .external-link} documentation for more information. + + +## Reply to a message + +Use this operation to send a message as a reply to an existing message. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Reply**. +* **Message ID**: Enter the ID of the message you want to reply to. +* Select the **Email Type**. Choose from **Text** or **HTML**. +* **Message**: Enter the email message body. + +### Reply options + +Use these options to further refine the node's behavior: + +* **Append n8n attribution**: By default, the node appends the statement `This email was sent automatically with n8n` to the end of the email. To remove this statement, turn this option off. +* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment. + * For multiple properties, enter a comma-separated list. +* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **Sender Name**: Enter the name you want displayed in your recipients' email as the sender. +* **Reply to Sender Only**: Choose whether to reply all (turned off) or reply to the sender only (turned on). + +Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information. + +## Send a message + +Use this operation to send a message. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Send**. +* **To**: Enter the email address you want the email sent to. +* **Subject**: Enter the subject line. +* Select the **Email Type**. Choose from **Text** or **HTML**. +* **Message**: Enter the email message body. + +### Send options + +Use these options to further refine the node's behavior: + +* **Append n8n attribution**: By default, the node appends the statement `This email was sent automatically with n8n` to the end of the email. To remove this statement, turn this option off. +* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment. + * For multiple properties, enter a comma-separated list. +* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **Sender Name**: Enter the name you want displayed in your recipients' email as the sender. +* **Send Replies To**: Enter an email address to set as the reply to address. +* **Reply to Sender Only**: Choose whether to reply all (turned off) or reply to the sender only (turned on). + +Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information. + +## Send a message and wait for approval + +Use this operation to send a message and wait for approval from the recipient before continuing the workflow execution. + +/// info | Use Wait for complex approvals +The **Send and Wait for Approval** operation is well-suited for simple approval processes. For more complex approvals, consider using the [Wait node](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md). +/// + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Message**. +* **Operation**: Select **Send and Wait for Approval**. +* **To**: Enter the email address you want the email sent to. +* **Subject**: Enter the subject line. +* **Message**: Enter the email message body. + +### Send and wait for approval options + +Use these options to further refine the node's behavior: + +* **Type of Approval**: Choose **Approve Only** (default) to include only an approval button or **Approve and Disapprove** to also include a disapproval option. +* **Approve Button Label**: The label to use for the approval button (**Approve** by default). +* **Approve Button Style**: Whether to style the approval button as a **Primary** (default) or **Secondary** button. +* **Disapprove Button Label**: The label to use for the disapproval button (**Decline** by default). Only visible when you set **Type of Approval** to **Approve and Disapprove**. +* **Disapprove Button Style**: Whether to style the disapproval button as a **Primary** or **Secondary** (default) button. Only visible when you set **Type of Approval** to **Approve and Disapprove**. + +Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.gmail/thread-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gmail node Thread Operations documentation +description: Learn how to use the Thread Operations of the Gmail node in n8n. Follow technical documentation to integrate Thread Operations into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Gmail node Thread Operations + +Use the Thread operations to delete, reply to, trash, untrash, add/remove labels, get one, or list threads. Refer to the [Gmail node](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) for more information on the Gmail node itself. + +## Add Label to a thread + +Use this operation to create a new draft. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Add Label**. +* **Thread ID**: Enter the ID of the thread you want to add the label to. +* **Label Names or IDs**: Select the Label names you want to apply or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected. + + +Refer to the [Gmail API Method: users.threads.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/modify){:target=_blank .external-link} documentation for more information. + + +## Delete a thread + +Use this operation to immediately and permanently delete a thread and all its messages. + +/// note | Permanent deletion +This operation can't be undone. For recoverable deletions, use the [Trash operation](#trash-a-thread) instead. +/// + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Delete**. +* **Thread ID**: Enter the ID of the thread you want to delete. + +Refer to the [Gmail API Method: users.threads.delete](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/delete){:target=_blank .external-link} documentation for more information. + +## Get a thread + +Use this operation to get a single thread. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Get**. +* **Thread ID**: Enter the ID of the thread you wish to retrieve. +* **Simplify**: Choose whether to return a simplified version of the response (turned on) or the raw data (turned off). Default is on. + * This is the same as setting the `format` for the API call to `metadata`, which returns email message IDs, labels, and email headers, including: From, To, CC, BCC, and Subject. + +### Get thread options + +Use these options to further refine the node's behavior: + +* **Return Only Messages**: Choose whether to return only thread messages (turned on). + +Refer to the [Gmail API Method: users.threads.get](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/get){:target=_blank .external-link} documentation for more information. + + +## Get Many threads + + +Use this operation to get two or more threads. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Get Many**. +* **Return All**: Choose whether the node returns all threads (turned on) or only up to a set limit (turned off). +* **Limit**: Enter the maximum number of threads to return. Only used if you've turned off **Return All**. + + +### Get Many threads filters + + +Use these filters to further refine the node's behavior: + +* **Include Spam and Trash**: Select whether the node should get threads in the Spam and Trash folders (turned on) or not (turned off). +* **Label Names or IDs**: Only return threads with the selected labels added to them. Select the Label names you want to apply or enter an expression to specify IDs. The dropdown populates based on the **Credential** you selected. +* **Search**: Enter Gmail search refine filters, like `from:`, to filter the threads returned. Refer to [Refine searches in Gmail](https://support.google.com/mail/answer/7190?hl=en){:target=_blank .external-link} for more information. +* **Read Status**: Choose whether to receive **Unread and read emails**, **Unread emails only** (default), or **Read emails only**. +* **Received After**: Return only those emails received after the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string. +* **Received Before**: Return only those emails received before the specified date and time. Use the date picker to select the day and time or enter an expression to set a date as a string in ISO format or a timestamp in milliseconds. Refer to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601){:target=_blank .external-link} for more information on formatting the string. + +Refer to the [Gmail API Method: users.threads.list](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/list){:target=_blank .external-link} documentation for more information. + +## Remove label from a thread + +Use this operation to remove a label from a thread. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Remove Label**. +* **Thread ID**: Enter the ID of the thread you want to remove the label from. +* **Label Names or IDs**: Select the Label names you want to remove or enter an expression to specify their IDs. The dropdown populates based on the **Credential** you selected. + + +Refer to the [Gmail API Method: users.threads.modify](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/modify){:target=_blank .external-link} documentation for more information. + + +## Reply to a message + +Use this operation to reply to a message. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Reply**. +* **Thread ID**: Enter the ID of the thread you want to reply to. +* **Message Snippet or ID**: Select the Message you want to reply to or enter an expression to specify its ID. The dropdown populates based on the **Credential** you selected. +* Select the **Email Type**. Choose from **Text** or **HTML**. +* **Message**: Enter the email message body. + +### Reply options + +Use these options to further refine the node's behavior: + +* **Attachments**: Select **Add Attachment** to add an attachment. Enter the **Attachment Field Name (in Input)** to identify which field from the input node contains the attachment. + * For multiple properties, enter a comma-separated list. +* **BCC**: Enter one or more email addresses for blind copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **CC**: Enter one or more email addresses for carbon copy recipients. Separate multiple email addresses with a comma, for example `jay@gatsby.com, jon@smith.com`. +* **Sender Name**: Enter the name you want displayed in your recipients' email as the sender. +* **Reply to Sender Only**: Choose whether to reply all (turned off) or reply to the sender only (turned on). + +Refer to the [Gmail API Method: users.messages.send](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send){:target=_blank .external-link} documentation for more information. + +## Trash a thread + +Use this operation to move a thread and all its messages to the trash. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Trash**. +* **Thread ID**: Enter the ID of the thread you want to move to the trash. + +Refer to the [Gmail API Method: users.threads.trash](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/trash){:target=_blank .external-link} documentation for more information. + +## Untrash a thread + +Use this operation to recover a thread and all its messages from the trash. + +Enter these parameters: + +* Select the **Credential to connect with** or create a new one. +* **Resource**: Select **Thread**. +* **Operation**: Select **Untrash**. +* **Thread ID**: Enter the ID of the thread you want to move to the trash. + +Refer to the [Gmail API Method: users.threads.untrash](https://developers.google.com/gmail/api/reference/rest/v1/users.threads/untrash){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.gong.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gong node documentation +description: Learn how to use the Gong node in n8n. Follow technical documentation to integrate Gong node into your workflows. +contentType: [integration, reference] +--- + +# Gong node + +Use the Gong node to automate work in Gong and integrate Gong with other applications. n8n has built-in support for a wide range of Gong features, which includes getting one or more calls and users. + +On this page, you'll find a list of operations the Gong node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/gong.md). +/// + + +## Operations + + +* Call + * Get + * Get Many +* User + * Get + * Get Many + + +## Templates and examples + + +[[ templatesWidget(page.title, 'gong') ]] + +## Related resources + +Refer to [Gong's documentation](https://gong.app.gong.io/settings/api/documentation){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googleads.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Ads node documentation +description: Learn how to use the Google Ads node in n8n. Follow technical documentation to integrate Google Ads node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Google Ads node + +Use the Google Ads node to automate work in Google Ads, and integrate Google Ads with other applications. n8n has built-in support for a wide range of Google Ads features, including getting campaigns. + +On this page, you'll find a list of operations the Google Ads node supports and links to more resources. + +/// note | Credentials +Refer to [Google Ads credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* Campaign + * Get all campaigns + * Get a campaign + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-ads') ]] + +## Related resources + +Refer to [Google Ads' documentation](https://developers.google.com/google-ads/api/docs/start){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googleanalytics.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Analytics node documentation +description: Learn how to use the Google Analytics node in n8n. Follow technical documentation to integrate Google Analytics node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Google Analytics node + +Use the Google Analytics node to automate work in Google Analytics, and integrate Google Analytics with other applications. n8n has built-in support for a wide range of Google Analytics features, including returning reports and user activities. + + +On this page, you'll find a list of operations the Google Analytics node supports and links to more resources. + +/// note | Credentials +Refer to [Google Analytics credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Report + * Get +* User Activity + * Search + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-analytics') ]] + +## Related resources + +Refer to [Google Analytics' documentation](https://developers.google.com/analytics){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlebigquery.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google BigQuery node documentation +description: Learn how to use the Google BigQuery node in n8n. Follow technical documentation to integrate Google BigQuery node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Google BigQuery node + +Use the Google BigQuery node to automate work in Google BigQuery, and integrate Google BigQuery with other applications. n8n has built-in support for a wide range of Google BigQuery features, including creating, and retrieving records. + +On this page, you'll find a list of operations the Google BigQuery node supports and links to more resources. + +/// note | Credentials +Refer to [Google BigQuery credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +- Execute Query +- Insert + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-bigquery') ]] + +## Related resources + +Refer to [Google BigQuery's documentation](https://cloud.google.com/bigquery/docs/reference/rest){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlebooks.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Books node documentation +description: Learn how to use the Google Books node in n8n. Follow technical documentation to integrate Google Books node into your workflows. +contentType: [integration, reference] +--- + +# Google Books node + +Use the Google Books node to automate work in Google Books, and integrate Google Books with other applications. n8n has built-in support for a wide range of Google Books features, including retrieving a specific bookshelf resource for the specified user, adding volume to a bookshelf, and getting volume. + +On this page, you'll find a list of operations the Google Books node supports and links to more resources. + +/// note | Credentials +Refer to [Google credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* Bookshelf + * Retrieve a specific bookshelf resource for the specified user + * Get all public bookshelf resource for the specified user +* Bookshelf Volume + * Add a volume to a bookshelf + * Clears all volumes from a bookshelf + * Get all volumes in a specific bookshelf for the specified user + * Moves a volume within a bookshelf + * Removes a volume from a bookshelf +* Volume + * Get a volume resource based on ID + * Get all volumes filtered by query + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-books') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlebusinessprofile.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Business Profile node documentation +description: Learn how to use the Google Business Profile node in n8n. Follow technical documentation to integrate Google Business Profile node into your workflows. +contentType: [integration, reference] +--- + +# Google Business Profile node + +Use the Google Business Profile node to automate work in Google Business Profile and integrate Google Business Profile with other applications. n8n has built-in support for a wide range of Google Business Profile features, which includes creating, updating, and deleting posts and reviews. + +On this page, you'll find a list of operations the Google Business Profile node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/google/index.md). +/// + + +## Operations + +* Post + * Create + * Delete + * Get + * Get Many + * Update +* Review + * Delete Reply + * Get + * Get Many + * Reply + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-business-profile') ]] + +## Related resources + +n8n provides a trigger node for Google Business Profile. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.googlebusinessprofiletrigger.md). + +Refer to [Google Business Profile's documentation](https://developers.google.com/my-business/reference/rest){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/calendar-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Calendar Calendar operations +description: Documentation for the Calendar operations in Google Calendar node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: high +--- + + + +# Google Calendar Calendar operations + + + +Use this operation to check availability in a calendar in Google Calendar. Refer to [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md) for more information on the Google Calendar node itself. + +## Availability + +Use this operation to check if a time-slot is available in a calendar. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Calendar credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Calendar**. +- **Operation**: Select **Availability**. +- **Calendar**: Choose a calendar you want to check against. Select **From list** to choose the title from the dropdown list or **By ID** to enter a calendar ID. +- **Start Time**: The start time for the time-slot you want to check. By default, uses an expression evaluating to the current time (`{{ $now }}`). +- **End Time**: The end time for the time-slot you want to check. By default, uses an expression evaluating to an hour from now (`{{ $now.plus(1, 'hour') }}`). + +### Options + +- **Output Format**: Select the format for the availability information: + - **Availability**: Returns if there are already events overlapping with the given time slot or not. + - **Booked Slots**: Returns the booked slots. + - **RAW**: Returns the RAW data from the API. +- **Timezone**: The timezone used in the response. By default, uses the n8n timezone. + +Refer to the [Freebusy: query | Google Calendar](https://developers.google.com/calendar/api/v3/reference/freebusy/query){:target=_blank .external-link} API documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Calendar Event operations +description: Documentation for the Event operations in Google Calendar node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: high +--- + +# Google Calendar Event operations + +Use these operations to create, delete, get, and update events in Google Calendar. Refer to [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md) for more information on the Google Calendar node itself. + +## Create + +Use this operation to add an event to a Google Calendar. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Calendar credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Event**. +- **Operation**: Select **Create**. +- **Calendar**: Choose a calendar you want to add an event to. Select **From list** to choose the title from the dropdown list or **By ID** to enter a calendar ID. +- **Start Time**: The start time for the event. By default, uses an expression evaluating to the current time (`{{ $now }}`). +- **End Time**: The end time for the event. By default, this uses an expression evaluating to an hour from now (`{{ $now.plus(1, 'hour') }}`). +- **Use Default Reminders**: Whether to enable default reminders for the event according to the calendar configuration. + +### Options + +- **All Day**: Whether the event is all day or not. +- **Attendees**: Attendees to invite to the event. +- **Color Name or ID**: The color of the event. Choose from the list or specify the ID using an expression. +- **Conference Data**: Creates a conference link (Hangouts, Meet, etc.) and attaches it to the event. +- **Description**: A description for the event. +- **Guests Can Invite Others**: Whether attendees other than the organizer can invite others to the event. + +- **Guests Can Modify**: Whether attendees other than the organizer can modify the event. + +- **Guests Can See Other Guests**: Whether attendees other than the organizer can see who the event's attendees are. +- **ID**: Opaque identifier of the event. +- **Location**: Geographic location of the event as free-form text. +- **Max Attendees**: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only returns the participant. +- **Repeat Frequency**: The repetition interval for recurring events. +- **Repeat How Many Times?**: The number of instances to create for recurring events. +- **Repeat Until**: The date at which recurring events should stop. + +- **RRULE**: Recurrence rule. When set, ignores the Repeat Frequency, Repeat How Many Times, and Repeat Until parameters. + +- **Send Updates**: Whether to send notifications about the creation of the new event. +- **Show Me As**: Whether the event blocks time on the calendar. +- **Summary**: The title of the event. + +Refer to the [Events: insert | Google Calendar](https://developers.google.com/calendar/api/v3/reference/events/insert){:target=_blank .external-link} API documentation for more information. + +## Delete + +Use this operation to delete an event from a Google Calendar. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Calendar credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Event**. +- **Operation**: Select **Delete**. +- **Calendar**: Choose a calendar you want to delete an event from. Select **From list** to choose the title from the dropdown list or **By ID** to enter a calendar ID. +- **Event ID**: The ID of the event to delete. + +### Options + +- **Send Updates**: Whether to send notifications about the deletion of the event. + +Refer to the [Events: delete | Google Calendar](https://developers.google.com/calendar/api/v3/reference/events/delete){:target=_blank .external-link} API documentation for more information. + +## Get + +Use this operation to retrieve an event from a Google Calendar. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Calendar credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Event**. +- **Operation**: Select **Get**. +- **Calendar**: Choose a calendar you want to get an event from. Select **From list** to choose the title from the dropdown list or **By ID** to enter a calendar ID. +- **Event ID**: The ID of the event to get. + +### Options + +- **Max Attendees**: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only returns the participant. +- **Return Next Instance of Recurrent Event**: Whether to return the next instance of a recurring event instead of the event itself. +- **Timezone**: The timezone used in the response. By default, uses the n8n timezone. + +Refer to the [Events: get | Google Calendar](https://developers.google.com/calendar/api/v3/reference/events/get){:target=_blank .external-link} API documentation for more information. + + +## Get Many + + +Use this operation to retrieve more than one event from a Google Calendar. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Calendar credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Event**. +- **Operation**: Select **Get Many**. +- **Calendar**: Choose a calendar you want to get an event from. Select **From list** to choose the title from the dropdown list or **By ID** to enter a calendar ID. +- **Return All**: Whether to return all results or only up to a given limit. +- **Limit**: (When "Return All" isn't selected) The maximum number of results to return. +- **After**: Retrieve events that occur after this time. At least part of the event must be after this time. By default, this uses an expression evaluating to the current time (`{{ $now }}`). Switch the field to "fixed" to select a date from a date widget. +- **Before**: Retrieve events that occur before this time. At least part of the event must be before this time. By default, this uses an expression evaluating to the current time plus a week (`{{ $now.plus({ week: 1 }) }}`). Switch the field to "fixed" to select a date from a date widget. + +### Options + +- **Fields**: Specify the fields to return. By default, returns a set of commonly used fields predefined by Google. Use "*" to return all fields. You can find out more in [Google Calendar's documentation on working with partial resources](https://developers.google.com/calendar/api/guides/performance#partial). + +- **iCalUID**: Specifies an event ID (in the iCalendar format) to include in the response. + +- **Max Attendees**: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only returns the participant. +- **Order By**: The order to use for the events in the response. +- **Query**: Free text search terms to find events that match. This searches all fields except for extended properties. +- **Recurring Event Handling**: What to do for recurring events: + - **All Occurrences**: Return all instances of the recurring event for the specified time range. + - **First Occurrence**: Return the first event of a recurring event within the specified time range. + - **Next Occurrence**: Return the next instance of a recurring event within the specified time range. +- **Show Deleted**: Whether to include deleted events (with status equal to "cancelled") in the results. +- **Show Hidden Invitations**: Whether to include hidden invitations in the results. +- **Timezone**: The timezone used in the response. By default, uses the n8n timezone. +- **Updated Min**: The lower bounds for an event's last modification time (as an [RFC 3339 timestamp](https://datatracker.ietf.org/doc/html/rfc3339)) + +Refer to the [Events: list | Google Calendar](https://developers.google.com/calendar/api/v3/reference/events/list){:target=_blank .external-link} API documentation for more information. + +## Update + +Use this operation to update an event in a Google Calendar. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Calendar credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Event**. +- **Operation**: Select **Update**. +- **Calendar**: Choose a calendar you want to add an event to. Select **From list** to choose the title from the dropdown list or **By ID** to enter a calendar ID. +- **Event ID**: The ID of the event to update. + +- **Modify**: For recurring events, choose whether to update the recurring event or a specific instance of the recurring event. + +- **Use Default Reminders**: Whether to enable default reminders for the event according to the calendar configuration. +- **Update Fields**: The fields of the event to update: + - **All Day**: Whether the event is all day or not. + - **Attendees**: Attendees to invite to the event. You can choose to either add attendees or replace the existing attendee list. + - **Color Name or ID**: The color of the event. Choose from the list or specify the ID using an expression. + - **Description**: A description for the event. + - **End**: The end time of the event. + - **Guests Can Invite Others**: Whether attendees other than the organizer can invite others to the event. + + - **Guests Can Modify**: Whether attendees other than the organizer can make changes to the event. + + - **Guests Can See Other Guests**: Whether attendees other than the organizer can see who the event's attendees are. + - **ID**: Opaque identifier of the event. + - **Location**: Geographic location of the event as free-form text. + - **Max Attendees**: The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only returns the participant. + - **Repeat Frequency**: The repetition interval for recurring events. + - **Repeat How Many Times?**: The number of instances to create for recurring events. + - **Repeat Until**: The date at which recurring events should stop. + + - **RRULE**: Recurrence rule. When set, ignores the Repeat Frequency, Repeat How Many Times, and Repeat Until parameters. + + - **Send Updates**: Whether to send notifications about the creation of the new event. + - **Show Me As**: Whether the event blocks time on the calendar. + - **Start**: The start time of the event. + - **Summary**: The title of the event. + - **Visibility**: The visibility of the event: + + - **Confidential**: The event is private. This value is provided for compatibility. + + - **Default**: Uses the default visibility for events on the calendar. + - **Public**: The event is public and the event details are visible to all readers of the calendar. + - **Private**: The event is private and only event attendees may view event details. + +Refer to the [Events: update | Google Calendar](https://developers.google.com/calendar/api/v3/reference/events/update){:target=_blank .external-link} API documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Calendar node documentation +description: Learn how to use the Google Calendar node in n8n. Follow technical documentation to integrate Google Calendar node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Google Calendar node + +Use the Google Calendar node to automate work in Google Calendar, and integrate Google Calendar with other applications. n8n has built-in support for a wide range of Google Calendar features, including adding, retrieving, deleting and updating calendar events. + +On this page, you'll find a list of operations the Google Calendar node supports and links to more resources. + +/// note | Credentials +Refer to [Google Calendar credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* **Calendar** + * [**Availability**](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/calendar-operations.md#availability): If a time-slot is available in a calendar +* **Event** + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md#create): Add an event to calendar + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md#delete): Delete an event + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md#get): Retrieve an event + * [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md#get-many): Retrieve all events from a calendar + * [**Update**](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/event-operations.md#update): Update an event + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-calendar') ]] + +## Related resources + +n8n provides a trigger node for Google Calendar. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.googlecalendartrigger.md). + +Refer to [Google Calendar's documentation](https://developers.google.com/calendar/api/v3/reference){:target=_blank .external-link} for more information about the service. + +View [example workflows and related content](https://n8n.io/integrations/google-calendar/){:target=_blank .external-link} on n8n's website. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlechat.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Chat node documentation +description: Learn how to use the Google Chat node in n8n. Follow technical documentation to integrate Google Chat node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Google Chat node + +Use the Google Chat node to automate work in Google Chat, and integrate Google Chat with other applications. n8n has built-in support for a wide range of Google Chat features, including getting membership and spaces, as well as creating and deleting messages. + +On this page, you'll find a list of operations the Google Chat node supports and links to more resources. + +/// note | Credentials +Refer to [Google credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Member + * Get a membership + * Get all memberships in a space +* Message + * Create a message + * Delete a message + * Get a message + * Send and Wait for Response + * Update a message +* Space + * Get a space + * Get all spaces the caller is a member of + +--8<-- "_snippets/integrations/builtin/send-and-wait-operation.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-chat') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecloudfirestore.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Cloud Firestore node documentation +description: Learn how to use the Google Cloud Firestore node in n8n. Follow technical documentation to integrate Google Cloud Firestore node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Google Cloud Firestore node + +Use the Google Cloud Firestore node to automate work in Google Cloud Firestore, and integrate Google Cloud Firestore with other applications. n8n has built-in support for a wide range of Google Cloud Firestore features, including creating, deleting, and getting documents. + +On this page, you'll find a list of operations the Google Cloud Firestore node supports and links to more resources. + +/// note | Credentials +Refer to [Google credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Document + * Create a document + * Create/Update a document + * Delete a document + * Get a document + * Get all documents from a collection + * Runs a query against your documents +* Collection + * Get all root collections + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-cloud-firestore') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecloudnaturallanguage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Cloud Natural Language node documentation +description: Learn how to use the Google Cloud Natural Language node in n8n. Follow technical documentation to integrate Google Cloud Natural Language node into your workflows. +contentType: [integration, reference] +--- + +# Google Cloud Natural Language node + +Use the Google Cloud Natural Language node to automate work in Google Cloud Natural Language, and integrate Google Cloud Natural Language with other applications. n8n has built-in support for a wide range of Google Cloud Natural Language features, including analyzing documents. + +On this page, you'll find a list of operations the Google Cloud Natural Language node supports and links to more resources. + +/// note | Credentials +Refer to [Google Cloud Natural Language credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* Document + * Analyze Sentiment + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-cloud-natural-language') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecloudrealtimedatabase.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Cloud Realtime Database node documentation +description: Learn how to use the Google Cloud Realtime Database node in n8n. Follow technical documentation to integrate Google Cloud Realtime Database node into your workflows. +contentType: [integration, reference] +--- + +# Google Cloud Realtime Database node + +Use the Google Cloud Realtime Database node to automate work in Google Cloud Realtime Database, and integrate Google Cloud Realtime Database with other applications. n8n has built-in support for a wide range of Google Cloud Realtime Database features, including writing, deleting, getting, and appending databases. + +On this page, you'll find a list of operations the Google Cloud Realtime Database node supports and links to more resources. + +/// note | Credentials +Refer to [Google Cloud Realtime Database credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Write data to a database +* Delete data from a database +* Get a record from a database +* Append to a list of data +* Update item on a database + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-cloud-realtime-database') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecloudstorage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Cloud Storage node documentation +description: Learn how to use the Google Cloud Storage node in n8n. Follow technical documentation to integrate Google Cloud Storage node into your workflows. +contentType: [integration, reference] +--- + +# Google Cloud Storage node + +Use the Google Cloud Storage node to automate work in Google Cloud Storage, and integrate Google Cloud Storage with other applications. n8n has built-in support for a wide range of Google Cloud Storage features, including creating, updating, deleting, and getting buckets and objects. + +On this page, you'll find a list of operations the Google Cloud Storage node supports and links to more resources. + +/// note | Credentials +Refer to [Google Cloud Storage credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* Bucket + * Create + * Delete + * Get + * Get Many + * Update +* Object + * Create + * Delete + * Get + * Get Many + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-cloud-storage') ]] + +## Related resources + +Refer to Google's [Cloud Storage API documentation](https://cloud.google.com/storage/docs/apis){:target=_blank .external-link} for detailed information about the API that this node integrates with. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlecontacts.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Contacts node documentation +description: Learn how to use the Google Contacts node in n8n. Follow technical documentation to integrate Google Contacts node into your workflows. +contentType: [integration, reference] +--- + +# Google Contacts node + +Use the Google Contacts node to automate work in Google Contacts, and integrate Google Contacts with other applications. n8n has built-in support for a wide range of Google Contacts features, including creating, updating, retrieving, deleting, and getting contacts. + +On this page, you'll find a list of operations the Google Contacts node supports and links to more resources. + +/// note | Credentials +Refer to [Google Contacts credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Contact + * Create a contact + * Delete a contact + * Get a contact + * Retrieve all contacts + * Update a contact + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-contacts') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledocs.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Docs node documentation +description: Learn how to use the Google Docs node in n8n. Follow technical documentation to integrate Google Docs node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Google Docs node + +Use the Google Docs node to automate work in Google Docs, and integrate Google Docs with other applications. n8n has built-in support for a wide range of Google Docs features, including creating, updating, and getting documents. + +On this page, you'll find a list of operations the Google Docs node supports and links to more resources. + +/// note | Credentials +Refer to [Google Docs credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Document + * Create + * Get + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-docs') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Drive node common issues +description: Documentation for common questions and solutions in the Google Drive node in n8n, a workflow automation platform. Includes details of the issue and suggested resolutions. +contentType: [integration, reference] +priority: high +--- + +# Google Drive node common issues + +Here are some common errors and issues with the [Google Drive node](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md) and steps to resolve or troubleshoot them. + +## Google hasn't verified this app + +--8<-- "_snippets/integrations/builtin/credentials/google/unverified-app.md" + +## Google Cloud app becoming unauthorized + +--8<-- "_snippets/integrations/builtin/credentials/google/app-becoming-unauthorized.md" + +## Google Drive OAuth error + +If using the OAuth authentication method, you may see an error indicating that you can't sign in because the app doesn't meet Google's expectations for keeping apps secure. + +Most often, the actual cause of this issue is that the URLs don't match between Google's OAuth configuration and n8n. To avoid this, start by reviewing any links included in Google's error message. This will contain details about the exact error that occurred. + +If you are self-hostin n8n, check the n8n configuration items used to construct external URLs. Verify that the [`N8N_EDITOR_BASE_URL`](/hosting/configuration/environment-variables/deployment.md) and [`WEBHOOK_URL`](/hosting/configuration/configuration-examples/webhook-url.md) environment variables use fully qualified domains. + +## Get recent files from Google Drive + +To retrieve recent files from Google Drive, you need to sort files by modification time. To do this, you need to search for existing files and retrieve their modification times. Next you can sort the files to find the most recent file and use another Google Drive node target the file by ID. + +The process looks like this: + +1. Add a **Google Drive** node to your canvas. +2. Select the **File/Folder** resource and the **Search** operation. +3. Enable **Return All** to sort through all files. +4. Set the **What to Search** filter to **Files**. +5. In the **Options**, set the **Fields** to **All**. +6. Connect a **Sort** node to the output of the **Google Drive** node. +7. Choose **Simple** sort type. +8. Enter `modifiedTime` as the **Field Name** in the **Fields To Sort By** section. +9. Choose **Descending** sort order. +10. Add a **Limit** node to the output of the **Sort** node. +11. Set **Max Items** to **1** to keep the most recent file. +12. Connect another **Google Drive** node to the output of the **Limit** node. +13. Select **File** as the **Resource** and the operation of your choice. +14. In the **File** selection, choose **By ID**. +15. Select **Expression** and enter `{{ $json.id }}` as the expression. + +[[ workflowDemo("file:///integrations/builtin/app-nodes/n8n-nodes-base.googledrive/get-most-recent-file.json") ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-folder-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Drive File and Folder operations +description: Documentation for the File and Folder operations in Google Drive node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: high +--- + +# Google Drive File and Folder operations + +Use this operation to search for files and folders in Google Drive. Refer to [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md) for more information on the Google Drive node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Search files and folders + +Use this operation to search for files and folders in a drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File/Folder**. +- **Operation**: Select **Search**. +- **Search Method**: Choose how you want to search: + - **Search File/Folder Name**: Fill out the **Search Query** with the name of the file or folder you want to search for. Returns files and folders that are partial matches for the query as well. + - **Advanced Search**: Fill out the **Query String** to search for files and folders using [Google query string syntax](https://developers.google.com/drive/api/guides/search-files). +- **Return All**: Choose whether to return all results or only up to a given limit. +- **Limit**: The maximum number of items to return when **Return All** is disabled. +- **Filter**: Choose whether to limit the scope of your search: + - **Drive**: The drive you want to search in. By default, uses your personal "My Drive". Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. + - You can find the `driveId` by visiting the shared drive in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/driveId`. + - **Folder**: The folder to search in. Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + - You can find the `folderId` by visiting the shared folder in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/folderId`. + - **What to Search**: Whether to search for **Files and Folders**, **Files**, or **Folders**. + - **Include Trashed Items**: Whether to also return items in the Drive's trash. + + +### Options + +- **Fields**: Select the fields to return. Can be one or more of the following: **[All]**, **explicitlyTrashed**, **exportLinks**, **hasThumbnail**, **iconLink**, **ID**, **Kind**, **mimeType**, **Name**, **Permissions**, **Shared**, **Spaces**, **Starred**, **thumbnailLink**, **Trashed**, **Version**, or **webViewLink**. + +Refer to the [Method: files.list | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/list){:target=_blank .external-link} API documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Drive File operations +description: Documentation for the File operations in Google Drive node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: high +--- + +# Google Drive File operations + +Use this operation to create, delete, change, and manage files in Google Drive. Refer to [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md) for more information on the Google Drive node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Copy a file + +Use this operation to copy a file to a drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Copy**. +- **File**: Choose a file you want to copy. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the file, or **By ID** to enter the `fileId`. + - You can find the `fileId` in a shareable Google Drive file URL: `https://docs.google.com/document/d/fileId/edit#gid=0`. In your Google Drive, select **Share > Copy link** to get the shareable file URL. +- **File Name**: The name to use for the new copy of the file. +- **Copy In The Same Folder**: Choose whether to copy the file to the same folder. If disabled, set the following: + - **Parent Drive**: Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. + - **Parent Folder**: Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + - You can find the `driveId` and `folderID` by visiting the shared drive or folder in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/driveId`. + +### Options + +- **Copy Requires Writer Permissions**: Select whether to enable readers and commenters to copy, print, or download the new file. +- **Description**: A short description of the file. + +Refer to the [Method: files.copy | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/copy){:target=_blank .external-link} API documentation for more information. + +## Create from text + +Use this operation to create a new file in a drive from provided text. + +Enter these parameters: +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Create From Text**. +- **File Content**: Enter the file content to use to create the new file. +- **File Name**: The name to use for the new file. +- **Parent Drive**: Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. +- **Parent Folder**: Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + +You can find the `driveId` and `folderID` by visiting the shared drive or folder in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/driveId`. + +### Options + +- **APP Properties**: A bundle of arbitrary key-value pairs which are private to the requesting app. +- **Properties**: A bundle of arbitrary key-value pairs which are visible to all apps. +- **Keep Revision Forever**: Choose whether to set the `keepForever` field in the new head revision. This only applies to files with binary content. You can keep a maximum of 200 revisions, after which you must delete the pinned revisions. + + +- **OCR Language**: An [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code to help the OCR interpret the content during import. + + +- **Use Content As Indexable Text**: Choose whether to mark the uploaded content as indexable text. +- **Convert to Google Document**: Choose whether to create a Google Document instead of the default `.txt` format. You must enable the Google Docs API in the [Google API Console](https://console.cloud.google.com/apis/library/docs.googleapis.com) for this to work. + +Refer to the [Method: files.insert | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/insert){:target=_blank .external-link} API documentation for more information. + +## Delete a file + +Use this operation to delete a file from a drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Delete**. +- **File**: Choose a file you want to delete. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the file, or **By ID** to enter the `fileId`. + - You can find the `fileId` in a shareable Google Drive file URL: `https://docs.google.com/document/d/fileId/edit#gid=0`. In your Google Drive, select **Share > Copy link** to get the shareable file URL. + +### Options + +- **Delete Permanently**: Choose whether to delete the file now instead of moving it to the trash. + +Refer to the [Method: files.delete | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/delete){:target=_blank .external-link} API documentation for more information. + +## Download a file + +Use this operation to download a file from a drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Download**. +- **File**: Choose a file you want to download. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the file, or **By ID** to enter the `fileId`. + - You can find the `fileId` in a shareable Google Drive file URL: `https://docs.google.com/document/d/fileId/edit#gid=0`. In your Google Drive, select **Share > Copy link** to get the shareable file URL. + +### Options + +- **Put Output File in Field**: Choose the field name to place the binary file contents to make it available to following nodes. +- **Google File Conversion**: Choose the formats to export as when downloading Google Files: + * **Google Docs**: Choose the export format to use when downloading Google Docs files: **HTML**, **MS Word Document**, **Open Office Document**, **PDF**, **Rich Text (rtf)**, or **Text (txt)**. + * **Google Drawings**: Choose the export format to use when downloading Google Drawing files: **JPEG**, **PDF**, **PNG**, or **SVG**. + * **Google Slides**: Choose the export format to use when downloading Google Slides files: **MS PowerPoint**, **OpenOffice Presentation**, or **PDF**. + * **Google Sheets**: Choose the export format to use when downloading Google Sheets files: **CSV**, **MS Excel**, **Open Office Sheet**, or **PDF**. +- **File Name**: The name to use for the downloaded file. + +Refer to the [Method: files.get | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/get){:target=_blank .external-link} API documentation for more information. + +## Move a file + +Use this operation to move a file to a different location in a drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Move**. +- **File**: Choose a file you want to move. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the file, or **By ID** to enter the `fileId`. + - You can find the `fileId` in a shareable Google Drive file URL: `https://docs.google.com/document/d/fileId/edit#gid=0`. In your Google Drive, select **Share > Copy link** to get the shareable file URL. +- **Parent Drive**: Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. +- **Parent Folder**: Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + +You can find the `driveId` and `folderID` by visiting the shared drive or folder in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/driveId`. + +Refer to the [Method: parents.insert | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/parents/insert){:target=_blank .external-link} API documentation for more information. + +## Share a file + +Use this operation to add sharing permissions to a file. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Share**. +- **File**: Choose a file you want to share. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the file, or **By ID** to enter the `fileId`. + - You can find the `fileId` in a shareable Google Drive file URL: `https://docs.google.com/document/d/fileId/edit#gid=0`. In your Google Drive, select **Share > Copy link** to get the shareable file URL. +- **Permissions**: The permissions to add to the file: + - **Role**: Select what users can do with the file. Can be one of **Commenter**, **File Organizer**, **Organizer**, **Owner**, **Reader**, **Writer**. + - **Type**: Select the scope of the new permission: + - **User**: Grant permission to a specific user, defined by entering their **Email Address**. + - **Group**: Grant permission to a specific group, defined by entering its **Email Address**. + - **Domain**: Grant permission to a complete domain, defined by the **Domain**. + - **Anyone**: Grant permission to anyone. Can optionally **Allow File Discovery** to make the file discoverable through search. + +### Options + +- **Email Message**: A plain text custom message to include in the notification email. + +- **Move to New Owners Root**: Available when trying to transfer ownership while sharing an item not in a shared drive. When enabled, moves the file to the new owner's My Drive root folder. + +- **Send Notification Email**: Whether to send a notification email when sharing to users or groups. +- **Transfer Ownership**: Whether to transfer ownership to the specified user and downgrade the current owner to writer permissions. +- **Use Domain Admin Access**: Whether to perform the action as a domain administrator. + +Refer to the [REST Resources: files | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files){:target=_blank .external-link} API documentation for more information. + +## Update a file + +Use this operation to update a file. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Update**. +- **File to Update**: Choose a file you want to update. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the file, or **By ID** to enter the `fileId`. + - You can find the `fileId` in a shareable Google Drive file URL: `https://docs.google.com/document/d/fileId/edit#gid=0`. In your Google Drive, select **Share > Copy link** to get the shareable file URL. +- **Change File Content**: Choose whether to send new binary data to replace the existing file content. If enabled, fill in the following: + - **Input Data Field Name**: The name of the input field that contains the binary file data you wish to use. +- **New Updated File Name**: A new name for the file if you want to update the filename. + +### Options + +- **APP Properties**: A bundle of arbitrary key-value pairs which are private to the requesting app. +- **Properties**: A bundle of arbitrary key-value pairs which are visible to all apps. +- **Keep Revision Forever**: Choose whether to set the `keepForever` field in the new head revision. This only applies to files with binary content. You can keep a maximum of 200 revisions, after which you must delete the pinned revisions. + + +- **OCR Language**: An [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code to help the OCR interpret the content during import. + + +- **Use Content As Indexable Text**: Choose whether to mark the uploaded content as indexable text. +- **Move to Trash**: Whether to move the file to the trash. Only possible for the file owner. +- **Return Fields**: Return metadata fields about the file. Can be one or more of the following: **[All]**, **explicitlyTrashed**, **exportLinks**, **hasThumbnail**, **iconLink**, **ID**, **Kind**, **mimeType**, **Name**, **Permissions**, **Shared**, **Spaces**, **Starred**, **thumbnailLink**, **Trashed**, **Version**, or **webViewLink**. + +Refer to the [Method: files.update | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/update){:target=_blank .external-link} API documentation for more information. + +## Upload a file + +Use this operation to upload a file. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **File**. +- **Operation**: Select **Upload**. +- **Input Data Field Name**: The name of the input field that contains the binary file data you wish to use. +- **File Name**: The name to use for the new file. +- **Parent Drive**: Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. +- **Parent Folder**: Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + +You can find the `driveId` and `folderID` by visiting the shared drive or folder in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/driveId`. + +### Options + +- **APP Properties**: A bundle of arbitrary key-value pairs which are private to the requesting app. +- **Properties**: A bundle of arbitrary key-value pairs which are visible to all apps. +- **Keep Revision Forever**: Choose whether to set the `keepForever` field in the new head revision. This only applies to files with binary content. You can keep a maximum of 200 revisions, after which you must delete the pinned revisions. + + +- **OCR Language**: An [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code to help the OCR interpret the content during import. + + +- **Use Content As Indexable Text**: Choose whether to mark the uploaded content as indexable text. +- **Simplify Output**: Choose whether to return a simplified version of the response instead of including all fields. + +Refer to the [Method: files.insert | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/insert){:target=_blank .external-link} API documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledrive/folder-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Drive Folder operations +description: Documentation for the Folder operations in Google Drive node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: high +--- + +# Google Drive Folder operations + +Use this operation to create, delete, and share folders in Google Drive. Refer to [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md) for more information on the Google Drive node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Create a folder + +Use this operation to create a new folder in a drive. + +Enter these parameters: +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Folder**. +- **Operation**: Select **Create**. +- **Folder Name**: The name to use for the new folder. +- **Parent Drive**: Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. +- **Parent Folder**: Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + +You can find the `driveId` and `folderID` by visiting the shared drive or folder in your browser and copying the last URL component: `https://drive.google.com/drive/u/1/folders/driveId`. + +### Options + +- **Simplify Output**: Choose whether to return a simplified version of the response instead of including all fields. +- **Folder Color**: The color of the folder as an RGB hex string. + +Refer to the [Method: files.insert | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/insert){:target=_blank .external-link} API documentation for more information. + +## Delete a folder + +Use this operation to delete a folder from a drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Folder**. +- **Operation**: Select **Delete**. +- **Folder**: Choose a folder you want to delete. + - Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + - You can find the `folderId` in a Google Drive folder URL: `https://drive.google.com/drive/u/0/folders/folderID`. + +### Options + +- **Delete Permanently**: Choose whether to delete the folder now instead of moving it to the trash. + +Refer to the [Method: files.delete | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/delete){:target=_blank .external-link} API documentation for more information. + +## Share a folder + +Use this operation to add sharing permissions to a folder. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Folder**. +- **Operation**: Select **Share**. +- **Folder**: Choose a file you want to move. + - Select **From list** to choose the folder from the dropdown list, **By URL** to enter the URL of the folder, or **By ID** to enter the `folderId`. + - You can find the `folderId` in a Google Drive folder URL: `https://drive.google.com/drive/u/0/folders/folderID`. +- **Permissions**: The permissions to add to the folder: + - **Role**: Select what users can do with the folder. Can be one of **Commenter**, **File Organizer**, **Organizer**, **Owner**, **Reader**, **Writer**. + - **Type**: Select the scope of the new permission: + - **User**: Grant permission to a specific user, defined by entering their **Email Address**. + - **Group**: Grant permission to a specific group, defined by entering its **Email Address**. + - **Domain**: Grant permission to a complete domain, defined by the **Domain**. + - **Anyone**: Grant permission to anyone. Can optionally **Allow File Discovery** to make the file discoverable through search. + +### Options + +- **Email Message**: A plain text custom message to include in the notification email. + +- **Move to New Owners Root**: Available when trying to transfer ownership while sharing an item not in a shared drive. When enabled, moves the folder to the new owner's My Drive root folder. + +- **Send Notification Email**: Whether to send a notification email when sharing to users or groups. +- **Transfer Ownership**: Whether to transfer ownership to the specified user and downgrade the current owner to writer permissions. +- **Use Domain Admin Access**: Whether to perform the action as a domain administrator. + +Refer to the [REST Resources: files | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files){:target=_blank .external-link} API documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Drive node documentation +description: Learn how to use the Google Drive node in n8n. Follow technical documentation to integrate Google Drive node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Google Drive node + +Use the Google Drive node to automate work in Google Drive, and integrate Google Drive with other applications. n8n has built-in support for a wide range of Google Drive features, including creating, updating, listing, deleting, and getting drives, files, and folders. + +On this page, you'll find a list of operations the Google Drive node supports and links to more resources. + +/// note | Credentials +Refer to [Google Drive credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* **File** + * [**Copy**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#copy-a-file) a file + * [**Create from text**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#create-from-text) + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#delete-a-file) a file + * [**Download**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#download-a-file) a file + * [**Move**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#move-a-file) a file + * [**Share**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#share-a-file) a file + * [**Update**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#update-a-file) a file + * [**Upload**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-operations.md#upload-a-file) a file +* **File/Folder** + * [**Search**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/file-folder-operations.md#search-files-and-folders) files and folders +* **Folder** + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/folder-operations.md#create-a-folder) a folder + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/folder-operations.md#delete-a-folder) a folder + * [**Share**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/folder-operations.md#share-a-folder) a folder +* **Shared Drive** + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md#create-a-shared-drive) a shared drive + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md#delete-a-shared-drive) a shared drive + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md#get-a-shared-drive) a shared drive + * [**Get Many**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md#get-many-shared-drives) shared drives + * [**Update**](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md#update-a-shared-drive) a shared drive + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-drive') ]] + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/common-issues.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googledrive/shared-drive-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Drive Shared Drive operations +description: Documentation for the Shared Drive operations in Google Drive node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: high +--- + +# Google Drive Shared Drive operations + +Use this operation to create, delete, get, and update shared drives in Google Drive. Refer to [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md) for more information on the Google Drive node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Create a shared drive + +Use this operation to create a new shared drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Shared Drive**. +- **Operation**: Select **Create**. +- **Name**: The name to use for the new shared drive. + +### Options + +- **Capabilities**: The capabilities to set for the new shared drive (see [REST Resources: drives | Google Drive](https://developers.google.com/drive/api/reference/rest/v3/drives) for more details): + - **Can Add Children**: Whether the current user can add children to folders in this shared drive. + - **Can Change Copy Requires Writer Permission Restriction**: Whether the current user can change the `copyRequiresWriterPermission` restriction on this shared drive. + - **Can Change Domain Users Only Restriction**: Whether the current user can change the `domainUsersOnly` restriction on this shared drive. + - **Can Change Drive Background**: Whether the current user can change the background on this shared drive. + - **Can Change Drive Members Only Restriction**: Whether the current user can change the `driveMembersOnly` restriction on this shared drive. + - **Can Comment**: Whether the current user can comment on files in this shared drive. + - **Can Copy**: Whether the current user can copy files in this shared drive. + - **Can Delete Children**: Whether the current user can delete children from folders in this shared drive. + - **Can Delete Drive**: Whether the current user can delete this shared drive. This operation may still fail if there are items not in the trash in the shared drive. + - **Can Download**: Whether the current user can download files from this shared drive. + - **Can Edit**: Whether the current user can edit files from this shared drive. + - **Can List Children**: Whether the current user can list the children of folders in this shared drive. + - **Can Manage Members**: Whether the current user can add, remove, or change the role of members of this shared drive. + - **Can Read Revisions**: Whether the current user can read the revisions resource of files in this shared drive. + - **Can Rename Drive**: Whether the current user can rename this shared drive. + - **Can Share**: Whether the current user can share files or folders in this shared drive. + - **Can Trash Children**: Whether the current user can trash children from folders in this shared drive. +- **Color RGB**: The color of this shared drive as an RGB hex string. +- **Hidden**: Whether to hide this shared drive in the default view. +- **Restrictions**: Restrictions to add to this shared drive (see [REST Resources: drives | Google Drive](https://developers.google.com/drive/api/reference/rest/v3/drives) for more details): + - **Admin Managed Restrictions**: When enabled, restrictions here will override the similarly named fields to true for any file inside of this shared drive. + - **Copy Requires Writer Permission**: Whether the options to copy, print, or download files inside this shared drive should be disabled for readers and commenters. + - **Domain Users Only**: Whether to restrict access to this shared drive and items inside this shared drive to users of the domain to which this shared drive belongs. + - **Drive Members Only**: Whether to restrict access to items inside this shared drive to its members. + +Refer to the [Method: drives.insert | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/drives/insert){:target=_blank .external-link} API documentation for more information. + +## Delete a shared drive + +Use this operation to delete a shared drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Shared Drive**. +- **Operation**: Select **Delete**. +- **Shared Drive**: Choose the shared drive want to delete. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. + - You can find the `driveId` in the URL for the shared Google Drive: `https://drive.google.com/drive/u/0/folders/driveID`. + +Refer to the [Method: drives.delete | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/drives/delete){:target=_blank .external-link} API documentation for more information. + +## Get a shared drive + +Use this operation to get a shared drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Shared Drive**. +- **Operation**: Select **Get**. +- **Shared Drive**: Choose the shared drive want to get. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. + - You can find the `driveId` in the URL for the shared Google Drive: `https://drive.google.com/drive/u/0/folders/driveID`. + +### Options + +- **Use Domain Admin Access**: Whether to issue the request as a domain administrator. When enabled, grants the requester access if they're an administrator of the domain to which the shared drive belongs. + +Refer to the [Method: drives.get | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/drives/get){:target=_blank .external-link} API documentation for more information. + + +## Get many shared drives + +Use this operation to get many shared drives. + + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Shared Drive**. +- **Operation**: Select **Get Many**. +- **Return All**: Choose whether to return all results or only up to a given limit. +- **Limit**: The maximum number of items to return when **Return All** is disabled. +- **Shared Drive**: Choose the shared drive want to get. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. + - You can find the `driveId` in the URL for the shared Google Drive: `https://drive.google.com/drive/u/0/folders/driveID`. + +### Options + +- **Query**: The query string to use to search for shared drives. See [Search for shared drives | Google Drive](https://developers.google.com/drive/api/guides/search-shareddrives) for more information. +- **Use Domain Admin Access**: Whether to issue the request as a domain administrator. When enabled, grants the requester access if they're an administrator of the domain to which the shared drive belongs. + +Refer to the [Method: drives.get | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/drives/get){:target=_blank .external-link} API documentation for more information. + +## Update a shared drive + +Use this operation to update a shared drive. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Drive credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Shared Drive**. +- **Operation**: Select **Update**. +- **Shared Drive**: Choose the shared drive you want to update. + - Select **From list** to choose the drive from the dropdown list, **By URL** to enter the URL of the drive, or **By ID** to enter the `driveId`. + - You can find the `driveId` in the URL for the shared Google Drive: `https://drive.google.com/drive/u/0/folders/driveID`. + +### Update Fields + +- **Color RGB**: The color of this shared drive as an RGB hex string. +- **Name**: The updated name for the shared drive. +- **Restrictions**: Restrictions for this shared drive (see [REST Resources: drives | Google Drive](https://developers.google.com/drive/api/reference/rest/v3/drives) for more details): + - **Admin Managed Restrictions**: When enabled, restrictions here will override the similarly named fields to true for any file inside of this shared drive. + - **Copy Requires Writer Permission**: Whether the options to copy, print, or download files inside this shared drive should be disabled for readers and commenters. + - **Domain Users Only**: Whether to restrict access to this shared drive and items inside this shared drive to users of the domain to which this shared drive belongs. + - **Drive Members Only**: Whether to restrict access to items inside this shared drive to its members. + +Refer to the [Method: drives.update | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/drives/update){:target=_blank .external-link} API documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googleperspective.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Perspective node documentation +description: Learn how to use the Google Perspective node in n8n. Follow technical documentation to integrate Google Perspective node into your workflows. +contentType: [integration, reference] +--- + +# Google Perspective node + +Use the Google Perspective node to automate work in Google Perspective, and integrate Google Perspective with other applications. n8n has built-in support for a wide range of Google Perspective features, including analyzing comments. + +On this page, you'll find a list of operations the Google Perspective node supports and links to more resources. + +/// note | Credentials +Refer to [Google Perspective credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* Analyze Comment + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-perspective') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Sheets node common issues +description: Documentation for common questions and solutions in the Google Sheets node in n8n, a workflow automation platform. Includes details of the issue and suggested resolutions. +contentType: [integration, reference] +priority: critical +--- + +# Google Sheets node common issues + +Here are some common errors and issues with the [Google Sheets node](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md) and steps to resolve or troubleshoot them. + +## Append an array + +To insert an array of data into Google Sheets, you must convert the array into a valid JSON (key, value) format. + +To do so, consider using: + +1. The [Split Out](/integrations/builtin/core-nodes/n8n-nodes-base.splitout.md) node. +1. The [AI Transform](/integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md) node. For example, try entering something like: + ``` + Convert 'languages' array to JSON (key, value) pairs. + ``` +1. The [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). + + +## Column names were updated after the node's setup + + +You'll receive this error if the Google Sheet's column names have changed since you set up the node. + +To refresh the column names, re-select **Mapping Column Mode**. This should prompt the node to fetch the column names again. + +Once the column names refresh, update the node parameters. + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/document-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Sheets Document operations +description: Documentation for the Document operations in Google Sheets node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# Google Sheets Document operations + +Use this operation to create or delete a Google spreadsheet from Google Sheets. Refer to [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md) for more information on the Google Sheets node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Create a spreadsheet + +Use this operation to create a new spreadsheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Document**. +- **Operation**: Select **Create**. +- **Title**: Enter the title of the new spreadsheet you want to create. +- **Sheets**: Add the **Title(s)** of the sheet(s) you want to create within the spreadsheet. + + +### Options + +- **Locale**: Enter the locale of the spreadsheet. This affects formatting details such as functions, dates, and currency. Use one of the following formats: + - `en` (639-1) + - `fil` (639-2 if no 639-1 format exists) + - `en_US` (combination of ISO language and country). + - Refer to [List of ISO 639 language codes](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes){:target=_blank .external link} and [List of ISO 3166 country codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes){:target=_blank .external link} for language and country codes. Note that Google doesn't support all locales/languages. +- **Recalculation Interval**: Enter the desired recalculation interval for the spreadsheet functions. This affects how often `NOW`, `TODAY`, `RAND`, and `RANDBETWEEN` are updated. Select **On Change** for recalculating whenever there is a change in the spreadsheet, **Minute** for recalculating every minute, or **Hour** for recalculating every hour. Refer to [Set a spreadsheet’s location & calculation settings](https://support.google.com/docs/answer/58515){:target=_blank .external-link} for more information about these options. + +Refer to the [Method: spreadsheets.create | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/create){:target=_blank .external-link} API documentation for more information. + +## Delete a spreadsheet + +Use this operation to delete an existing spreadsheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Document**. +- **Operation**: Select **Delete**. +- **Document**: Choose a spreadsheet you want to delete. + - Select **From list** to choose the title from the dropdown list, **By URL** to enter the url of the spreadsheet, or **By ID** to enter the `spreadsheetId`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. + +Refer to the [Method: files.delete | Google Drive](https://developers.google.com/drive/api/reference/rest/v2/files/delete){:target=_blank .external-link} API documentation for more information. + +# integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Sheets +description: Documentation for the Google Sheets node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# Google Sheets + +Use the Google Sheets node to automate work in Google Sheets, and integrate Google Sheets with other applications. n8n has built-in support for a wide range of Google Sheets features, including creating, updating, deleting, appending, removing and getting documents. + +On this page, you'll find a list of operations the Google Sheets node supports and links to more resources. + +/// note | Credentials +Refer to [Google Sheets credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +## Operations + +* **Document** + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/document-operations.md#create-a-spreadsheet) a spreadsheet. + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/document-operations.md#delete-a-spreadsheet) a spreadsheet. +* **Sheet Within Document** + * [**Append or Update Row**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#append-or-update-row): Append a new row, or update the current one if it already exists. + * [**Append Row**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#append-row): Create a new row. + * [**Clear**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#clear-a-sheet) all data from a sheet. + * [**Create**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#create-a-new-sheet) a new sheet. + * [**Delete**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#delete-a-sheet) a sheet. + * [**Delete Rows or Columns**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#delete-rows-or-columns): Delete columns and rows from a sheet. + * [**Get Row(s)**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#get-rows): Read all rows in a sheet. + * [**Update Row**](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md#update-row): Update a row in a sheet. + + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-sheets') ]] + +## Related resources + +Refer to [Google Sheet's API documentation](https://developers.google.com/sheets/api){:target=_blank .external-link} for more information about the service. + + + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/common-issues.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/sheet-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Sheets Sheet Within Document operations +description: Documentation for the Sheet operations in Google Sheets node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# Google Sheets Sheet Within Document operations + +Use this operation to create, update, clear or delete a sheet in a Google spreadsheet from Google Sheets. Refer to [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md) for more information on the Google Sheets node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Append or Update Row + +Use this operation to update an existing row or add a new row at the end of the data if a matching entry isn't found in a sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Append or Update Row**. +- **Document**: Choose a spreadsheet that contains the sheet you want to append or update row(s) to. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose a sheet you want to append or update row(s) to. + - 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. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. +- **Mapping Column Mode**: + - **Map Each Column Manually**: Enter **Values to Send** for each column. + - **Map Automatically**: n8n looks for incoming data that matches the columns in Google Sheets automatically. In this mode, make sure the incoming data fields are the same as the columns in Google Sheets. (Use an [Edit Fields](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node before this node to change them if required.) + - **Nothing**: Don't map any data. + +### Options +--8<-- "_snippets/integrations/builtin/app-nodes/googlesheets/node-options.md" + +Refer to the [Method: spreadsheets.values.update | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/update){:target=_blank .external-link} API documentation for more information. + +## Append Row + +Use this operation to append a new row at the end of the data in a sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Append Row**. +- **Document**: Choose a spreadsheet with the sheet you want to append a row to. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose a sheet you want to append a row to. + - 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. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. +- **Mapping Column Mode**: + - **Map Each Column Manually**: Select the **Column to Match On** when finding the rows to update. Enter **Values to Send** for each column. + - **Map Automatically**: n8n looks for incoming data that matches the columns in Google Sheets automatically. In this mode, make sure the incoming data fields are the same as the columns in Google Sheets. (Use an [Edit Fields](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node before this node to change them if required.) + - **Nothing**: Don't map any data. + +### Options +--8<-- "_snippets/integrations/builtin/app-nodes/googlesheets/node-options.md" + +Refer to the [Method: spreadsheets.values.append | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append){:target=_blank .external-link} API documentation for more information. + +## Clear a sheet + +Use this operation to clear all data from a sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Clear**. +- **Document**: Choose a spreadsheet with the sheet you want to clear data from. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose a sheet you want to clear data from. + - 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. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. +- **Clear**: Select what data you want cleared from the sheet. + - **Whole Sheet**: Clear the entire sheet's data. Turn on **Keep First Row** to keep the first row of the sheet. + - **Specific Rows**: Clear data from specific rows. Also enter: + - **Start Row Number**: Enter the first row number you want to clear. + - **Number of Rows to Delete**: Enter the number of rows to clear. `1` clears data only the row in the **Start Row Number**. + - **Specific Columns**: Clear data from specific columns. Also enter: + - **Start Column**: Enter the first column you want to clear using the letter notation. + - **Number of Columns to Delete**: Enter the number of columns to clear. `1` clears data only in the **Start Column**. + - **Specific Range**: Enter the table range to clear data from, in [A1 notation](https://developers.google.com/sheets/api/guides/concepts#cell){:target=_blank .external-link}. + +Refer to the [Method: spreadsheets.values.clear | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/clear){:target=_blank .external-link} API documentation for more information. + +## Create a new sheet + +Use this operation to create a new sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Create**. +- **Document**: Choose a spreadsheet in which you want to create a new sheet. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Title**: Enter the title for your new sheet. + +### Options + +- **Hidden**: Turn on this option to keep the sheet hidden in the UI. +- **Right To Left**: Turn on this option to use RTL sheet instead of an LTR sheet. +- **Sheet ID**: Enter the ID of the sheet. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId` +- **Sheet Index**: By default, the new sheet is the last sheet in the spreadsheet. To override this behavior, enter the index you want the new sheet to use. When you add a sheet at a given index, Google increments the indices for all following sheets. Refer to [Sheets | SheetProperties](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/sheets#SheetProperties){:target=_blank .external-link} documentation for more information. +- **Tab Color**: Enter the color as hex code or use the color picker to set the color of the tab in the UI. + +Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. + +## Delete a sheet + +Use this operation to permanently delete a sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Delete**. +- **Document**: Choose a spreadsheet that contains the sheet you want to delete. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose the sheet you want to delete. + - 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 name of the sheet. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. + +Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. + +## Delete Rows or Columns + +Use this operation to delete rows or columns in a sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Delete Rows or Columns**. +- **Document**: Choose a spreadsheet that contains the sheet you want to delete rows or columns from. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose the sheet in which you want to delete rows or columns. + - 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 name of the sheet. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. +- **Start Row Number** or **Start Column**: Enter the row number or column letter to start deleting. +- **Number of Rows to Delete** or **Number of Columns to delete**: Enter the number of rows or columns to delete. + +Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. + +## Get Row(s) + +Use this operation to read one or more rows from a sheet. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Get Row(s)**. +- **Document**: Choose a spreadsheet that contains the sheet you want to get rows from. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose a sheet you want to read rows from. + - 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 name of the sheet. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. +- **Filters**: By default, the node returns all rows in the sheet. Set filters to return a limited set of results: + - **Column**: Select the column in your sheet to search against. + - **Value**: Enter a cell value to search for. You can drag input data parameters here. + If your filter matches multiple rows, n8n returns the first result. If you want all matching rows: + 1. Under **Options**, select **Add Option** > **When Filter Has Multiple Matches**. + 2. Change **When Filter Has Multiple Matches** to **Return All Matches**. + +### Options + +- **Data Location on Sheet**: Use this option to specify a data range. By default, n8n will detect the range automatically until the last row in the sheet. +- **Output Formatting**: Use this option to choose how n8n formats the data returned by Google Sheets. + - **General Formatting**: + - **Values (unformatted)** (default): n8n removes currency signs and other special formatting. Data type remains as number. + - **Values (formatted)**: n8n displays the values as they appear in Google Sheets (for example, retaining commas or currency signs) by converting the data type from number to string. + - **Formulas**: n8n returns the formula. It doesn't calculate the formula output. For example, if a cell B2 has the formula `=A2`, n8n returns B2's value as `=A2` (in text). Refer to [About date & time values | Google Sheets](https://developers.google.com/sheets/api/guides/formats#about_date_time_values){:target=_blank .external-link} for more information. + - **Date Formatting**: Refer to [DateTimeRenderOption | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/DateTimeRenderOption){:target=_blank .external-link} for more information. + - **Formatted Text** (default): As displayed in Google Sheets, which depends on the spreadsheet locale. For example `01/01/2024`. + - **Serial Number**: Number of days since December 30th 1899. +- **When Filter Has Multiple Matches**: Set to **Return All Matches** to get multiple matches. By default only the first result gets returned. + +/// note | First row +n8n treats the first row in a Google Sheet as a heading row, and doesn't return it when reading all rows. If you want to read the first row, use the **Options** to set **Data Location on Sheet**. +/// + +Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. + +## Update Row + +Use this operation to update existing row in a sheet. This operation only updates existing rows. To append rows when a matching entry isn't found in a sheet, use **Append or Update Row** operation instead. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Google Sheets credentials](/integrations/builtin/credentials/google/index.md). +- **Resource**: Select **Sheet Within Document**. +- **Operation**: Select **Update Row**. +- **Document**: Choose a spreadsheet with the sheet you want to update. + - 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`. + - You can find the `spreadsheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0`. +- **Sheet**: Choose a sheet you want to update. + - 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. + - You can find the `sheetId` in a Google Sheets URL: `https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId`. +- **Mapping Column Mode**: + - **Map Each Column Manually**: Enter **Values to Send** for each column. + - **Map Automatically**: n8n looks for incoming data that matches the columns in Google Sheets automatically. In this mode, make sure the incoming data fields are the same as the columns in Google Sheets. (Use an [Edit Fields](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node before this node to change them if required.) + - **Nothing**: Don't map any data. + +### Options + +- **Cell Format**: Use this option to choose how to format the data in cells. Refer to [Google Sheets API | CellFormat](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#CellFormat){:target=_blank .external-link} for more information. + - **Let Google Sheets format** (default): n8n formats text and numbers in the cells according to Google Sheets' default settings. + - **Let n8n format**: New cells in your sheet will have the same data types as the input data provided by n8n. +- **Data Location on Sheet**: Use this option when you need to specify where the data range on your sheet. + - **Header Row**: Specify the row index that contains the column headers. + - **First Data Row**: Specify the row index where the actual data starts. + +Refer to the [Method: spreadsheets.batchUpdate | Google Sheets](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate){:target=_blank .external-link} API documentation for more information. + +# integrations/builtin/app-nodes/n8n-nodes-base.googleslides.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Slides node documentation +description: Learn how to use the Google Slides node in n8n. Follow technical documentation to integrate Google Slides node into your workflows. +contentType: [integration, reference] +--- + +# Google Slides node + +Use the Google Slides node to automate work in Google Slides, and integrate Google Slides with other applications. n8n has built-in support for a wide range of Google Slides features, including creating presentations, and getting pages. + +On this page, you'll find a list of operations the Google Slides node supports and links to more resources. + +/// note | Credentials +Refer to [Google credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Page + * Get a page + * Get a thumbnail +* Presentation + * Create a presentation + * Get a presentation + * Get presentation slides + * Replace text in a presentation + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-slides') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googletasks.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Tasks node documentation +description: Learn how to use the Google Tasks node in n8n. Follow technical documentation to integrate Google Tasks node into your workflows. +contentType: [integration, reference] +--- + +# Google Tasks node + +Use the Google Tasks node to automate work in Google Tasks, and integrate Google Tasks with other applications. n8n has built-in support for a wide range of Google Tasks features, including adding, updating, and retrieving contacts. + +On this page, you'll find a list of operations the Google Tasks node supports and links to more resources. + +/// note | Credentials +Refer to [Google Tasks credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Task + * Add a task to task list + * Delete a task + * Retrieve a task + * Retrieve all tasks from a task list + * Update a task + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-tasks') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.googletranslate.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Translate node documentation +description: Learn how to use the Google Translate node in n8n. Follow technical documentation to integrate Google Translate node into your workflows. +contentType: [integration, reference] +--- + +# Google Translate node + +Use the Google Translate node to automate work in Google Translate, and integrate Google Translate with other applications. n8n has built-in support for a wide range of Google Translate features, including translating languages. + +On this page, you'll find a list of operations the Google Translate node supports and links to more resources. + +/// note | Credentials +Refer to [Google Translate credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Language + * Translate data + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-translate') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.gotify.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Gotify node documentation +description: Learn how to use the Gotify node in n8n. Follow technical documentation to integrate Gotify node into your workflows. +contentType: [integration, reference] +--- + +# Gotify node + +Use the Gotify node to automate work in Gotify, and integrate Gotify with other applications. n8n has built-in support for a wide range of Gotify features, including creating, deleting, and getting messages. + +On this page, you'll find a list of operations the Gotify node supports and links to more resources. + +/// note | Credentials +Refer to [Gotify credentials](/integrations/builtin/credentials/gotify.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Message + * Create + * Delete + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'gotify') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.gotowebinar.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: GoToWebinar node documentation +description: Learn how to use the GoToWebinar node in n8n. Follow technical documentation to integrate GoToWebinar node into your workflows. +contentType: [integration, reference] +--- + +# GoToWebinar node + +Use the GoToWebinar node to automate work in GoToWebinar, and integrate GoToWebinar with other applications. n8n has built-in support for a wide range of GoToWebinar features, including creating, getting, and deleting attendees, organizers, and registrants. + +On this page, you'll find a list of operations the GoToWebinar node supports and links to more resources. + +/// note | Credentials +Refer to [GoToWebinar credentials](/integrations/builtin/credentials/gotowebinar.md) for guidance on setting up authentication. +/// + +## Operations + +* Attendee + * Get + * Get All + * Get Details +* Co-Organizer + * Create + * Delete + * Get All + * Re-invite +* Panelist + * Create + * Delete + * Get All + * Re-invite +* Registrant + * Create + * Delete + * Get + * Get All +* Session + * Get + * Get All + * Get Details +* Webinar + * Create + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'gotowebinar') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.grafana.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Grafana node documentation +description: Learn how to use the Grafana node in n8n. Follow technical documentation to integrate Grafana node into your workflows. +contentType: [integration, reference] +--- + +# Grafana node + +Use the Grafana node to automate work in Grafana, and integrate Grafana with other applications. n8n has built-in support for a wide range of Grafana features, including creating, updating, deleting, and getting dashboards, teams, and users. + +On this page, you'll find a list of operations the Grafana node supports and links to more resources. + +/// note | Credentials +Refer to [Grafana credentials](/integrations/builtin/credentials/grafana.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Dashboard + * Create a dashboard + * Delete a dashboard + * Get a dashboard + * Get all dashboards + * Update a dashboard +* Team + * Create a team + * Delete a team + * Get a team + * Retrieve all teams + * Update a team +* Team Member + * Add a member to a team + * Retrieve all team members + * Remove a member from a team +* User + * Delete a user from the current organization + * Retrieve all users in the current organization + * Update a user in the current organization + +## Templates and examples + + +[[ templatesWidget(page.title, 'grafana') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.grist.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Grist node documentation +description: Learn how to use the Grist node in n8n. Follow technical documentation to integrate Grist node into your workflows. +contentType: [integration, reference] +--- + +# Grist node + +Use the Grist node to automate work in Grist, and integrate Grist with other applications. n8n has built-in support for a wide range of Grist features, including creating, updating, deleting, and reading rows in a table. + +On this page, you'll find a list of operations the Grist node supports and links to more resources. + +/// note | Credentials +Refer to [Grist credentials](/integrations/builtin/credentials/grist.md) for guidance on setting up authentication. +/// + +## Operations + +* Create rows in a table +* Delete rows from a table +* Read rows from a table +* Update rows in a table + +## Templates and examples + + +[[ templatesWidget(page.title, 'grist') ]] + +## Get the Row ID + +To update or delete a particular record, you need the Row ID. There are two ways to get the Row ID: + +**Create a Row ID column in Grist** + +Create a new column in your Grist table with the formula `$id`. + +**Use the Get All operation** + +The **Get All** operation returns the Row ID of each record along with the fields. + +You can get it with the expression `{{$node["GristNodeName"].json["id"]}}`. + + +## Filter records when using the Get All operation + +- Select **Add Option** and select **Filter** from the dropdown list. +- You can add filters for any number of columns. The result will only include records which match all the columns. +- For each column, you can enter any number of values separated by commas. The result will include records which match any of the values for that column. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.gsuiteadmin.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Workspace Admin node documentation +description: Learn how to use the Google Workspace Admin node in n8n. Follow technical documentation to integrate Google Workspace Admin node into your workflows. +contentType: [integration, reference] +--- + +# Google Workspace Admin node + +Use the Google Workspace Admin node to automate work in Google Workspace Admin, and integrate Google Workspace Admin with other applications. n8n has built-in support for a wide range of Google Workspace Admin features, including creating, updating, deleting, and getting users, and groups. + +On this page, you'll find a list of operations the Google Workspace Admin node supports and links to more resources. + +/// note | Credentials +Refer to [Google credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Group + * Create a group + * Delete a group + * Get a group + * Get all groups + * Update a group +* User + * Create a user + * Delete a user + * Get a user + * Get all users + * Update a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-workspace-admin') ]] + +## How to project a user's information + +There are three different ways to project a user's information: + +- **Basic**: Doesn't include any custom fields. +- **Custom**: Includes the custom fields from schemas in `customField`. +- **Full**: Include all the fields associated with the user. + +To include custom fields, follow these steps: + +1. Select **Custom** from the **Projection** dropdown list. +2. Select the **Add Options** button and select **Custom Schemas** from the dropdown list. +3. Select the schema names you want to include from the **Custom Schemas** dropdown list. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.hackernews.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Hacker News node documentation +description: Learn how to use the Hacker News node in n8n. Follow technical documentation to integrate Hacker News node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Hacker News node + +Use the Hacker News node to automate work in Hacker News, and integrate Hacker News with other applications. n8n has built-in support for a wide range of Hacker News features, including getting articles, and users. + +On this page, you'll find a list of operations the Hacker News node supports and links to more resources. + +/// note | Credentials +This node doesn't require authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* All + * Get all items +* Article + * Get a Hacker News article +* User + * Get a Hacker News user + +## Templates and examples + + +[[ templatesWidget(page.title, 'hacker-news') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.halopsa.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: HaloPSA node documentation +description: Learn how to use the HaloPSA node in n8n. Follow technical documentation to integrate HaloPSA node into your workflows. +contentType: [integration, reference] +--- + +# HaloPSA node + +Use the HaloPSA node to automate work in HaloPSA, and integrate HaloPSA with other applications. n8n has built-in support for a wide range of HaloPSA features, including creating, updating, deleting, and getting clients, sites and tickets. + +On this page, you'll find a list of operations the HaloPSA node supports and links to more resources. + +/// note | Credentials +Refer to [HaloPSA credentials](/integrations/builtin/credentials/halopsa.md) for guidance on setting up authentication. +/// + +## Operations + +* Client + * Create a client + * Delete a client + * Get a client + * Get all clients + * Update a client +* Site + * Create a site + * Delete a site + * Get a site + * Get all sites + * Update a site +* Ticket + * Create a ticket + * Delete a ticket + * Get a ticket + * Get all tickets + * Update a ticket +* User + * Create a user + * Delete a user + * Get a user + * Get all users + * Update a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'halopsa') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.harvest.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Harvest node documentation +description: Learn how to use the Harvest node in n8n. Follow technical documentation to integrate Harvest node into your workflows. +contentType: [integration, reference] +--- + +# Harvest node + +Use the Harvest node to automate work in Harvest, and integrate Harvest with other applications. n8n has built-in support for a wide range of Harvest features, including creating, updating, deleting, and getting clients, contacts, invoices, tasks, expenses, users, and projects. + +On this page, you'll find a list of operations the Harvest node supports and links to more resources. + +/// note | Credentials +Refer to [Harvest credentials](/integrations/builtin/credentials/harvest.md) for guidance on setting up authentication. +/// + +## Operations + +* Client + * Create a client + * Delete a client + * Get data of a client + * Get data of all clients + * Update a client +* Company + * Retrieves the company for the currently authenticated user +* Contact + * Create a contact + * Delete a contact + * Get data of a contact + * Get data of all contacts + * Update a contact +* Estimate + * Create an estimate + * Delete an estimate + * Get data of an estimate + * Get data of all estimates + * Update an estimate +* Expense + * Get data of an expense + * Get data of all expenses + * Create an expense + * Update an expense + * Delete an expense +* Invoice + * Get data of an invoice + * Get data of all invoices + * Create an invoice + * Update an invoice + * Delete an invoice +* Project + * Create a project + * Delete a project + * Get data of a project + * Get data of all projects + * Update a project +* Task + * Create a task + * Delete a task + * Get data of a task + * Get data of all tasks + * Update a task +* Time Entries + * Create a time entry using duration + * Create a time entry using start and end time + * Delete a time entry + * Delete a time entry's external reference. + * Get data of a time entry + * Get data of all time entries + * Restart a time entry + * Stop a time entry + * Update a time entry +* User + * Create a user + * Delete a user + * Get data of a user + * Get data of all users + * Get data of authenticated user + * Update a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'harvest') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.helpscout.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Help Scout node documentation +description: Learn how to use the Help Scout node in n8n. Follow technical documentation to integrate Help Scout node into your workflows. +contentType: [integration, reference] +--- + +# Help Scout node + +Use the Help Scout node to automate work in Help Scout, and integrate Help Scout with other applications. n8n has built-in support for a wide range of Help Scout features, including creating, updating, deleting, and getting conversations, and customers. + +On this page, you'll find a list of operations the Help Scout node supports and links to more resources. + +/// note | Credentials +Refer to [Help Scout credentials](/integrations/builtin/credentials/helpscout.md) for guidance on setting up authentication. +/// + +## Operations + +* Conversation + * Create a new conversation + * Delete a conversation + * Get a conversation + * Get all conversations +* Customer + * Create a new customer + * Get a customer + * Get all customers + * Get customer property definitions + * Update a customer +* Mailbox + * Get data of a mailbox + * Get all mailboxes +* Thread + * Create a new chat thread + * Get all chat threads + +## Templates and examples + + +[[ templatesWidget(page.title, 'helpscout') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.highlevel.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: HighLevel node documentation +description: Learn how to use the HighLevel node in n8n. Follow technical documentation to integrate HighLevel node into your workflows. +contentType: [integration, reference] +--- + +# HighLevel node + +Use the HighLevel node to automate work in HighLevel, and integrate HighLevel with other applications. n8n has built-in support for a wide range of HighLevel features, including creating, updating, deleting, and getting contacts, opportunities, and tasks, as well as booking appointments and getting free time slots in calendars. + +On this page, you'll find a list of operations the HighLevel node supports and links to more resources. + +/// note | Credentials +Refer to [HighLevel credentials](/integrations/builtin/credentials/highlevel.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create or update + * Delete + * Get + * Get many + * Update +* Opportunity + * Create + * Delete + * Get + * Get many + * Update +* Task + * Create + * Delete + * Get + * Get many + * Update +* Calendar + * Book an appointment + * Get free slots + +## Templates and examples + + +[[ templatesWidget(page.title, 'highlevel') ]] + +## Related resources + +Refer to [HighLevel's API documentation and support forums](https://help.gohighlevel.com/support/solutions/articles/48001060529-highlevel-api){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.homeassistant.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Home Assistant node documentation +description: Learn how to use the Home Assistant node in n8n. Follow technical documentation to integrate Home Assistant node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Home Assistant node + +Use the Home Assistant node to automate work in Home Assistant, and integrate Home Assistant with other applications. n8n has built-in support for a wide range of Home Assistant features, including getting, creating, and checking camera proxies, configurations, logs, services, and templates. + +On this page, you'll find a list of operations the Home Assistant node supports and links to more resources. + +/// note | Credentials +Refer to [Home Assistant credentials](/integrations/builtin/credentials/homeassistant.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Camera Proxy + * Get the camera screenshot +* Config + * Get the configuration + * Check the configuration +* Event + * Create an event + * Get all events +* Log + * Get a log for a specific entity + * Get all logs +* Service + * Call a service within a specific domain + * Get all services +* State + * Create a new record, or update the current one if it already exists (upsert) + * Get a state for a specific entity + * Get all states +* Template + * Create a template + +## Templates and examples + + +[[ templatesWidget(page.title, 'home-assistant') ]] + +## Related resources + +Refer to [Home Assistant's documentation](https://developers.home-assistant.io/docs/api/rest/){:target=_blank .external-link} for more information about the service. + + +# integrations/builtin/app-nodes/n8n-nodes-base.hubspot.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: HubSpot node documentation +description: Learn how to use the HubSpot node in n8n. Follow technical documentation to integrate HubSpot node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# HubSpot node + +Use the HubSpot node to automate work in HubSpot, and integrate HubSpot with other applications. n8n has built-in support for a wide range of HubSpot features, including creating, updating, deleting, and getting contacts, deals, lists, engagements and companies. + +On this page, you'll find a list of operations the HubSpot node supports and links to more resources. + +/// note | Credentials +Refer to [HubSpot credentials](/integrations/builtin/credentials/hubspot.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Contact + * Create/Update a contact + * Delete a contact + * Get a contact + * Get all contacts + * Get recently created/updated contacts + * Search contacts +* Contact List + * Add contact to a list + * Remove a contact from a list +* Company + * Create a company + * Delete a company + * Get a company + * Get all companies + * Get recently created companies + * Get recently modified companies + * Search companies by domain + * Update a company +* Deal + * Create a deal + * Delete a deal + * Get a deal + * Get all deals + * Get recently created deals + * Get recently modified deals + * Search deals + * Update a deal +* Engagement + * Create an engagement + * Delete an engagement + * Get an engagement + * Get all engagements +* Form + * Get all fields from a form + * Submit data to a form +* Ticket + * Create a ticket + * Delete a ticket + * Get a ticket + * Get all tickets + * Update a ticket + +## Templates and examples + + +[[ templatesWidget(page.title, 'hubspot') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.humanticai.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Humantic AI node documentation +description: Learn how to use the Humantic AI node in n8n. Follow technical documentation to integrate Humantic AI node into your workflows. +contentType: [integration, reference] +--- + +# Humantic AI node + +Use the Humantic AI node to automate work in Humantic AI, and integrate Humantic AI with other applications. n8n has built-in support for a wide range of Humantic AI features, including creating, retrieving, and updating profiles. + +On this page, you'll find a list of operations the Humantic AI node supports and links to more resources. + +/// note | Credentials +Refer to [Humantic AI credentials](/integrations/builtin/credentials/humanticai.md) for guidance on setting up authentication. +/// + +## Operations + +* Profile + * Create a profile + * Retrieve a profile + * Update a profile + +## Templates and examples + + +[[ templatesWidget(page.title, 'humantic-ai') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.hunter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Hunter node documentation +description: Learn how to use the Hunter node in n8n. Follow technical documentation to integrate Hunter node into your workflows. +contentType: [integration, reference] +--- + +# Hunter node + +Use the Hunter node to automate work in Hunter, and integrate Hunter with other applications. n8n has built-in support for a wide range of Hunter features, including getting, generating, and verifying email addresses. + +On this page, you'll find a list of operations the Hunter node supports and links to more resources. + +/// note | Credentials +Refer to [Hunter credentials](/integrations/builtin/credentials/hunter.md) for guidance on setting up authentication. +/// + +## Operations + +* Get every email address found on the internet using a given domain name, with sources +* Generate or retrieve the most likely email address from a domain name, a first name and a last name +* Verify the deliverability of an email address + +## Templates and examples + + +[[ templatesWidget(page.title, 'hunter') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.intercom.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Intercom node documentation +description: Learn how to use the Intercom node in n8n. Follow technical documentation to integrate Intercom node into your workflows. +contentType: [integration, reference] +--- + +# Intercom node + +Use the Intercom node to automate work in Intercom, and integrate Intercom with other applications. n8n has built-in support for a wide range of Intercom features, including creating, updating, deleting, and getting companies, leads, and users. + +On this page, you'll find a list of operations the Intercom node supports and links to more resources. + +/// note | Credentials +Refer to [Intercom credentials](/integrations/builtin/credentials/intercom.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Create a new company + * Get data of a company + * Get data of all companies + * Update a company + * List company's users +* Lead + * Create a new lead + * Delete a lead + * Get data of a lead + * Get data of all leads + * Update new lead +* User + * Create a new user + * Delete a user + * Get data of a user + * Get data of all users + * Update a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'intercom') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.invoiceninja.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Invoice Ninja node documentation +description: Learn how to use the Invoice Ninja node in n8n. Follow technical documentation to integrate Invoice Ninja node into your workflows. +contentType: [integration, reference] +--- + +# Invoice Ninja node + +Use the Invoice Ninja node to automate work in Invoice Ninja, and integrate Invoice Ninja with other applications. n8n has built-in support for a wide range of Invoice Ninja features, including creating, updating, deleting, and getting clients, expense, invoice, payments and quotes. + +On this page, you'll find a list of operations the Invoice Ninja node supports and links to more resources. + +/// note | Credentials +Refer to [Invoice Ninja credentials](/integrations/builtin/credentials/invoiceninja.md) for guidance on setting up authentication. +/// + +## Operations + +* Client + * Create a new client + * Delete a client + * Get data of a client + * Get data of all clients +* Expense + * Create a new expense + * Delete an expense + * Get data of an expense + * Get data of all expenses +* Invoice + * Create a new invoice + * Delete a invoice + * Email an invoice + * Get data of a invoice + * Get data of all invoices +* Payment + * Create a new payment + * Delete a payment + * Get data of a payment + * Get data of all payments +* Quote + * Create a new quote + * Delete a quote + * Email an quote + * Get data of a quote + * Get data of all quotes +* Task + * Create a new task + * Delete a task + * Get data of a task + * Get data of all tasks + +## Templates and examples + + +[[ templatesWidget(page.title, 'invoice-ninja') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.iterable.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Iterable node documentation +description: Learn how to use the Iterable node in n8n. Follow technical documentation to integrate Iterable node into your workflows. +contentType: [integration, reference] +--- + +# Iterable node + +Use the Iterable node to automate work in Iterable, and integrate Iterable with other applications. n8n has built-in support for a wide range of Iterable features, including creating users, recording the actions performed by the users, and adding and removing users from the list. + +On this page, you'll find a list of operations the Iterable node supports and links to more resources. + +/// note | Credentials +Refer to [Iterable credentials](/integrations/builtin/credentials/iterable.md) for guidance on setting up authentication. +/// + +## Operations + +* Event + * Record the actions a user perform +* User + * Create/Update a user + * Delete a user + * Get a user +* User List + * Add user to list + * Remove a user from a list + +## Templates and examples + + +[[ templatesWidget(page.title, 'iterable') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.jenkins.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Jenkins node documentation +description: Learn how to use the Jenkins node in n8n. Follow technical documentation to integrate Jenkins node into your workflows. +contentType: [integration, reference] +--- + +# Jenkins node + +Use the Jenkins node to automate work in Jenkins, and integrate Jenkins with other applications. n8n has built-in support for a wide range of Jenkins features, including listing builds, managing instances, and creating and copying jobs. + +On this page, you'll find a list of operations the Jenkins node supports and links to more resources. + +/// note | Credentials +Refer to [Jenkins credentials](/integrations/builtin/credentials/jenkins.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Build + * List Builds +* Instance + * Cancel quiet down state + * Put Jenkins in quiet mode, no builds can be started, Jenkins is ready for shutdown + * Restart Jenkins immediately on environments where it's possible + * Restart Jenkins once no jobs are running on environments where it's possible + * Shutdown once no jobs are running + * Shutdown Jenkins immediately +* Job + * Copy a specific job + * Create a new job + * Trigger a specific job + * Trigger a specific job + +## Templates and examples + + +[[ templatesWidget(page.title, 'jenkins') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.jinaai.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Jina AI node documentation +description: Learn how to use the Jina AI node in n8n. Follow technical documentation to integrate Jina AI node into your workflows. +contentType: [integration, reference] +--- + +# Jina AI node + +Use the Jina AI node to automate work in Jina AI and integrate Jina AI with other applications. n8n has built-in support for a wide range of Jina AI features. + +On this page, you'll find a list of operations the Jina AI node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/jinaai.md). +/// + + +## Operations + +* **Reader**: + * **Read**: Fetches content from a URL and converts it to clean, LLM-friendly formats. + * **Search**: Performs a web search using Jina AI and returns the top results as clean, LLM-friendly formats. +* **Research**: + * **Deep Research**: Research a topic and generate a structured research report. + +## Templates and examples + + +[[ templatesWidget(page.title, 'jina-ai') ]] + +## Related resources + +Refer to [Jina AI's reader API documentation](https://r.jina.ai/docs) and [Jina AI's search API documentation](https://s.jina.ai/docs) for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.jira.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Jira Software node documentation +description: Learn how to use the Jira Software node in n8n. Follow technical documentation to integrate Jira Software node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Jira Software node + +Use the Jira Software node to automate work in Jira, and integrate Jira with other applications. n8n has built-in support for a wide range of Jira features, including creating, updating, deleting, and getting issues, and users. + +On this page, you'll find a list of operations the Jira Software node supports and links to more resources. + +/// note | Credentials +Refer to [Jira credentials](/integrations/builtin/credentials/jira.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Issue + * Get issue changelog + * Create a new issue + * Delete an issue + * Get an issue + * Get all issues + * Create an email notification for an issue and add it to the mail queue + * Return either all transitions or a transition that can be performed by the user on an issue, based on the issue's status + * Update an issue +* Issue Attachment + * Add attachment to issue + * Get an attachment + * Get all attachments + * Remove an attachment +* Issue Comment + * Add comment to issue + * Get a comment + * Get all comments + * Remove a comment + * Update a comment +* User + * Create a new user. + * Delete a user. + * Retrieve a user. + +## Templates and examples + + +[[ templatesWidget(page.title, 'jira-software') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Related resources + +Refer to the [official JQL documentation](https://www.atlassian.com/software/jira/guides/expand-jira/jql) about Jira Query Language (JQL) to learn more about it. + +## Fetch issues for a specific project + +The **Get All** operation returns all the issues from Jira. To fetch issues for a particular project, you need to use Jira Query Language (JQL). + +For example, if you want to receive all the issues of a project named `n8n`, you'd do something like this: + +- Select **Get All** from the **Operation** dropdown list. +- Toggle **Return All** to true. +- Select **Add Option** and select **JQL**. +- Enter `project=n8n` in the **JQL** field. + +This query will fetch all the issues in the project named `n8n`. Enter the name of your project instead of `n8n` to fetch all the issues for your project. + + +# integrations/builtin/app-nodes/n8n-nodes-base.kafka.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Kafka node documentation +description: Learn how to use the Kafka node in n8n. Follow technical documentation to integrate Kafka node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Kafka node + +Use the Kafka node to automate work in Kafka, and integrate Kafka with other applications. n8n has built-in support for a wide range of Kafka features, including sending messages. + +On this page, you'll find a list of operations the Kafka node supports and links to more resources. + +/// note | Credentials +Refer to [Kafka credentials](/integrations/builtin/credentials/kafka.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +- Send message + +## Templates and examples + + +[[ templatesWidget(page.title, 'kafka') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.keap.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Keap node documentation +description: Learn how to use the Keap node in n8n. Follow technical documentation to integrate Keap node into your workflows. +contentType: [integration, reference] +--- + +# Keap node + +Use the Keap node to automate work in Keap, and integrate Keap with other applications. n8n has built-in support for a wide range of Keap features, including creating, updating, deleting, and getting companies, products, ecommerce orders, emails, and files. + +On this page, you'll find a list of operations the Keap node supports and links to more resources. + +/// note | Credentials +Refer to [Keap credentials](/integrations/builtin/credentials/keap.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Create a company + * Retrieve all companies +* Contact + * Create/update a contact + * Delete an contact + * Retrieve an contact + * Retrieve all contacts +* Contact Note + * Create a note + * Delete a note + * Get a notes + * Retrieve all notes + * Update a note +* Contact Tag + * Add a list of tags to a contact + * Delete a contact's tag + * Retrieve all contact's tags +* Ecommerce Order + * Create an ecommerce order + * Get an ecommerce order + * Delete an ecommerce order + * Retrieve all ecommerce orders +* Ecommerce Product + * Create an ecommerce product + * Delete an ecommerce product + * Get an ecommerce product + * Retrieve all ecommerce product +* Email + * Create a record of an email sent to a contact + * Retrieve all sent emails + * Send Email +* File + * Delete a file + * Retrieve all files + * Upload a file + +## Templates and examples + + +[[ templatesWidget(page.title, 'keap') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.kitemaker.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Kitemaker node documentation +description: Learn how to use the Kitemaker node in n8n. Follow technical documentation to integrate Kitemaker node into your workflows. +contentType: [integration, reference] +--- + +# Kitemaker node + +Use the Kitemaker node to automate work in Kitemaker, and integrate Kitemaker with other applications. n8n has built-in support for a wide range of Kitemaker features, including retrieving data on organizations, spaces and users, as well as creating, getting, and updating work items. + +On this page, you'll find a list of operations the Kitemaker node supports and links to more resources. + +/// note | Credentials +Refer to [Kitemaker credentials](/integrations/builtin/credentials/kitemaker.md) for guidance on setting up authentication. +/// + +## Operations + +* Organization + * Retrieve data on the logged-in user's organization. +* Space + * Retrieve data on all the spaces in the logged-in user's organization. +* User + * Retrieve data on all the users in the logged-in user's organization. +* Work Item + * Create + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'kitemaker') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.kobotoolbox.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: KoboToolbox node documentation +description: Learn how to use the KoboToolbox node in n8n. Follow technical documentation to integrate KoboToolbox node into your workflows. +contentType: [integration, reference] +--- + +# KoboToolbox node + +Use the KoboToolbox node to automate work in KoboToolbox, and integrate KoboToolbox with other applications. n8n has built-in support for a wide range of KoboToolbox features, including creating, updating, deleting, and getting files, forms, hooks, and submissions. + +On this page, you'll find a list of operations the KoboToolbox node supports and links to more resources. + +/// note | Credentials +Refer to [KoboToolbox credentials](/integrations/builtin/credentials/kobotoolbox.md) for guidance on setting up authentication. +/// + +## Operations + +* File + * Create + * Delete + * Get + * Get Many +* Form + * Get + * Get Many + * Redeploy +* Hook + * Get + * Get Many + * Logs + * Retry All + * Retry One +* Submission + * Delete + * Get + * Get Many + * Get Validation Status + * Update Validation Status + +## Templates and examples + + +[[ templatesWidget(page.title, 'kobotoolbox') ]] + +## Options + +### Query Options + +The Query Submission operation supports query options: + +* In the main section of the **Parameters** panel: + * **Start** controls the index offset to start the query from (to use the API pagination logic). + * **Limit** sets the maximum number of records to return. Note that the API always has a limit of 30,000 returned records, whatever value you provide. +* In the **Query Options** section, you can activate the following parameters: + * **Query** lets you specify filter predicates in MongoDB's JSON query format. For example: `{"status": "success", "_submission_time": {"$lt": "2021-11-01T01:02:03"}}` queries for all submissions with the value `success` for the field `status`, and submitted before November 1st, 2021, 01:02:03. + * **Fields** lets you specify the list of fields you want to fetch, to make the response lighter. + * **Sort** lets you provide a list of sorting criteria in MongoDB JSON format. For example, `{"status": 1, "_submission_time": -1}` specifies a sort order by ascending status, and then descending submission time. + +More details about these options can be found in the [Formhub API docs](https://github.com/SEL-Columbia/formhub/wiki/Formhub-Access-Points-(API)#api-parameters) + +### Submission options + +All operations that return form submission data offer options to tweak the response. These include: + +- Download options lets you download any attachment linked to each particular form submissions, such as pictures and videos. It also lets you select the naming pattern, and the file size to download (if available - typically for images). +- Formatting options perform some reformatting as described in [About reformatting](#about-reformatting). + +#### About reformatting + +The default JSON format for KoboToolbox submission data is sometimes hard to deal with, because it's not schema-aware, and all fields are therefore returned as strings. + +This node provides a lightweight opinionated reformatting logic, enabled with the **Reformat?** parameter, available on all operations that return form submissions: the submission query, get, and the attachment download operations. + +When enabled, the reformatting: + +- Reorganizes the JSON into a multi-level hierarchy following the form's groups. By default, question grouping hierarchy is materialized by a `/` character in the field names, for example `Group1/Question1`. With reformatting enabled, n8n reorganizes these into `Group1.Question1`, as nested JSON objects. +- Renames fields to trim `_` (not supported by many downstream systems). +- Parses all geospatial fields (Point, Line, and Area question types) into their standard GeoJSON equivalent. +- Splits all fields matching any of the **Multiselect Mask** wildcard masks into an array. Since the multi-select fields appear as space-separated strings, they can't be guessed algorithmically, so you must provide a field naming mask. Format the masks as a comma-separated list. Lists support the `*` wildcard. +- Converts all fields matching any of the **Number Mask** wildcard masks into a JSON float. + +Here's a detailed example in JSON: + +```json +{ + "_id": 471987, + "formhub/uuid": "189436bb09a54957bfcc798e338b54d6", + "start": "2021-12-05T16:13:38.527+02:00", + "end": "2021-12-05T16:15:33.407+02:00", + "Field_Details/Field_Name": "Test Fields", + "Field_Details/Field_Location": "-1.932914 30.078211 1421 165", + "Field_Details/Field_Shape": "-1.932914 30.078211 1421 165;-1.933011 30.078085 0 0;-1.933257 30.078004 0 0;-1.933338 30.078197 0 0;-1.933107 30.078299 0 0;-1.932914 30.078211 1421 165", + "Field_Details/Crops_Grown": "maize beans avocado", + "Field_Details/Field_Size_sqm": "2300", + "__version__": "veGcULpqP6JNFKRJbbMvMs", + "meta/instanceID": "uuid:2356cbbe-c1fd-414d-85c8-84f33e92618a", + "_xform_id_string": "ajXVJpBkTD5tB4Nu9QXpgm", + "_uuid": "2356cbbe-c1fd-414d-85c8-84f33e92618a", + "_attachments": [], + "_status": "submitted_via_web", + "_geolocation": [ + -1.932914, + 30.078211 + ], + "_submission_time": "2021-12-05T14:15:44", + "_tags": [], + "_notes": [], + "_validation_status": {}, + "_submitted_by": null +} +``` + +With reformatting enabled, and the appropriate masks for multi-select and number formatting (for example, `Crops_*` and `*_sqm` respectively), n8n parses it into: + +```json +{ + "id": 471987, + "formhub": { + "uuid": "189436bb09a54957bfcc798e338b54d6" + }, + "start": "2021-12-05T16:13:38.527+02:00", + "end": "2021-12-05T16:15:33.407+02:00", + "Field_Details": { + "Field_Name": "Test Fields", + "Field_Location": { + "lat": -1.932914, + "lon": 30.078211 + }, + "Field_Shape": { + "type": "polygon", + "coordinates": [ + { + "lat": -1.932914, + "lon": 30.078211 + }, + { + "lat": -1.933011, + "lon": 30.078085 + }, + { + "lat": -1.933257, + "lon": 30.078004 + }, + { + "lat": -1.933338, + "lon": 30.078197 + }, + { + "lat": -1.933107, + "lon": 30.078299 + }, + { + "lat": -1.932914, + "lon": 30.078211 + } + ] + }, + "Crops_Grown": [ + "maize", + "beans", + "avocado" + ], + "Field_Size_sqm": 2300 + }, + "version": "veGcULpqP6JNFKRJbbMvMs", + "meta": { + "instanceID": "uuid:2356cbbe-c1fd-414d-85c8-84f33e92618a" + }, + "xform_id_string": "ajXVJpBkTD5tB4Nu9QXpgm", + "uuid": "2356cbbe-c1fd-414d-85c8-84f33e92618a", + "attachments": [], + "status": "submitted_via_web", + "geolocation": { + "lat": -1.932914, + "lon": 30.078211 + }, + "submission_time": "2021-12-05T14:15:44", + "tags": [], + "notes": [], + "validation_status": {}, + "submitted_by": null +} +``` + + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.lemlist.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Lemlist node documentation +description: Learn how to use the Lemlist node in n8n. Follow technical documentation to integrate Lemlist node into your workflows. +contentType: [integration, reference] +--- + +# Lemlist node + +Use the Lemlist node to automate work in Lemlist, and integrate Lemlist with other applications. n8n has built-in support for a wide range of Lemlist features, including getting activities, teams and campaigns, as well as creating, updating, and deleting leads. + +On this page, you'll find a list of operations the Lemlist node supports and links to more resources. + +/// note | Credentials +Refer to [Lemlist credentials](/integrations/builtin/credentials/lemlist.md) for guidance on setting up authentication. +/// + +## Operations + + + +* Activity + * Get Many: Get many activities +* Campaign + * Get Many: Get many campaigns + * Get Stats: Get campaign stats +* Enrichment + * Get: Fetches a previously completed enrichment + * Enrich Lead: Enrich a lead using an email or LinkedIn URL + * Enrich Person: Enrich a person using an email or LinkedIn URL +* Lead + * Create: Create a new lead + * Delete: Delete an existing lead + * Get: Get an existing lead + * Unsubscribe: Unsubscribe an existing lead +* Team + * Get: Get an existing team + * Get Credits: Get an existing team's credits +* Unsubscribe + * Add: Add an email to an unsubscribe list + * Delete: Delete an email from an unsubscribe list + * Get Many: Get many unsubscribed emails + + + +## Templates and examples + + +[[ templatesWidget(page.title, 'lemlist') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.line.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Line node documentation +description: Learn how to use the Line node in n8n. Follow technical documentation to integrate Line node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Line node + + +/// warning | Deprecated: End of service +LINE Notify is discontinuing service as of April 1st 2025 and this node will no longer work after that date. View LINE Notify's [end of service announement](https://notify-bot.line.me/closing-announce){:target=_blank .external-link} for more information. +/// + + +Use the Line node to automate work in Line, and integrate Line with other applications. n8n has built-in support for a wide range of Line features, including sending notifications. + +On this page, you'll find a list of operations the Line node supports and links to more resources. + +/// note | Credentials +Refer to [Line credentials](/integrations/builtin/credentials/line.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Notification + * Sends notifications to users or groups + +## Templates and examples + + +[[ templatesWidget(page.title, 'line') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.linear.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Linear node documentation +description: Learn how to use the Linear node in n8n. Follow technical documentation to integrate Linear node into your workflows. +contentType: [integration, reference] +--- + +# Linear node + +Use the Linear node to automate work in Linear, and integrate Linear with other applications. n8n has built-in support for a wide range of Linear features, including creating, updating, deleting, and getting issues. + +On this page, you'll find a list of operations the Linear node supports and links to more resources. + +/// note | Credentials +Refer to [Linear credentials](/integrations/builtin/credentials/linear.md) for guidance on setting up authentication. +/// + +## Operations + +* Issue + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'linear') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.lingvanex.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: LingvaNex node documentation +description: Learn how to use the LingvaNex node in n8n. Follow technical documentation to integrate LingvaNex node into your workflows. +contentType: [integration, reference] +--- + +# LingvaNex node + +Use the LingvaNex node to automate work in LingvaNex, and integrate LingvaNex with other applications. n8n has built-in support for translating data with LingvaNex. + +On this page, you'll find a list of operations the LingvaNex node supports and links to more resources. + +/// note | Credentials +Refer to [LingvaNex credentials](/integrations/builtin/credentials/lingvanex.md) for guidance on setting up authentication. +/// + +## Operations + +- Translate data + +## Templates and examples + + +[[ templatesWidget(page.title, 'lingvanex') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.linkedin.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: LinkedIn node documentation +description: Learn how to use the LinkedIn node in n8n. Follow technical documentation to integrate LinkedIn node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# LinkedIn node + +Use the LinkedIn node to automate work in LinkedIn, and integrate LinkedIn with other applications. n8n supports creating posts. + +On this page, you'll find a list of operations the LinkedIn node supports and links to more resources. + +/// note | Credentials +Refer to [LinkedIn credentials](/integrations/builtin/credentials/linkedin.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Post + * Create + +## Parameters + +* **Post As**: choose whether to post as a **Person** or **Organization**. +* **Person Name or ID** and **Organization URN**: enter an identifier for the person or organization. + + /// note | Posting as organization + If posting as an Organization enter the organization number in the URN field. For example, `03262013` not `urn:li:company:03262013`. + /// + +* **Text**: the post contents. +* **Media Category**: use this when including images or article URLs in your post. + +## Templates and examples + + +[[ templatesWidget(page.title, 'linkedin') ]] + +## Related resources + +Refer to [LinkedIn's API documentation](https://learn.microsoft.com/en-us/linkedin/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.lonescale.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: LoneScale node documentation +description: Learn how to use the LoneScale node in n8n. Follow technical documentation to integrate LoneScale node into your workflows. +contentType: [integration, reference] +--- + +# LoneScale node + +Use the LoneScale node to automate work in LoneScale and integrate LoneScale with other applications. n8n has built-in support for managing Lists and Items in LoneScale. + +On this page, you'll find a list of operations the LoneScale node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/lonescale.md). +/// + +## Operations + +* List + * Create +* Item + * Create + +## Templates and examples + + +[[ templatesWidget(page.title, 'lonescale') ]] + +## Related resources + +Refer to [LoneScales documentation](https://help-center.lonescale.com/en/articles/6454360-lonescale-public-api){:target=_blank .external-link} for more information about the service. + +n8n provides a trigger node for LoneScale. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.lonescaletrigger.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.magento2.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Magento 2 node documentation +description: Learn how to use the Magento 2 node in n8n. Follow technical documentation to integrate Magento 2 node into your workflows. +contentType: [integration, reference] +--- + +# Magento 2 node + +Use the Magento 2 node to automate work in Magento 2, and integrate Magento 2 with other applications. n8n has built-in support for a wide range of Magento 2 features, including creating, updating, deleting, and getting customers, invoices, orders, and projects. + +On this page, you'll find a list of operations the Magento 2 node supports and links to more resources. + +/// note | Credentials +Refer to [Magento 2 credentials](/integrations/builtin/credentials/magento2.md) for guidance on setting up authentication. +/// + +## Operations + +* Customer + * Create a new customer + * Delete a customer + * Get a customer + * Get all customers + * Update a customer +* Invoice + * Create an invoice +* Order + * Cancel an order + * Get an order + * Get all orders + * Ship an order +* Product + * Create a product + * Delete a product + * Get a product + * Get all products + * Update a product + +## Templates and examples + + +[[ templatesWidget(page.title, 'magento-2') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mailcheck.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mailcheck node documentation +description: Learn how to use the Mailcheck node in n8n. Follow technical documentation to integrate Mailcheck node into your workflows. +contentType: [integration, reference] +--- + +# Mailcheck node + +Use the Mailcheck node to automate work in Mailcheck, and integrate Mailcheck with other applications. n8n has built-in support for a wide range of Mailcheck features, including checking emails. + +On this page, you'll find a list of operations the Mailcheck node supports and links to more resources. + +/// note | Credentials +Refer to [Mailcheck credentials](/integrations/builtin/credentials/mailcheck.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Email + * Check + +## Templates and examples + + +[[ templatesWidget(page.title, 'mailcheck') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.mailchimp.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mailchimp node documentation +description: Learn how to use the Mailchimp node in n8n. Follow technical documentation to integrate Mailchimp node into your workflows. +contentType: [integration, reference] +--- + +# Mailchimp node + +Use the Mailchimp node to automate work in Mailchimp, and integrate Mailchimp with other applications. n8n has built-in support for a wide range of Mailchimp features, including creating, updating, and deleting campaigns, as well as getting list groups. + +On this page, you'll find a list of operations the Mailchimp node supports and links to more resources. + +/// note | Credentials +Refer to [Mailchimp credentials](/integrations/builtin/credentials/mailchimp.md) for guidance on setting up authentication. +/// + +## Operations + +* Campaign + * Delete a campaign + * Get a campaign + * Get all the campaigns + * Replicate a campaign + * Creates a Resend to Non-Openers version of this campaign + * Send a campaign +* List Group + * Get all groups +* Member + * Create a new member on list + * Delete a member on list + * Get a member on list + * Get all members on list + * Update a new member on list +* Member Tag + * Add tags from a list member + * Remove tags from a list member + +## Templates and examples + + +[[ templatesWidget(page.title, 'mailchimp') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mailerlite.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MailerLite node documentation +description: Learn how to use the MailerLite node in n8n. Follow technical documentation to integrate MailerLite node into your workflows. +contentType: [integration, reference] +--- + +# MailerLite node + +Use the MailerLite node to automate work in MailerLite, and integrate MailerLite with other applications. n8n has built-in support for a wide range of MailerLite features, including creating, updating, deleting, and getting subscribers. + +On this page, you'll find a list of operations the MailerLite node supports and links to more resources. + +/// note | Credentials +Refer to [MailerLite credentials](/integrations/builtin/credentials/mailerlite.md) for guidance on setting up authentication. +/// + +## Operations + +* Subscriber + * Create a new subscriber + * Get an subscriber + * Get all subscribers + * Update an subscriber + +## Templates and examples + + +[[ templatesWidget(page.title, 'mailerlite') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.mailgun.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mailgun node documentation +description: Learn how to use the Mailgun node in n8n. Follow technical documentation to integrate Mailgun node into your workflows. +contentType: [integration, reference] +--- + +# Mailgun node + +Use the Mailgun node to automate work in Mailgun, and integrate Mailgun with other applications. n8n has built-in support for sending emails with Mailgun. + +On this page, you'll find a list of operations the Mailgun node supports and links to more resources. + +/// note | Credentials +Refer to [Mailgun credentials](/integrations/builtin/credentials/mailgun.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +- Send an email + +## Templates and examples + + +[[ templatesWidget(page.title, 'mailgun') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mailjet.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mailjet node documentation +description: Learn how to use the Mailjet node in n8n. Follow technical documentation to integrate Mailjet node into your workflows. +contentType: [integration, reference] +--- + +# Mailjet node + +Use the Mailjet node to automate work in Mailjet, and integrate Mailjet with other applications. n8n has built-in support for a wide range of Mailjet features, including sending emails, and SMS. + +On this page, you'll find a list of operations the Mailjet node supports and links to more resources. + +/// note | Credentials +Refer to [Mailjet credentials](/integrations/builtin/credentials/mailjet.md) for guidance on setting up authentication. +/// + +## Operations + +* Email + * Send an email + * Send an email template +* SMS + * Send an SMS + +## Templates and examples + + +[[ templatesWidget(page.title, 'mailjet') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mandrill.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mandrill node documentation +description: Learn how to use the Mandrill node in n8n. Follow technical documentation to integrate Mandrill node into your workflows. +contentType: [integration, reference] +--- + +# Mandrill node + +Use the Mandrill node to automate work in Mandrill, and integrate Mandrill with other applications. n8n supports sending messages based on templates or HTML with Mandrill. + +On this page, you'll find a list of operations the Mandrill node supports and links to more resources. + +/// note | Credentials +Refer to [Mandrill credentials](/integrations/builtin/credentials/mandrill.md) for guidance on setting up authentication. +/// + +## Operations + +* Message + * Send message based on template. + * Send message based on HTML. + +## Templates and examples + + +[[ templatesWidget(page.title, 'mandrill') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.marketstack.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: marketstack node documentation +description: Learn how to use the marketstack node in n8n. Follow technical documentation to integrate marketstack node into your workflows. +contentType: [integration, reference] +--- + +# marketstack node + +Use the marketstack node to automate work in marketstack, and integrate marketstack with other applications. n8n has built-in support for a wide range of marketstack features, including getting exchanges, end-of-day data, and tickers. + +On this page, you'll find a list of operations the marketstack node supports and links to more resources. + +/// note | Credentials +Refer to [marketstack credentials](/integrations/builtin/credentials/marketstack.md) for guidance on setting up authentication. +/// + +## Operations + +* End-of-Day Data + * Get All +* Exchange + * Get +* Ticker + * Get + +## Templates and examples + + +[[ templatesWidget(page.title, 'marketstack') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.matrix.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Matrix node documentation +description: Learn how to use the Matrix node in n8n. Follow technical documentation to integrate Matrix node into your workflows. +contentType: [integration, reference] +--- + +# Matrix node + +Use the Matrix node to automate work in Matrix, and integrate Matrix with other applications. n8n has built-in support for a wide range of Matrix features, including getting current user's account information, sending media and messages to a room, and getting room members and messages. + +On this page, you'll find a list of operations the Matrix node supports and links to more resources. + +/// note | Credentials +Refer to [Matrix credentials](/integrations/builtin/credentials/matrix.md) for guidance on setting up authentication. +/// + +## Operations + +* Account + * Get current user's account information +* Event + * Get single event by ID +* Media + * Send media to a chat room +* Message + * Send a message to a room + * Gets all messages from a room +* Room + * New chat room with defined settings + * Invite a user to a room + * Join a new room + * Kick a user from a room + * Leave a room +* Room Member + * Get all members + +## Templates and examples + + +[[ templatesWidget(page.title, 'matrix') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.mattermost.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mattermost node documentation +description: Learn how to use the Mattermost node in n8n. Follow technical documentation to integrate Mattermost node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Mattermost node + +Use the Mattermost node to automate work in Mattermost, and integrate Mattermost with other applications. n8n has built-in support for a wide range of Mattermost features, including creating, deleting, and getting channels, and users, as well as posting messages, and adding reactions. + +On this page, you'll find a list of operations the Mattermost node supports and links to more resources. + +/// note | Credentials +Refer to [Mattermost credentials](/integrations/builtin/credentials/mattermost.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Channel + * Add a user to a channel + * Create a new channel + * Soft delete a channel + * Get a page of members for a channel + * Restores a soft deleted channel + * Search for a channel + * Get statistics for a channel +* Message + * Soft delete a post, by marking the post as deleted in the database + * Post a message into a channel + * Post an ephemeral message into a channel +* Reaction + * Add a reaction to a post. + * Remove a reaction from a post + * Get all the reactions to one or more posts +* User + * Create a new user + * Deactivates the user and revokes all its sessions by archiving its user object. + * Retrieve all users + * Get a user by email + * Get a user by ID + * Invite user to team + + +## Templates and examples + + +[[ templatesWidget(page.title, 'mattermost') ]] + +## Related resources + +Refer to [Mattermost's documentation](https://api.mattermost.com/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Channel ID field error + +If you're not the System Administrator, you might get an error: **there was a problem loading the parameter options from server: "Mattermost error response: You do not have the appropriate permissions.** next to the **Channel ID** field. + +Ask your system administrator to grant you the `post:channel` permission. + +## Find the channel ID + +To find the channel ID in Mattermost: + +1. Select the channel from the left sidebar. +2. Select the channel name at the top. +3. Select **View Info**. + + + + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.mautic.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mautic node documentation +description: Learn how to use the Mautic node in n8n. Follow technical documentation to integrate Mautic node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Mautic node + +Use the Mautic node to automate work in Mautic, and integrate Mautic with other applications. n8n has built-in support for a wide range of Mautic features, including creating, updating, deleting, and getting companies, and contacts, as well as adding and removing campaign contacts. + +On this page, you'll find a list of operations the Mautic node supports and links to more resources. + +/// note | Credentials +Refer to [Mautic credentials](/integrations/builtin/credentials/mautic.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Campaign Contact + * Add contact to a campaign + * Remove contact from a campaign +* Company + * Create a new company + * Delete a company + * Get data of a company + * Get data of all companies + * Update a company +* Company Contact + * Add contact to a company + * Remove a contact from a company +* Contact + * Create a new contact + * Delete a contact + * Edit contact's points + * Add/remove contacts from/to the don't contact list + * Get data of a contact + * Get data of all contacts + * Send email to contact + * Update a contact +* Contact Segment + * Add contact to a segment + * Remove contact from a segment +* Segment Email + * Send + +## Templates and examples + + +[[ templatesWidget(page.title, 'mautic') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.medium.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Medium node documentation +description: Learn how to use the Medium node in n8n. Follow technical documentation to integrate Medium node into your workflows. +contentType: [integration, reference] +--- + +# Medium node + +Use the Medium node to automate work in Medium, and integrate Medium with other applications. n8n has built-in support for a wide range of Medium features, including creating posts, and getting publications. + +On this page, you'll find a list of operations the Medium node supports and links to more resources. + +/// note | Credentials +Refer to [Medium credentials](/integrations/builtin/credentials/medium.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Post + * Create a post +* Publication + * Get all publications + +## Templates and examples + + +[[ templatesWidget(page.title, 'medium') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.messagebird.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MessageBird node documentation +description: Learn how to use the MessageBird node in n8n. Follow technical documentation to integrate MessageBird node into your workflows. +contentType: [integration, reference] +--- + +# MessageBird node + +Use the MessageBird node to automate work in MessageBird, and integrate MessageBird with other applications. n8n has built-in support for a wide range of MessageBird features, including sending messages, and getting balances. + +On this page, you'll find a list of operations the MessageBird node supports and links to more resources. + +/// note | Credentials +Refer to [MessageBird credentials](/integrations/builtin/credentials/messagebird.md) for guidance on setting up authentication. +/// + +## Operations + +* SMS + * Send text messages (SMS) +* Balance + * Get the balance + +## Templates and examples + + +[[ templatesWidget(page.title, 'messagebird') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.metabase.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Metabase node documentation +description: Learn how to use the Metabase node in n8n. Follow technical documentation to integrate Metabase node into your workflows. +contentType: [integration, reference] +--- + +# Metabase node + +Use the Metabase node to automate work in Metabase, and integrate Metabase with other applications. n8n has built-in support for a wide range of Metabase features, including adding, and getting alerts, databases, metrics, and questions. + +On this page, you'll find a list of operations the Metabase node supports and links to more resources. + +/// note | Credentials +Refer to [Metabase credentials](/integrations/builtin/credentials/metabase.md) for guidance on setting up authentication. +/// + +## Operations + +* Alert + * Get + * Get All +* Database + * Add + * Get All + * Get Fields +* Metric + * Get + * Get All +* Question + * Get + * Get All + * Result Data + +## Templates and examples + + +[[ templatesWidget(page.title, 'metabase') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftdynamicscrm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft Dynamics CRM node documentation +description: Learn how to use the Microsoft Dynamics CRM node in n8n. Follow technical documentation to integrate Microsoft Dynamics CRM node into your workflows. +contentType: [integration, reference] +--- + +# Microsoft Dynamics CRM node + +Use the Microsoft Dynamics CRM node to automate work in Microsoft Dynamics CRM, and integrate Microsoft Dynamics CRM with other applications. n8n has built-in support for creating, updating, deleting, and getting Microsoft Dynamics CRM accounts. + +On this page, you'll find a list of operations the Microsoft Dynamics CRM node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +## Operations + +* Account + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-dynamics-crm') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftentra.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft Entra ID node documentation +description: Learn how to use the Microsoft Entra ID node in n8n. Follow technical documentation to integrate Microsoft Entra ID node into your workflows. +contentType: [integration, reference] +--- + +# Microsoft Entra ID node + +Use the Microsoft Entra ID node to automate work in Microsoft Entra ID and integrate Microsoft Entra ID with other applications. n8n has built-in support for a wide range of Microsoft Entra ID features, which includes creating, getting, updating, and deleting users and groups, as well as adding users to and removing them from groups. + +On this page, you'll find a list of operations the Microsoft Entra ID node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/microsoftentra.md). +/// + + +## Operations + +* **Group** + * **Create**: Create a new group + * **Delete**: Delete an existing group + * **Get**: Retrieve data for a specific group + * **Get Many**: Retrieve a list of groups + * **Update**: Update a group +* **User** + * **Create**: Create a new user + * **Delete**: Delete an existing user + * **Get**: Retrieve data for a specific user + * **Get Many**: Retrieve a list of users + * **Update**: Update a user + * **Add to Group**: Add user to a group + * **Remove from Group**: Remove user from a group + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-entra-id-azure-active-directory') ]] + +## Related resources + + +Refer to [Microsoft Entra ID's documentation](https://learn.microsoft.com/en-us/graph/api/resources/identity-network-access-overview?view=graph-rest-1.0){:target=_blank .external-link} for more information about the service. + + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Common issues + +Here are some common errors and issues with the Microsoft Entra ID node and steps to resolve or troubleshoot them. + +### Updating the Allow External Senders and Auto Subscribe New Members options fails + +You can't update the **Allow External Senders** and **Auto Subscribe New Members** options directly after creating a new group. You must wait after creating a group before you can change the values of these options. + +When designing workflows that use multiple Microsoft Entra ID nodes to first create groups and then update these options, add a [Wait](/integrations/builtin/core-nodes/n8n-nodes-base.wait.md) node between the two operations. A Wait node configured to pause for at least two seconds allows time for the group to fully initialize. After the wait, the update operation can complete without erroring. + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftexcel.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft Excel 365 node documentation +description: Learn how to use the Microsoft Excel node in n8n. Follow technical documentation to integrate Microsoft Excel node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Microsoft Excel 365 node + +Use the Microsoft Excel node to automate work in Microsoft Excel, and integrate Microsoft Excel with other applications. n8n has built-in support for a wide range of Microsoft Excel features, including adding and retrieving lists of table data, and workbooks, as well as getting worksheets. + +On this page, you'll find a list of operations the Microsoft Excel node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Table + * Adds rows to the end of the table + * Retrieve a list of table columns + * Retrieve a list of table rows + * Looks for a specific column value and then returns the matching row +* Workbook + * Adds a new worksheet to the workbook. + * Get data of all workbooks +* Worksheet + * Get all worksheets + * Get worksheet content + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-excel') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftgraphsecurity.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft Graph Security node documentation +description: Learn how to use the Microsoft Graph Security node in n8n. Follow technical documentation to integrate Microsoft Graph Security node into your workflows. +contentType: [integration, reference] +--- + +# Microsoft Graph Security node + +Use the Microsoft Graph Security node to automate work in Microsoft Graph Security, and integrate Microsoft Graph Security with other applications. n8n has built-in support for a wide range of Microsoft Graph Security features, including getting, and updating scores, and profiles. + +On this page, you'll find a list of operations the Microsoft Graph Security node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +## Operations + +* Secure Score + * Get + * Get All +* Secure Score Control Profile + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-graph-security') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftonedrive.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft OneDrive node documentation +description: Learn how to use the Microsoft OneDrive node in n8n. Follow technical documentation to integrate Microsoft OneDrive node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Microsoft OneDrive node + +Use the Microsoft OneDrive node to automate work in Microsoft OneDrive, and integrate Microsoft OneDrive with other applications. n8n has built-in support for a wide range of Microsoft OneDrive features, including creating, updating, deleting, and getting files, and folders. + +On this page, you'll find a list of operations the Microsoft OneDrive node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* File + * Copy a file + * Delete a file + * Download a file + * Get a file + * Rename a file + * Search a file + * Share a file + * Upload a file up to 4MB in size +* Folder + * Create a folder + * Delete a folder + * Get Children (get items inside a folder) + * Rename a folder + * Search a folder + * Share a folder + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-onedrive') ]] + +## Related resources + +Refer to [Microsoft's OneDrive API documentation](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/){:target=_blank .external-link} for more information about the service. + +## Find the folder ID + +To perform operations on folders, you need to supply the ID. You can find this: + +* In the URL of the folder +* By searching for it using the node. You need to do this if using MS 365 (where OneDrive uses SharePoint behind the scenes): + 1. Select **Resource** > **Folder**. + 2. Select **Operation** > **Search**. + 3. In **Query**, enter the folder name. + 4. Select **Execute step**. n8n runs the query and returns data about the folder, including an `id` field containing the folder ID. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftoutlook.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft Outlook node documentation +description: Learn how to use the Microsoft Outlook node in n8n. Follow technical documentation to integrate Microsoft Outlook node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Microsoft Outlook node + +Use the Microsoft Outlook node to automate work in Microsoft Outlook, and integrate Microsoft Outlook with other applications. n8n has built-in support for a wide range of Microsoft Outlook features, including creating, updating, deleting, and getting folders, messages, and drafts. + +On this page, you'll find a list of operations the Microsoft Outlook node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Calendar + * Create + * Delete + * Get + * Get Many + * Update +* Contact + * Create + * Delete + * Get + * Get Many + * Update +* Draft + * Create + * Delete + * Get + * Send + * Update +* Event + * Create + * Delete + * Get + * Get Many + * Update +* Folder + * Create + * Delete + * Get + * Get Many + * Update +* Folder Message + * Get Many +* Message + * Delete + * Get + * Get Many + * Move + * Reply + * Send + * Send and Wait for Response + * Update +* Message Attachment + * Add + * Download + * Get + * Get Many + +--8<-- "_snippets/integrations/builtin/send-and-wait-operation.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-outlook') ]] + +## Related resources + +Refer to [Outlook's API documentation](https://learn.microsoft.com/en-us/outlook/rest/get-started){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftsharepoint.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft SharePoint node documentation +description: Learn how to use the Microsoft SharePoint node in n8n. Follow technical documentation to integrate Microsoft SharePoint node into your workflows. +contentType: [integration, reference] +--- + +# Microsoft SharePoint node + +Use the Microsoft SharePoint node to automate work in Microsoft SharePoint and integrate Microsoft SharePoint with other applications. n8n has built-in support for a wide range of Microsoft SharePoint features, which includes downloading, uploading, and updating files, managing items in a list, and getting lists and list items. + +On this page, you'll find a list of operations the Microsoft SharePoint node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/microsoft.md). +/// + + +## Operations + + + +* **File**: + * Download: Download a file. + * Update: Update a file. + * Upload: Upload an existing file. +* **Item**: + * Create: Create an item in an existing list. + * Create or Update: Create a new item, or update the current one if it already exists (upsert). + * Delete: Delete an item from a list. + * Get: Retrieve an item from a list. + * Get Many: Get specific items in a list or list many items. + * Update: Update an item in an existing list. +* **List**: + * Get: Retrieve details of a single list. + * Get Many: Retrieve a list of lists. + + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-sharepoint') ]] + +## Related resources + + +Refer to [Microsoft's SharePoint documentation](https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service) for more information about the service. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftsql.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft SQL node documentation +description: Learn how to use the Microsoft SQL node in n8n. Follow technical documentation to integrate Microsoft SQL node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Microsoft SQL node + +Use the Microsoft SQL node to automate work in Microsoft SQL, and integrate Microsoft SQL with other applications. n8n has built-in support for a wide range of Microsoft SQL features, including executing SQL queries, and inserting rows into the database. + +On this page, you'll find a list of operations the Microsoft SQL node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft SQL credentials](/integrations/builtin/credentials/microsoftsql.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Execute an SQL query +* Insert rows in database +* Update rows in database +* Delete rows in database + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-sql') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsoftteams.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft Teams node documentation +description: Learn how to use the Microsoft Teams node in n8n. Follow technical documentation to integrate Microsoft Teams node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Microsoft Teams node + +Use the Microsoft Teams node to automate work in Microsoft Teams, and integrate Microsoft Teams with other applications. n8n has built-in support for a wide range of Microsoft Teams features, including creating and deleting, channels, messages, and tasks. + +On this page, you'll find a list of operations the Microsoft Teams node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Channel + * Create + * Delete + * Get + * Get Many + * Update +* Channel Message + * Create + * Get Many +* Chat Message + * Create + * Get + * Get Many + * Send and Wait for Response +* Task + * Create + * Delete + * Get + * Get Many + * Update + +--8<-- "_snippets/integrations/builtin/send-and-wait-operation.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-teams') ]] + +## Related resources + +Refer to [Microsoft Teams' API documentation](https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.microsofttodo.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Microsoft To Do node documentation +description: Learn how to use the Microsoft To Do node in n8n. Follow technical documentation to integrate Microsoft To Do node into your workflows. +contentType: [integration, reference] +--- + +# Microsoft To Do node + +Use the Microsoft To Do node to automate work in Microsoft To Do, and integrate Microsoft To Do with other applications. n8n has built-in support for a wide range of Microsoft To Do features, including creating, updating, deleting, and getting linked resources, lists, and tasks. + +On this page, you'll find a list of operations the Microsoft To Do node supports and links to more resources. + +/// note | Credentials +Refer to [Microsoft credentials](/integrations/builtin/credentials/microsoft.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Linked Resource + * Create + * Delete + * Get + * Get All + * Update +* List + * Create + * Delete + * Get + * Get All + * Update +* Task + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'microsoft-to-do') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mindee.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mindee node documentation +description: Learn how to use the Mindee node in n8n. Follow technical documentation to integrate Mindee node into your workflows. +contentType: [integration, reference] +--- + +# Mindee node + +Use the Mindee node to automate work in Mindee, and integrate Mindee with other applications. n8n has built-in support for a wide range of Mindee features, including predicting invoices. + +On this page, you'll find a list of operations the Mindee node supports and links to more resources. + +/// note | Credentials +Refer to [Mindee credentials](/integrations/builtin/credentials/mindee.md) for guidance on setting up authentication. +/// + +## Operations + +- **Invoice** + - Predict +- **Receipt** + - Predict + +## Templates and examples + + +[[ templatesWidget(page.title, 'mindee') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.misp.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MISP node documentation +description: Learn how to use the MISP node in n8n. Follow technical documentation to integrate MISP node into your workflows. +contentType: [integration, reference] +--- + +# MISP node + +Use the MISP node to automate work in MISP, and integrate MISP with other applications. n8n has built-in support for a wide range of MISP features, including creating, updating, deleting and getting events, feeds, and organizations. + +On this page, you'll find a list of operations the MISP node supports and links to more resources. + +/// note | Credentials +Refer to [MISP credentials](/integrations/builtin/credentials/misp.md) for guidance on setting up authentication. +/// + +## Operations + +* Attribute + * Create + * Delete + * Get + * Get All + * Search + * Update +* Event + * Create + * Delete + * Get + * Get All + * Publish + * Search + * Unpublish + * Update +* Event Tag + * Add + * Remove +* Feed + * Create + * Disable + * Enable + * Get + * Get All + * Update +* Galaxy + * Delete + * Get + * Get All +* Noticelist + * Get + * Get All +* Object + * Search +* Organisation + * Create + * Delete + * Get + * Get All + * Update +* Tag + * Create + * Delete + * Get All + * Update +* User + * Create + * Delete + * Get + * Get All + * Update +* Warninglist + * Get + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'misp') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mocean.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mocean node documentation +description: Learn how to use the Mocean node in n8n. Follow technical documentation to integrate Mocean node into your workflows. +contentType: [integration, reference] +--- + +# Mocean node + +Use the Mocean node to automate work in Mocean, and integrate Mocean with other applications. n8n has built-in support for a wide range of Mocean features, including sending SMS, and voice messages. + +On this page, you'll find a list of operations the Mocean node supports and links to more resources. + +/// note | Credentials +Refer to [Mocean credentials](/integrations/builtin/credentials/mocean.md) for guidance on setting up authentication. +/// + +## Operations + +* SMS + * Send SMS/Voice message +* Voice + * Send SMS/Voice message + +## Templates and examples + + +[[ templatesWidget(page.title, 'mocean') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.mondaycom.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: monday.com node documentation +description: Learn how to use the monday.com node in n8n. Follow technical documentation to integrate monday.com node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# monday.com node + +Use the monday.com node to automate work in monday.com, and integrate monday.com with other applications. n8n has built-in support for a wide range of monday.com features, including creating a new board, and adding, deleting, and getting items on the board. + +On this page, you'll find a list of operations the monday.com node supports and links to more resources. + +/// warning | Minimum required version +This node requires n8n version 1.22.6 or above. +/// + +/// note | Credentials +Refer to [monday.com credentials](/integrations/builtin/credentials/mondaycom.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Board + * Archive a board + * Create a new board + * Get a board + * Get all boards +* Board Column + * Create a new column + * Get all columns +* Board Group + * Delete a group in a board + * Create a group in a board + * Get list of groups in a board +* Board Item + * Add an update to an item. + * Change a column value for a board item + * Change multiple column values for a board item + * Create an item in a board's group + * Delete an item + * Get an item + * Get all items + * Get items by column value + * Move item to group + +## Templates and examples + + +[[ templatesWidget(page.title, 'mondaycom') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.mongodb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MongoDB node documentation +description: Learn how to use the MongoDB node in n8n. Follow technical documentation to integrate MongoDB node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# MongoDB node + +Use the MongoDB node to automate work in MongoDB, and integrate MongoDB with other applications. n8n has built-in support for a wide range of MongoDB features, including aggregating, updating, finding, deleting, and getting documents. + +On this page, you'll find a list of operations the MongoDB node supports and links to more resources. + +/// note | Credentials +Refer to [MongoDB credentials](/integrations/builtin/credentials/mongodb.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Aggregate documents +* Delete documents +* Find documents +* Find and replace documents +* Find and update documents +* Insert documents +* Update documents + +## Templates and examples + + +[[ templatesWidget(page.title, 'mongodb') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.monicacrm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Monica CRM node documentation +description: Learn how to use the Monica CRM node in n8n. Follow technical documentation to integrate Monica CRM node into your workflows. +contentType: [integration, reference] +--- + +# Monica CRM node + +Use the Monica CRM node to automate work in Monica CRM, and integrate Monica CRM with other applications. n8n has built-in support for a wide range of Monica CRM features, including creating, updating, deleting, and getting activities, calls, contracts, messages, tasks, and notes. + +On this page, you'll find a list of operations the Monica CRM node supports and links to more resources. + +/// note | Credentials +Refer to [Monica CRM credentials](/integrations/builtin/credentials/monicacrm.md) for guidance on setting up authentication. +/// + +## Operations + +* Activity + * Create an activity + * Delete an activity + * Retrieve an activity + * Retrieve all activities + * Update an activity +* Call + * Create a call + * Delete a call + * Retrieve a call + * Retrieve all calls + * Update a call +* Contact + * Create a contact + * Delete a contact + * Retrieve a contact + * Retrieve all contacts + * Update a contact +* Contact Field + * Create a contact field + * Delete a contact field + * Retrieve a contact field + * Update a contact field +* Contact Tag + * Add + * Remove +* Conversation + * Create a conversation + * Delete a conversation + * Retrieve a conversation + * Update a conversation +* Conversation Message + * Add a message to a conversation + * Update a message in a conversation +* Journal Entry + * Create a journal entry + * Delete a journal entry + * Retrieve a journal entry + * Retrieve all journal entries + * Update a journal entry +* Note + * Create a note + * Delete a note + * Retrieve a note + * Retrieve all notes + * Update a note +* Reminder + * Create a reminder + * Delete a reminder + * Retrieve a reminder + * Retrieve all reminders + * Update a reminder +* Tag + * Create a tag + * Delete a tag + * Retrieve a tag + * Retrieve all tags + * Update a tag +* Task + * Create a task + * Delete a task + * Retrieve a task + * Retrieve all tasks + * Update a task + +## Templates and examples + + +[[ templatesWidget(page.title, 'monica-crm') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.mqtt.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MQTT node documentation +description: Learn how to use the MQTT node in n8n. Follow technical documentation to integrate MQTT node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# MQTT node + +Use the MQTT node to automate work in MQTT, and integrate MQTT with other applications. n8n supports transporting messages with MQTT. + +On this page, you'll find a list of operations the MQTT node supports and links to more resources. + +/// note | Credentials +Refer to [MQTT credentials](/integrations/builtin/credentials/mqtt.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +Use the MQTT node to send a message. You can set the message topic, and choose whether to send the node input data as part of the message. + +## Templates and examples + + +[[ templatesWidget(page.title, 'mqtt') ]] + +## Related resources + +n8n provides a trigger node for MQTT. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.mqtttrigger.md). + +Refer to [MQTT's documentation](https://mqtt.org/getting-started/){:target=_blank .external-link} for more information about the service. + + +# integrations/builtin/app-nodes/n8n-nodes-base.msg91.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MSG91 node documentation +description: Learn how to use the MSG91 node in n8n. Follow technical documentation to integrate MSG91 node into your workflows. +contentType: [integration, reference] +--- + +# MSG91 node + +Use the MSG91 node to automate work in MSG91, and integrate MSG91 with other applications. n8n supports sending SMS with MSG91. + +On this page, you'll find a list of operations the MSG91 node supports and links to more resources. + +/// note | Credentials +Refer to [MSG91 credentials](/integrations/builtin/credentials/msg91.md) for guidance on setting up authentication. +/// + +## Operations + +* SMS + * Send SMS + +## Templates and examples + + +[[ templatesWidget(page.title, 'msg91') ]] + +## Find your Sender ID + +1. Log in to your MSG91 dashboard. +2. Select **Sender Id** in the left panel. +3. If you don't already have one, select **Add Sender Id +**, fill in the details, and select **Save Sender Id**. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.mysql/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MySQL node common issues +description: Documentation for common issues and questions in the MySQL node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# MySQL node common issues + +Here are some common errors and issues with the [MySQL node](/integrations/builtin/app-nodes/n8n-nodes-base.mysql/index.md) and steps to resolve or troubleshoot them. + +## Update rows by composite key + +The MySQL node's **Update** operation lets you to update rows in a table by providing a **Column to Match On** and a value. This works for tables where single column values can uniquely identify individual rows. + +You can't use this pattern for tables that use [composite keys](https://en.wikipedia.org/wiki/Composite_key), where you need multiple columns to uniquely identify a row. A example of this is MySQL's [`user` table](https://mariadb.com/kb/en/mysql-user-table/) in the `mysql` database, where you need both the `user` and `host` columns to uniquely identify rows. + +To update tables with composite keys, write the query manually with the **Execute SQL** operation instead. There, you can match on multiple values, like in this example which matches on both `customer_id` and `product_id`: + +```sql +UPDATE orders SET quantity = 3 WHERE customer_id = 538 AND product_id = 800; +``` + +## Can't connect to a local MySQL server when using Docker + +When you run either n8n or MySQL in Docker, you need to configure the network so that n8n can connect to MySQL. + +The solution depends on how you're hosting the two components. + +### If only MySQL is in Docker + +If only MySQL is running in Docker, configure MySQL to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official images are already configured this way). + +When running the container, [publish the port](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/) with the `-p` flag. By default, MySQL runs on port 3306, so your Docker command should look like this: + +```shell +docker run -p 3306:3306 --name my-mysql -d mysql:latest +``` + +When configuring [MySQL credentials](/integrations/builtin/credentials/mysql.md), the `localhost` address should work without a problem (set the **Host** to `localhost`). + +### If only n8n is in Docker + +If only n8n is running in Docker, configure MySQL to listen on all interfaces by binding to `0.0.0.0` on the host. + +If you are running n8n in Docker on **Linux**, use the `--add-host` flag to map `host.docker.internal` to `host-gateway` when you start the container. For example: + +```shell +docker run -it --rm --add-host host.docker.internal:host-gateway --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n +``` + +If you are using Docker Desktop, this is automatically configured for you. + +When configuring [MySQL credentials](/integrations/builtin/credentials/mysql.md), use `host.docker.internal` as the **Host** address instead of `localhost`. + +### If MySQL and n8n are running in separate Docker containers + +If both n8n and MySQL are running in Docker in separate containers, you can use Docker networking to connect them. + +Configure MySQL to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official images are already configured this way). Add both the MySQL and n8n containers to the same [user-defined bridge network](https://docs.docker.com/engine/network/drivers/bridge/). + +When configuring [MySQL credentials](/integrations/builtin/credentials/mysql.md), use the MySQL container's name as the host address instead of `localhost`. For example, if you call the MySQL container `my-mysql`, you would set the **Host** to `my-mysql`. + +### If MySQL and n8n are running in the same Docker container + +If MySQL and n8n are running in the same Docker container, the `localhost` address doesn't need any special configuration. You can configure MySQL to listen on `localhost` and configure the **Host** in the [MySQL credentials in n8n](/integrations/builtin/credentials/ollama.md) to use `localhost`. + +## Decimal numbers returned as strings + +By default, the MySQL node returns [`DECIMAL` values](https://dev.mysql.com/doc/refman/8.4/en/fixed-point-types.html) as strings. This is done intentionally to avoid loss of precision that can occur due to limitation with the way JavaScript represents numbers. You can learn more about the decision in the documentation for the [MySQL library](https://sidorares.github.io/node-mysql2/docs/api-and-configurations) that n8n uses. + +To output decimal values as numbers instead of strings and ignore the risks in loss of precision, enable the **Output Decimals as Numbers** option. This will output the values as numbers instead of strings. + +As an alternative, you can manually convert from the string to a decimal using the [`toFloat()` function](/code/builtin/data-transformation-functions/strings.md#string-toFloat) with [`toFixed()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed) or with the [Edit Fields (Set) node](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) after the MySQL node. Be aware that you may still need to account for a potential loss of precision. + + +# integrations/builtin/app-nodes/n8n-nodes-base.mysql/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MySQL node documentation +description: Learn how to use the MySQL node in n8n. Follow technical documentation to integrate MySQL node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# MySQL node + +Use the MySQL node to automate work in MySQL, and integrate MySQL with other applications. n8n has built-in support for a wide range of MySQL features, including executing an SQL query, as well as inserting, and updating rows in a database. + +On this page, you'll find a list of operations the MySQL node supports and links to more resources. + +/// note | Credentials +Refer to [MySQL credentials](/integrations/builtin/credentials/mysql.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Delete +* Execute SQL +* Insert +* Insert or Update +* Select +* Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'mysql') ]] + +## Related resources + +Refer to [MySQL's Connectors and APIs documentation](https://dev.mysql.com/doc/index-connectors.html){:target=_blank .external-link} for more information about the service. + +Refer to MySQL's [SELECT statement documentation](https://dev.mysql.com/doc/refman/8.4/en/select.html){:target=_blank .external-link} for more information on writing SQL queries. + +## Use query parameters + +When creating a query to run on a MySQL database, you can use the **Query Parameters** field in the **Options** section to load data into the query. n8n sanitizes data in query parameters, which prevents SQL injection. + +For example, you want to find a person by their email address. Given the following input data: + +```js +[ + { + "email": "alex@example.com", + "name": "Alex", + "age": 21 + }, + { + "email": "jamie@example.com", + "name": "Jamie", + "age": 33 + } +] +``` + +You can write a query like: + +```sql +SELECT * FROM $1:name WHERE email = $2; +``` + +Then in **Query Parameters**, provide the field values to use. You can provide fixed values or expressions. For this example, use expressions so the node can pull the email address from each input item in turn: + +```js +// users is an example table name +users, {{ $json.email }} +``` + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.mysql/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.n8ntrainingcustomerdatastore.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Customer Datastore (n8n Training) node documentation +description: Learn how to use the Customer Datastore (n8n Training) node in n8n. Follow technical documentation to integrate Customer Datastore (n8n Training) node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Customer Datastore (n8n Training) node + +Use this node only for the n8n new user onboarding tutorial. It provides dummy data for testing purposes and has no further functionality. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.n8ntrainingcustomermessenger.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Customer Messenger (n8n Training) node documentation +description: Learn how to use the Customer Messenger (n8n Training) node in n8n. Follow technical documentation to integrate Customer Messenger (n8n Training) node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Customer Messenger (n8n Training) node + +Use this node only for the n8n new user onboarding tutorial. It provides no further functionality. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.nasa.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: NASA node documentation +description: Learn how to use the NASA node in n8n. Follow technical documentation to integrate NASA node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# NASA node + +Use the NASA node to automate work in NASA, and integrate NASA with other applications. n8n has built-in support for a wide range of NASA features, including retrieving imagery and data. + +On this page, you'll find a list of operations the NASA node supports and links to more resources. + +/// note | Credentials +Refer to [NASA credentials](/integrations/builtin/credentials/nasa.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Astronomy Picture of the Day + * Get the Astronomy Picture of the Day +* Asteroid Neo-Feed + * Retrieve a list of asteroids based on their closest approach date to Earth +* Asteroid Neo-Lookup + * Look up an asteroid based on its NASA SPK-ID +* Asteroid Neo-Browse + * Browse the overall asteroid dataset +* DONKI Coronal Mass Ejection + * Retrieve DONKI coronal mass ejection data +* DONKI Interplanetary Shock + * Retrieve DONKI interplanetary shock data +* DONKI Solar Flare + * Retrieve DONKI solar flare data +* DONKI Solar Energetic Particle + * Retrieve DONKI solar energetic particle data +* DONKI Magnetopause Crossing + * Retrieve data on DONKI magnetopause crossings +* DONKI Radiation Belt Enhancement + * Retrieve DONKI radiation belt enhancement data +* DONKI High Speed Stream + * Retrieve DONKI high speed stream data +* DONKI WSA+EnlilSimulation + * Retrieve DONKI WSA+EnlilSimulation data +* DONKI Notifications + * Retrieve DONKI notifications data +* Earth Imagery + * Retrieve Earth imagery +* Earth Assets + * Retrieve Earth assets + +## Templates and examples + + +[[ templatesWidget(page.title, 'nasa') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.netlify.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Netlify node documentation +description: Learn how to use the Netlify node in n8n. Follow technical documentation to integrate Netlify node into your workflows. +contentType: [integration, reference] +--- + +# Netlify node + +Use the Netlify node to automate work in Netlify, and integrate Netlify with other applications. n8n has built-in support for a wide range of Netlify features, including getting and cancelling deployments, as well as deleting, and getting sites. + +On this page, you'll find a list of operations the Netlify node supports and links to more resources. + +/// note | Credentials +Refer to [Netlify credentials](/integrations/builtin/credentials/netlify.md) for guidance on setting up authentication. +/// + +## Operations + +* Deploy + * Cancel a deployment + * Create a new deployment + * Get a deployment + * Get all deployments +* Site + * Delete a site + * Get a site + * Returns all sites + +## Templates and examples + + +[[ templatesWidget(page.title, 'netlify') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.netscaleradc.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Netscaler ADC node documentation +description: Learn how to use the Netscaler ADC node in n8n. Follow technical documentation to integrate Netscaler ADC node into your workflows. +contentType: [integration, reference] +--- + +# Netscaler ADC node + +Use the Netscaler ADC node to automate work in Netscaler ADC, and integrate Netscaler ADC with other applications. n8n has built-in support for a wide range of Netscaler ADC features, including creating and installing certificates and files. + +On this page, you'll find a list of operations the Netscaler ADC node supports and links to more resources. + +/// note | Credentials +Refer to [Netscaler ADC credentials](/integrations/builtin/credentials/netscaleradc.md) for guidance on setting up authentication. +/// + +## Operations + +* Certificate + * Create + * Install +* File + * Delete + * Download + * Upload + +## Templates and examples + + +[[ templatesWidget(page.title, 'netscaler-adc') ]] + +## Related resources + +Refer to [Netscaler ADC's documentation](https://docs.citrix.com/en-us/citrix-adc/current-release/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.nextcloud.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Nextcloud node documentation +description: Learn how to use the Nextcloud node in n8n. Follow technical documentation to integrate Nextcloud node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Nextcloud node + +Use the Nextcloud node to automate work in Nextcloud, and integrate Nextcloud with other applications. n8n has built-in support for a wide range of Nextcloud features, including creating, updating, deleting, and getting files, and folders as well as retrieving, and inviting users. + +On this page, you'll find a list of operations the Nextcloud node supports and links to more resources. + +/// note | Credentials +Refer to [Nextcloud credentials](/integrations/builtin/credentials/nextcloud.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* File + * Copy a file + * Delete a file + * Download a file + * Move a file + * Share a file + * Upload a file +* Folder + * Copy a folder + * Create a folder + * Delete a folder + * Return the contents of a given folder + * Move a folder + * Share a folder +* User + * Invite a user to a Nextcloud organization + * Delete a user. + * Retrieve information about a single user. + * Retrieve a list of users. + * Edit attributes related to a user. + +## Templates and examples + + +[[ templatesWidget(page.title, 'nextcloud') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.nocodb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: NocoDB node documentation +description: Learn how to use the NocoDB node in n8n. Follow technical documentation to integrate NocoDB node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# NocoDB node + +Use the NocoDB node to automate work in NocoDB, and integrate NocoDB with other applications. n8n has built-in support for a wide range of NocoDB features, including creating, updating, deleting, and retrieving rows. + +On this page, you'll find a list of operations the NocoDB node supports and links to more resources. + +/// note | Credentials +Refer to [NocoDB credentials](/integrations/builtin/credentials/nocodb.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Row + * Create + * Delete + * Get + * Get Many + * Update a row + +## Templates and examples + + +[[ templatesWidget(page.title, 'nocodb') ]] + +## Relates resources + +Refer to [NocoDB's documentation](https://docs.nocodb.com/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Notion node common issues +description: Documentation for common issues and questions in the Notion node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Notion node common issues + +Here are some common errors and issues with the [Notion node](/integrations/builtin/app-nodes/n8n-nodes-base.notion/index.md) and steps to resolve or troubleshoot them. + +## Relation property not displaying + +The Notion node only supports displaying the data relation property for [two-way relations](https://www.notion.com/help/relations-and-rollups). When you connect two Notion databases with a two-way relationship, you can select or filter by the relation property when working with the Notion node's **Database Page** resource. + +To enable two-way relations, edit the relation property in Notion and enable the **Show on [name of related database]** option to create a reverse relation. Select a name to use for the relation in the new context. The relation is now accessible in n8n when filtering or selecting. + +If you need to work with Notion databases with one-way relationship, you can use the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) with your existing Notion credentials. For example, to update a one-way relationship, you can send a `PATCH` request to the following URL: + +``` +https://api.notion.com/v1/pages/ +``` + +Enable **Send Body**, set the **Body Content Type** to **JSON**, and set **Specify Body** to **Using JSON**. Afterward, you can enter a JSON object like the following into the **JSON** field: + +```json +{ + "properties": { + "Account": { + "relation": [ + { + "id": "" + } + ] + } + } +} +``` + +## Create toggle heading + +The Notion node allows you to create headings and toggles when adding blocks to **Page**, **Database Page**, or **Block** resources. Creating toggleable headings isn't yet supported by the Notion node itself. + +You can work around this be creating a regular heading and then modifying it to enable the [`is_toggleable` property](https://developers.notion.com/reference/block#headings): + +1. Add a heading with Notion node. +2. Select the resource you want to add a heading to: + * To add a new page with a heading, select the **Page** or **Database Page** resources with the **Create** operation. + * To add a heading to an existing page, select the **Block** resource with the **Append After** operation. +3. Select **Add Block** and set the **Type Name or ID** to either **Heading 1**, **Heading 2**, or **Heading 3**. +4. Add an [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node connected to the Notion node and select the `GET` method. +5. Set the **URL** to `https://api.notion.com/v1/blocks/`. For example, if your added the heading to an existing page, you could use the following URL: `https://api.notion.com/v1/blocks/{{ $json.results[0].id }}`. If you created a new page instead of appending a block, you may need to discover the block ID by querying the page contents first. +6. Select **Predefined Credential Type** and connect your existing Notion credentials. +7. Add an [Edit Fields (Set)](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node after the HTTP Request node. +8. Add `heading_1.is_toggleable` as a new **Boolean** field set to `true`. Swap `heading_1` for a different heading number as necessary. +9. Add a second HTTP Request node after the Edit Fields (Set) node. +10. Set the **Method** to `PATCH` and use `https://api.notion.com/v1/blocks/{{ $json.id }}` as the **URL** value. +11. Select **Predefined Credential Type** and connect your existing Notion credentials. +12. Enable **Send Body** and set a parameter. +13. Set the parameter **Name** to `heading_1` (substitute `heading_1` for the heading level you are using). +14. Set the parameter **Value** to `{{ $json.heading_1 }}` (substitute `heading_1` for the heading level you are using). + +The above sequence will create a regular heading block. It will query the newly created header, add the `is_toggleable` property, and update the heading block. + +## Handle null and empty values + +You may receive a validation error when working with the Notion node if you submit fields with empty or null values. This can occur any time you populate fields from previous nodes when that data is missing. + +To work around this, check for the existence of the field data before sending it to Notion or use a default value. + +To check for the data before executing the Notion node, use an [If](/integrations/builtin/core-nodes/n8n-nodes-base.if.md) node to check whether the field is unset. This allows you to use the [Edit Fields (Set)](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node to conditionally remove the field when it doesn't have a valid value. + +As an alternative, you can set a [default value](/code/cookbook/expressions/check-incoming-data.md) if the incoming data doesn't provide one. + + +# integrations/builtin/app-nodes/n8n-nodes-base.notion/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Notion node documentation +description: Learn how to use the Notion node in n8n. Follow technical documentation to integrate Notion node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Notion node + +Use the Notion node to automate work in Notion, and integrate Notion with other applications. n8n has built-in support for a wide range of Notion features, including getting and searching databases, creating pages, and getting users. + +On this page, you'll find a list of operations the Notion node supports and links to more resources. + +/// note | Credentials +Refer to [Notion credentials](/integrations/builtin/credentials/notion.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Block + * Append After + * Get Child Blocks +* Database + * Get + * Get Many + * Search +* Database Page + * Create + * Get + * Get Many + * Update +* Page + * Archive + * Create + * Search +* User + * Get + * Get Many + +## Templates and examples + + +[[ templatesWidget(page.title, 'notion') ]] + +## Related resources + +n8n provides an app node for Notion. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.notiontrigger.md). + +Refer to [Notion's documentation](https://developers.notion.com/){:target=_blank .external-link} for details about their API. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.notion/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.npm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: npm node documentation +description: Learn how to use the npm node in n8n. Follow technical documentation to integrate npm node into your workflows. +contentType: [integration, reference] +--- + +# npm node + +Use the npm node to automate work in npm, and integrate npm with other applications. + +On this page, you'll find a list of operations the npm node supports and links to more resources. + +/// note | Credentials +Refer to [npm credentials](/integrations/builtin/credentials/npm.md) for guidance on setting up authentication. +/// + +## Operations + +* Package + * Get Package Metadata + * Get Package Versions + * Search for Packages +* Distribution Tag + * Get All Tags + * Update a Tag + +## Templates and examples + + +[[ templatesWidget(page.title, 'npm') ]] + +## Related resources + +Refer to [npm's documentation](https://docs.npmjs.com/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.odoo.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Odoo node documentation +description: Learn how to use the Odoo node in n8n. Follow technical documentation to integrate Odoo node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Odoo node + +Use the Odoo node to automate work in Odoo, and integrate Odoo with other applications. n8n has built-in support for a wide range of Odoo features, including creating, updating, deleting, and getting contracts, resources, and opportunities. + +On this page, you'll find a list of operations the Odoo node supports and links to more resources. + +/// note | Credentials +Refer to [Odoo credentials](/integrations/builtin/credentials/odoo.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Contact + * Create a new contact + * Delete a contact + * Get a contact + * Get all contacts + * Update a contact +* Custom Resource + * Create a new item + * Delete an item + * Get an item + * Get all items + * Update an item +* Note + * Create a new note + * Delete a note + * Get a note + * Get all notes + * Update a note +* Opportunity + * Create a new opportunity + * Delete an opportunity + * Get an opportunity + * Get all opportunities + * Update an opportunity + +## Templates and examples + + +[[ templatesWidget(page.title, 'odoo') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.okta.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Okta node documentation +description: Learn how to use the Okta node in n8n. Follow technical documentation to integrate Okta node into your workflows. +contentType: [integration, reference] +--- + +# Okta node + +Use the Okta node to automate work in Okta and integrate Okta with other applications. n8n has built-in support for a wide range of Okta features, which includes creating, updating, and deleting users. + +On this page, you'll find a list of operations the Okta node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/okta.md). +/// + +## Operations + +- User + - Create a new user + - Delete an existing user + - Get details of a user + - Get many users + - Update an existing user + +## Templates and examples + + +[[ templatesWidget(page.title, okta) ]] + +## Related resources + + +Refer to [Okta's documentation](https://developer.okta.com/docs/guides/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +# integrations/builtin/app-nodes/n8n-nodes-base.onesimpleapi.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: One Simple API node documentation +description: Learn how to use the One Simple API node in n8n. Follow technical documentation to integrate One Simple API node into your workflows. +contentType: [integration, reference] +--- + + +# One Simple API node + +Use the One Simple API node to automate work in One Simple API, and integrate One Simple API with other applications. n8n has built-in support for a wide range of One Simple API features, including getting profiles, retrieving information, and generating utilities. + +On this page, you'll find a list of operations the One Simple API node supports and links to more resources. + +/// note | Credentials +Refer to [One Simple API credentials](/integrations/builtin/credentials/onesimpleapi.md) for guidance on setting up authentication. +/// + +## Operations + +* Information + * Convert a value between currencies + * Retrieve image metadata from a URL +* Social Profile + * Get details about an Instagram profile + * Get details about a Spotify Artist +* Utility + * Expand a shortened url + * Generate a QR Code + * Validate an email address +* Website + * Generate a PDF from a webpage + * Get SEO information from website + * Create a screenshot from a webpage + +## Templates and examples + + +[[ templatesWidget(page.title, 'one-simple-api') ]] + +## Related resources + +Refer to [One Simple API's documentation](https://onesimpleapi.com/docs){:target=_blank .external-link} for more information about the service. + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.onfleet.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Onfleet node documentation +description: Learn how to use the Onfleet node in n8n. Follow technical documentation to integrate Onfleet node into your workflows. +contentType: [integration, reference] +--- + +# Onfleet node + +Use the Onfleet node to automate work in Onfleet, and integrate Onfleet with other applications. n8n has built-in support for a wide range of Onfleet features, including creating and deleting tasks in Onfleet as well as retrieving organizations' details. + +On this page, you'll find a list of operations the Onfleet node supports and links to more resources. + +/// note | Credentials +Refer to [Onfleet credentials](/integrations/builtin/credentials/onfleet.md) for guidance on setting up authentication. +/// + +## Operations + +* Admin + * Create a new Onfleet admin + * Delete an Onfleet admin + * Get all Onfleet admins + * Update an Onfleet admin +* Container + * Add task at index (or append) + * Get container information + * Fully replace a container's tasks +* Destination + * Create a new destination + * Get a specific destination +* Hub + * Create a new Onfleet hub + * Get all Onfleet hubs + * Update an Onfleet hub +* Organization + * Retrieve your own organization's details + * Retrieve the details of an organization with which you are connected +* Recipient + * Create a new Onfleet recipient + * Get a specific Onfleet recipient + * Update an Onfleet recipient +* Task + * Create a new Onfleet task + * Clone an Onfleet task + * Force-complete a started Onfleet task + * Delete an Onfleet task + * Get all Onfleet tasks + * Get a specific Onfleet task + * Update an Onfleet task +* Team + * Automatically dispatch tasks assigned to a team to on-duty drivers + * Create a new Onfleet team + * Delete an Onfleet team + * Get a specific Onfleet team + * Get all Onfleet teams + * Get estimated times for upcoming tasks for a team, returns a selected driver + * Update an Onfleet team +* Worker + * Create a new Onfleet worker + * Delete an Onfleet worker + * Get a specific Onfleet worker + * Get all Onfleet workers + * Get a specific Onfleet worker schedule + * Update an Onfleet worker + +## Templates and examples + + +[[ templatesWidget(page.title, 'onfleet') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.openthesaurus.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenThesaurus node documentation +description: Learn how to use the OpenThesaurus node in n8n. Follow technical documentation to integrate OpenThesaurus node into your workflows. +contentType: [integration, reference] +--- + +# OpenThesaurus node + +Use the OpenThesaurus node to automate work in OpenThesaurus, and integrate OpenThesaurus with other applications. n8n supports synonym look-up for German words. + +On this page, you'll find a list of operations the OpenThesaurus node supports and links to more resources. + +/// note | Credentials +OpenThesaurus node doesn't require authentication. +/// + +## Operations + +* Get synonyms for a German word in German + +## Templates and examples + + +[[ templatesWidget(page.title, 'openthesaurus') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.openweathermap.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenWeatherMap node documentation +description: Learn how to use the OpenWeatherMap node in n8n. Follow technical documentation to integrate OpenWeatherMap node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# OpenWeatherMap node + +Use the OpenWeatherMap node to automate work in OpenWeatherMap, and integrate OpenWeatherMap with other applications. n8n supports retrieving current and upcoming weather data with OpenWeatherMap. + +On this page, you'll find a list of operations the OpenWeatherMap node supports and links to more resources. + +/// note | Credentials +Refer to [OpenWeatherMap credentials](/integrations/builtin/credentials/openweathermap.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Returns the current weather data +* Returns the weather data for the next 5 days + +## Templates and examples + + +[[ templatesWidget(page.title, 'openweathermap') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.oura.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Oura node documentation +description: Learn how to use the Oura node in n8n. Follow technical documentation to integrate Oura node into your workflows. +contentType: [integration, reference] +--- + +# Oura node + +Use the Oura node to automate work in Oura, and integrate Oura with other applications. n8n has built-in support for a wide range of Oura features, including getting profiles, and summaries. + +On this page, you'll find a list of operations the Oura node supports and links to more resources. + +/// note | Credentials +Refer to [Oura credentials](/integrations/builtin/credentials/oura.md) for guidance on setting up authentication. +/// + +## Operations + +* Profile + * Get the user's personal information. +* Summary + * Get the user's activity summary. + * Get the user's readiness summary. + * Get the user's sleep summary + +## Templates and examples + + +[[ templatesWidget(page.title, 'oura') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.paddle.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Paddle node documentation +description: Learn how to use the Paddle node in n8n. Follow technical documentation to integrate Paddle node into your workflows. +contentType: [integration, reference] +--- + +# Paddle node + +Use the Paddle node to automate work in Paddle, and integrate Paddle with other applications. n8n has built-in support for a wide range of Paddle features, including creating, updating, and getting coupons, as well as getting plans, products, and users. + +On this page, you'll find a list of operations the Paddle node supports and links to more resources. + +/// note | Credentials +Refer to [Paddle credentials](/integrations/builtin/credentials/paddle.md) for guidance on setting up authentication. +/// + +## Operations + +* Coupon + * Create a coupon. + * Get all coupons. + * Update a coupon. +* Payment + * Get all payment. + * Reschedule payment. +* Plan + * Get a plan. + * Get all plans. +* Product + * Get all products. +* User + * Get all users + +## Templates and examples + + +[[ templatesWidget(page.title, 'paddle') ]] + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.pagerduty.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: PagerDuty node documentation +description: Learn how to use the PagerDuty node in n8n. Follow technical documentation to integrate PagerDuty node into your workflows. +contentType: [integration, reference] +--- + +# PagerDuty node + +Use the PagerDuty node to automate work in PagerDuty, and integrate PagerDuty with other applications. n8n has built-in support for a wide range of PagerDuty features, including creating incident notes, as well as updating, and getting all log entries and users. + +On this page, you'll find a list of operations the PagerDuty node supports and links to more resources. + +/// note | Credentials +Refer to [PagerDuty credentials](/integrations/builtin/credentials/pagerduty.md) for guidance on setting up authentication. +/// + +## Operations + +* Incident + * Create an incident + * Get an incident + * Get all incidents + * Update an incident +* Incident Note + * Create an incident note + * Get all incident's notes +* Log Entry + * Get a log entry + * Get all log entries +* User + * Get a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'pagerduty') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.paypal.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: PayPal node documentation +description: Learn how to use the PayPal node in n8n. Follow technical documentation to integrate PayPal node into your workflows. +contentType: [integration, reference] +--- + +# PayPal node + +Use the PayPal node to automate work in PayPal, and integrate PayPal with other applications. n8n has built-in support for a wide range of PayPal features, including creating a batch payout and canceling unclaimed payout items. + +On this page, you'll find a list of operations the PayPal node supports and links to more resources. + +/// note | Credentials +Refer to [PayPal credentials](/integrations/builtin/credentials/paypal.md) for guidance on setting up authentication. +/// + +## Operations + +* Payout + * Create a batch payout + * Show batch payout details +* Payout Item + * Cancels an unclaimed payout item + * Show payout item details + +## Templates and examples + + +[[ templatesWidget(page.title, 'paypal') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.peekalink.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Peekalink node documentation +description: Learn how to use the Peekalink node in n8n. Follow technical documentation to integrate Peekalink node into your workflows. +contentType: [integration, reference] +--- + +# Peekalink node + +Use the Peekalink node to automate work in Peekalink, and integrate Peekalink with other applications. n8n supports checking, and reviewing links with Peekalink. + +On this page, you'll find a list of operations the Peekalink node supports and links to more resources. + +/// note | Credentials +Refer to [Peekalink credentials](/integrations/builtin/credentials/peekalink.md) for guidance on setting up authentication. +/// + +## Operations + +* Check whether preview for a given link is available +* Return the preview for a link + +## Templates and examples + + +[[ templatesWidget(page.title, 'peekalink') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.phantombuster.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: PhantomBuster node documentation +description: Learn how to use the PhantomBuster node in n8n. Follow technical documentation to integrate PhantomBuster node into your workflows. +contentType: [integration, reference] +--- + +# PhantomBuster node + +Use the PhantomBuster node to automate work in PhantomBuster, and integrate PhantomBuster with other applications. n8n has built-in support for a wide range of PhantomBuster features, including adding, deleting, and getting agents. + +On this page, you'll find a list of operations the PhantomBuster node supports and links to more resources. + +/// note | Credentials +Refer to [PhantomBuster credentials](/integrations/builtin/credentials/phantombuster.md) for guidance on setting up authentication. +/// + +## Operations + +* Agent + * Delete an agent by ID. + * Get an agent by ID. + * Get all agents of the current user's organization. + * Get the output of the most recent container of an agent. + * Add an agent to the launch queue. + +## Templates and examples + + +[[ templatesWidget(page.title, 'phantombuster') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.philipshue.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Philips Hue node documentation +description: Learn how to use the Philips Hue node in n8n. Follow technical documentation to integrate Philips Hue node into your workflows. +contentType: [integration, reference] +--- + +# Philips Hue node + +Use the Philips Hue node to automate work in Philips Hue, and integrate Philips Hue with other applications. n8n has built-in support for a wide range of Philips Hue features, including deleting, retrieving, and updating lights. + +On this page, you'll find a list of operations the Philips Hue node supports and links to more resources. + +/// note | Credentials +Refer to [Philips Hue credentials](/integrations/builtin/credentials/philipshue.md) for guidance on setting up authentication. +/// + +## Operations + +* Light + * Delete a light + * Retrieve a light + * Retrieve all lights + * Update a light + +## Templates and examples + + +[[ templatesWidget(page.title, 'philips-hue') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.pipedrive.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Pipedrive node documentation +description: Learn how to use the Pipedrive node in n8n. Follow technical documentation to integrate Pipedrive node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Pipedrive node + +Use the Pipedrive node to automate work in Pipedrive, and integrate Pipedrive with other applications. n8n has built-in support for a wide range of Pipedrive features, including creating, updating, deleting, and getting activity, files, notes, organizations, and leads. + +On this page, you'll find a list of operations the Pipedrive node supports and links to more resources. + +/// note | Credentials +Refer to [Pipedrive credentials](/integrations/builtin/credentials/pipedrive.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Activity + * Create an activity + * Delete an activity + * Get data of an activity + * Get data of all activities + * Update an activity +* Deal + * Create a deal + * Delete a deal + * Duplicate a deal + * Get data of a deal + * Get data of all deals + * Search a deal + * Update a deal +* Deal Activity + * Get all activities of a deal +* Deal Product + * Add a product to a deal + * Get all products in a deal + * Remove a product from a deal + * Update a product in a deal +* File + * Create a file + * Delete a file + * Download a file + * Get data of a file +* Lead + * Create a lead + * Delete a lead + * Get data of a lead + * Get data of all leads + * Update a lead +* Note + * Create a note + * Delete a note + * Get data of a note + * Get data of all notes + * Update a note +* Organization + * Create an organization + * Delete an organization + * Get data of an organization + * Get data of all organizations + * Update an organization + * Search organizations +* Person + * Create a person + * Delete a person + * Get data of a person + * Get data of all persons + * Search all persons + * Update a person +* Product + * Get data of all products + +## Templates and examples + + +[[ templatesWidget(page.title, 'pipedrive') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.plivo.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Plivo node documentation +description: Learn how to use the Plivo node in n8n. Follow technical documentation to integrate Plivo node into your workflows. +contentType: [integration, reference] +--- + +# Plivo node + +Use the Plivo node to automate work in Plivo, and integrate Plivo with other applications. n8n has built-in support for a wide range of Plivo features, including making calls, and sending SMS/MMS. + +On this page, you'll find a list of operations the Plivo node supports and links to more resources. + +/// note | Credentials +Refer to [Plivo credentials](/integrations/builtin/credentials/plivo.md) for guidance on setting up authentication. +/// + +## Operations + +* Call + * Make a voice call +* MMS + * Send an MMS message (US/Canada only) +* SMS + * Send an SMS message. + +## Templates and examples + + +[[ templatesWidget(page.title, 'plivo') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.postbin.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: PostBin node documentation +description: Learn how to use the PostBin node in n8n. Follow technical documentation to integrate PostBin node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# PostBin node + +PostBin is a service that helps you test API clients and webhooks. Use the PostBin node to automate work in PostBin, and integrate PostBin with other applications. n8n has built-in support for a wide range of PostBin features, including creating and deleting bins, and getting and sending requests. + +On this page, you'll find a list of operations the PostBin node supports, and links to more resources. + +## Operations + +* Bin + * Create + * Get + * Delete +* Request + * Get + * Remove First + * Send + +## Templates and examples + + +[[ templatesWidget(page.title, 'postbin') ]] + +## Send requests + +To send requests to a PostBin bin: + +1. Go to [PostBin](https://www.toptal.com/developers/postbin/){:target=_blank .external-link} and follow the steps to generate a new bin. PostBin gives you a unique URL, including a bin ID. +2. In the PostBin node, select the **Request** resource. +3. Choose the type of **Operation** you want to perform. +4. Enter your bin ID in **Bin ID**. + +## Create and manage bins + +You can create and manage PostBin bins using the PostBin node. + +1. In **Resource**, select **Bin**. +2. Choose an **Operation**. You can create, delete, or get a bin. + + +# integrations/builtin/app-nodes/n8n-nodes-base.postgres/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Postgres node common issues +description: Documentation for common issues and questions in the Postgres node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Postgres node common issues + +Here are some common errors and issues with the [Postgres node](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/index.md) and steps to resolve or troubleshoot them. + +## Dynamically populate SQL `IN` groups with parameters + +In Postgres, you can use the SQL [`IN` comparison construct](https://www.postgresql.org/docs/current/functions-comparisons.html#FUNCTIONS-COMPARISONS-IN-SCALAR) to make comparisons between groups of values: + +```sql +SELECT color, shirt_size FROM shirts WHERE shirt_size IN ('small', 'medium', 'large'); +``` + +While you can use n8n [expressions](/code/expressions.md) in your query to dynamically populate the values in an `IN` group, combining this with [query parameters](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/index.md#use-query-parameters) provides extra protection by automatically sanitizing input. + +To construct an `IN` group query with query parameters: + +1. Set the **Operation** to **Execute Query**. +2. In **Options**, select **Query Parameters**. +3. Use an expression to select an array from the input data. For example, `{{ $json.input_shirt_sizes }}`. +4. In the **Query** parameter, write your query with the `IN` construct with an empty set of parentheses. For example: + ```sql + SELECT color, shirt_size FROM shirts WHERE shirt_size IN (); + ``` +5. Inside of the `IN` parentheses, use an expression to dynamically create index-based placeholders (like `$1`, `$2`, and `$3`) for the number of items in your query parameter array. You can do this by increasing each array index by one since the placeholder variables are 1 indexed: + ```sql + SELECT color, shirt_size FROM shirts WHERE shirt_size IN ({{ $json.input_shirt_sizes.map((i, pos) => "$" + (pos+1)).join(', ') }}); + ``` + +With this technique, n8n automatically creates the correct number of [prepared statement placeholders](https://www.postgresql.org/docs/current/sql-prepare.html) for the `IN` values according to the number of items in your array. + +## Working with timestamps and time zones + +To avoid complications with how n8n and Postgres interpret timestamp and time zone data, follow these general tips: + +- **Use UTC when storing and passing dates**: Using UTC helps avoid confusion over timezone conversions when converting dates between different representations and systems. +- **Set the execution timezone**: Set the global timezone in n8n using either [environment variables](/hosting/configuration/configuration-examples/time-zone.md) (for self-hosted) or in the [settings](/manage-cloud/set-cloud-timezone.md) (for n8n Cloud). You can set a workflow-specific timezone in the [workflow settings](/workflows/settings.md). +- **Use ISO 8601 format**: The [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) encodes the day of the month, month, year, hour, minutes, and seconds in a standardized string. n8n passes dates between nodes as strings and uses [Luxon](/code/cookbook/luxon.md) to parse dates. If you need to cast to ISO 8601 explicitly, you can use the [Date & Time node](/integrations/builtin/core-nodes/n8n-nodes-base.datetime.md) and a custom format set to the string `yyyy-MM-dd'T'HH:mm:ss`. + + +# integrations/builtin/app-nodes/n8n-nodes-base.postgres/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Postgres node documentation +description: Learn how to use the Postgres node in n8n. Follow technical documentation to integrate Postgres node into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# Postgres node + +Use the Postgres node to automate work in Postgres, and integrate Postgres with other applications. n8n has built-in support for a wide range of Postgres features, including executing queries, as well as inserting and updating rows in a database. + +On this page, you'll find a list of operations the Postgres node supports and links to more resources. + +/// note | Credentials +Refer to [Postgres credentials](/integrations/builtin/credentials/postgres.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* [**Delete**](#delete): Delete an entire table or rows in a table +* [**Execute Query**](#execute-query): Execute an SQL query +* [**Insert**](#insert): Insert rows in a table +* [**Insert or Update**](#insert-or-update): Insert or update rows in a table +* [**Select**](#select): Select rows from a table +* [**Update**](#update): Update rows in a table + +### Delete + +Use this operation to delete an entire table or rows in a table. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md). +- **Operation**: Select **Delete**. +- **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name. +- **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name. +- **Command**: The deletion action to take: + - **Truncate**: Removes the table's data but preserves the table's structure. + - **Restart Sequences**: Whether to reset auto increment columns to their initial values as part of the Truncate process. + - **Delete**: Delete the rows that match the "Select Rows" condition. If you don't select anything, Postgres deletes all rows. + - **Select Rows**: Define a **Column**, **Operator**, and **Value** to match rows on. + - **Combine Conditions**: How to combine the conditions in "Select Rows". **AND** requires all conditions to be true, while **OR** requires at least one condition to be true. + - **Drop**: Deletes the table's data and structure permanently. + +#### Delete options + +- **Cascade**: Whether to also drop all objects that depend on the table, like views and sequences. Available if using **Truncate** or **Drop** commands. +- **Connection Timeout**: The number of seconds to try to connect to the database. +- **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing. +- **Query Batching**: The way to send queries to the database: + - **Single Query**: A single query for all incoming items. + - **Independently**: Execute one query per incoming item of the execution. + - **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes. +- **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as: + - **Numbers**: Use this for standard numbers. + - **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect. + +### Execute Query + +Use this operation to execute an SQL query. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md). +- **Operation**: Select **Execute Query**. +- **Query**: The SQL query to execute. You can use n8n [expressions](/code/expressions.md) and tokens like `$1`, `$2`, and `$3` to build [prepared statements](https://www.postgresql.org/docs/current/sql-prepare.html) to use with [query parameters](#use-query-parameters). + +#### Execute Query options + +- **Connection Timeout**: The number of seconds to try to connect to the database. +- **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing. +- **Query Batching**: The way to send queries to the database: + - **Single Query**: A single query for all incoming items. + - **Independently**: Execute one query per incoming item of the execution. + - **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes. +- **Query Parameters**: A comma-separated list of values that you want to use as [query parameters](#use-query-parameters). +- **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as: + - **Numbers**: Use this for standard numbers. + - **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect. +- **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software. + +### Insert + +Use this operation to insert rows in a table. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md). +- **Operation**: Select **Insert**. +- **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name. +- **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name. +- **Mapping Column Mode**: How to map column names to incoming data: + - **Map Each Column Manually**: Select the values to use for each column. + - **Map Automatically**: Automatically map incoming data to matching column names in Postgres. The incoming data field names must match the column names in Postgres for this to work. If necessary, consider using the [edit fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) before this node to adjust the format as needed. + +#### Insert options + +- **Connection Timeout**: The number of seconds to try to connect to the database. +- **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing. +- **Query Batching**: The way to send queries to the database: + - **Single Query**: A single query for all incoming items. + - **Independently**: Execute one query per incoming item of the execution. + - **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes. +- **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md). +- **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as: + - **Numbers**: Use this for standard numbers. + - **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect. +- **Skip on Conflict**: Whether to skip the row if the insert violates a unique or exclusion constraint instead of throwing an error. +- **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software. + +### Insert or Update + +Use this operation to insert or update rows in a table. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md). +- **Operation**: Select **Insert or Update**. +- **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name. +- **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name. +- **Mapping Column Mode**: How to map column names to incoming data: + - **Map Each Column Manually**: Select the values to use for each column. + - **Map Automatically**: Automatically map incoming data to matching column names in Postgres. The incoming data field names must match the column names in Postgres for this to work. If necessary, consider using the [edit fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) before this node to adjust the format as needed. + +#### Insert or Update options + +- **Connection Timeout**: The number of seconds to try to connect to the database. +- **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing. +- **Query Batching**: The way to send queries to the database: + - **Single Query**: A single query for all incoming items. + - **Independently**: Execute one query per incoming item of the execution. + - **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes. +- **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md). +- **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as: + - **Numbers**: Use this for standard numbers. + - **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect. +- **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software. + +### Select + +Use this operation to select rows in a table. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md). +- **Operation**: Select **Select**. +- **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name. +- **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name. +- **Return All**: Whether to return all results or only up to a given limit. +- **Limit**: The maximum number of items to return when **Return All** is disabled. +- **Select Rows**: Set the conditions to select rows. Define a **Column**, **Operator**, and **Value** to match rows on. If you don't select anything, Postgres selects all rows. +- **Combine Conditions**: How to combine the conditions in **Select Rows**. **AND** requires all conditions to be true, while **OR** requires at least one condition to be true. +- **Sort**: Choose how to sort the selected rows. Choose a **Column** from a list or by ID and a sort **Direction**. + +#### Select options + +- **Connection Timeout**: The number of seconds to try to connect to the database. +- **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing. +- **Query Batching**: The way to send queries to the database: + - **Single Query**: A single query for all incoming items. + - **Independently**: Execute one query per incoming item of the execution. + - **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes. +- **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md). +- **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as: + - **Numbers**: Use this for standard numbers. + - **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect. + +### Update + +Use this operation to update rows in a table. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [Postgres credential](/integrations/builtin/credentials/postgres.md). +- **Operation**: Select **Update**. +- **Schema**: Choose the schema that contains the table you want to work on. Select **From list** to choose the schema from the dropdown list or **By Name** to enter the schema name. +- **Table**: Choose the table that you want to work on. Select **From list** to choose the table from the dropdown list or **By Name** to enter the table name. +- **Mapping Column Mode**: How to map column names to incoming data: + - **Map Each Column Manually**: Select the values to use for each column. + - **Map Automatically**: Automatically map incoming data to matching column names in Postgres. The incoming data field names must match the column names in Postgres for this to work. If necessary, consider using the [edit fields (set) node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.set/) before this node to adjust the format as needed. + +#### Update options + +- **Connection Timeout**: The number of seconds to try to connect to the database. +- **Delay Closing Idle Connection**: The number of seconds to wait before considering idle connections eligible for closing. +- **Query Batching**: The way to send queries to the database: + - **Single Query**: A single query for all incoming items. + - **Independently**: Execute one query per incoming item of the execution. + - **Transaction**: Execute all queries in a transaction. If a failure occurs, Postgres rolls back all changes. +- **Output Columns**: Choose which columns to output. You can select from a list of available columns or specify IDs using [expressions](/code/expressions.md). +- **Output Large-Format Numbers As**: The format to output `NUMERIC` and `BIGINT` columns as: + - **Numbers**: Use this for standard numbers. + - **Text**: Use this if you expect numbers longer than 16 digits. Without this, numbers may be incorrect. +- **Replace Empty Strings with NULL**: Whether to replace empty strings with NULL in input. This may be useful when working with data exported from spreadsheet software. + +## Templates and examples + + +[[ templatesWidget(page.title, 'postgres') ]] + +## Related resources + +n8n provides a trigger node for Postgres. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.postgrestrigger.md). + +## Use query parameters + +When creating a query to run on a Postgres database, you can use the **Query Parameters** field in the **Options** section to load data into the query. n8n sanitizes data in query parameters, which prevents SQL injection. + +For example, you want to find a person by their email address. Given the following input data: + +```js +[ + { + "email": "alex@example.com", + "name": "Alex", + "age": 21 + }, + { + "email": "jamie@example.com", + "name": "Jamie", + "age": 33 + } +] +``` + +You can write a query like: + +```sql +SELECT * FROM $1:name WHERE email = $2; +``` + +Then in **Query Parameters**, provide the field values to use. You can provide fixed values or expressions. For this example, use expressions so the node can pull the email address from each input item in turn: + +```js +// users is an example table name +{{ [ 'users', $json.email ] }} +``` + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.posthog.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: PostHog node documentation +description: Learn how to use the PostHog node in n8n. Follow technical documentation to integrate PostHog node into your workflows. +contentType: [integration, reference] +--- + +# PostHog node + +Use the PostHog node to automate work in PostHog, and integrate PostHog with other applications. n8n has built-in support for a wide range of PostHog features, including creating aliases, events, and identity, as well as tracking pages. + +On this page, you'll find a list of operations the PostHog node supports and links to more resources. + +/// note | Credentials +Refer to [PostHog credentials](/integrations/builtin/credentials/posthog.md) for guidance on setting up authentication. +/// + +## Operations + +* Alias + * Create an alias +* Event + * Create an event +* Identity + * Create +* Track + * Track a page + * Track a screen + +## Templates and examples + + +[[ templatesWidget(page.title, 'posthog') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.profitwell.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ProfitWell node documentation +description: Learn how to use the ProfitWell node in n8n. Follow technical documentation to integrate ProfitWell node into your workflows. +contentType: [integration, reference] +--- + +# ProfitWell node + +Use the ProfitWell node to automate work in ProfitWell, and integrate ProfitWell with other applications. n8n supports getting your company's account settings and retrieving financial metrics from ProfitWell. + +On this page, you'll find a list of operations the ProfitWell node supports and links to more resources. + +/// note | Credentials +Refer to [ProfitWell credentials](/integrations/builtin/credentials/profitwell.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Get your company's ProfitWell account settings +* Metric + * Retrieve financial metric broken down by day for either the current month or the last + +## Templates and examples + + +[[ templatesWidget(page.title, 'profitwell') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.pushbullet.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Pushbullet node documentation +description: Learn how to use the Pushbullet node in n8n. Follow technical documentation to integrate Pushbullet node into your workflows. +contentType: [integration, reference] +--- + +# Pushbullet node + +Use the Pushbullet node to automate work in Pushbullet, and integrate Pushbullet with other applications. n8n has built-in support for a wide range of Pushbullet features, including creating, updating, deleting, and getting a push. + +On this page, you'll find a list of operations the Pushbullet node supports and links to more resources. + +/// note | Credentials +Refer to [Pushbullet credentials](/integrations/builtin/credentials/pushbullet.md) for guidance on setting up authentication. +/// + +## Operations + +* Push + * Create a push + * Delete a push + * Get all pushes + * Update a push + +## Templates and examples + + +[[ templatesWidget(page.title, 'pushbullet') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.pushcut.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Pushcut node documentation +description: Learn how to use the Pushcut node in n8n. Follow technical documentation to integrate Pushcut node into your workflows. +contentType: [integration, reference] +--- + +# Pushcut node + +Use the Pushcut node to automate work in Pushcut, and integrate Pushcut with other applications. n8n supports sending notifications with Pushcut. + +On this page, you'll find a list of operations the Pushcut node supports and links to more resources. + +/// note | Credentials +Refer to [Pushcut credentials](/integrations/builtin/credentials/pushcut.md) for guidance on setting up authentication. +/// + +## Operations + +* Notification + * Send a notification + +## Templates and examples + + +[[ templatesWidget(page.title, 'pushcut') ]] + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.pushover.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Pushover node documentation +description: Learn how to use the Pushover node in n8n. Follow technical documentation to integrate Pushover node into your workflows. +contentType: [integration, reference] +--- + +# Pushover node + +Use the Pushover node to automate work in Pushover, and integrate Pushover with other applications. n8n supports sending push notifications with Pushover. + +On this page, you'll find a list of operations the Pushover node supports and links to more resources. + +/// note | Credentials +Refer to [Pushover credentials](/integrations/builtin/credentials/pushover.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Message + * Push + +## Templates and examples + + +[[ templatesWidget(page.title, 'pushover') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.questdb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: QuestDB node documentation +description: Learn how to use the QuestDB node in n8n. Follow technical documentation to integrate QuestDB node into your workflows. +contentType: [integration, reference] +--- + +# QuestDB node + +Use the QuestDB node to automate work in QuestDB, and integrate QuestDB with other applications. n8n supports executing an SQL query and inserting rows in a database with QuestDB. + +On this page, you'll find a list of operations the QuestDB node supports and links to more resources. + +/// note | Credentials +Refer to [QuestDB credentials](/integrations/builtin/credentials/questdb.md) for guidance on setting up authentication. +/// + +## Operations + +* Executes a SQL query. +* Insert rows in database. + +## Templates and examples + + +[[ templatesWidget(page.title, 'questdb') ]] + +## Node reference + +### Specify a column's data type + +To specify a column's data type, append the column name with `:type`, where `type` is the data type you want for column. For example, if you want to specify the type `int` for the column **id** and type `text` for the column **name**, you can use the following snippet in the **Columns** field: `id:int,name:text`. + + + + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.quickbase.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Quick Base node documentation +description: Learn how to use the Quick Base node in n8n. Follow technical documentation to integrate Quick Base node into your workflows. +contentType: [integration, reference] +--- + +# Quick Base node + +Use the Quick Base node to automate work in Quick Base, and integrate Quick Base with other applications. n8n has built-in support for a wide range of Quick Base features, including creating, updating, deleting, and getting records, as well as getting fields, and downloading files. + +On this page, you'll find a list of operations the Quick Base node supports and links to more resources. + +/// note | Credentials +Refer to [Quick Base credentials](/integrations/builtin/credentials/quickbase.md) for guidance on setting up authentication. +/// + +## Operations + +* Field + * Get all fields +* File + * Delete a file + * Download a file +* Record + * Create a record + * Delete a record + * Get all records + * Update a record + * Upsert a record +* Report + * Get a report + * Run a report + +## Templates and examples + + +[[ templatesWidget(page.title, 'quick-base') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.quickbooks.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: QuickBooks Online node documentation +description: Learn how to use the QuickBooks Online node in n8n. Follow technical documentation to integrate QuickBooks Online node into your workflows. +contentType: [integration, reference] +--- + +# QuickBooks Online node + +Use the QuickBooks node to automate work in QuickBooks, and integrate QuickBooks with other applications. n8n has built-in support for a wide range of QuickBooks features, including creating, updating, deleting, and getting bills, customers, employees, estimates, and invoices. + +On this page, you'll find a list of operations the QuickBooks node supports and links to more resources. + +/// note | Credentials +Refer to [QuickBooks credentials](/integrations/builtin/credentials/quickbooks.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Bill + * Create + * Delete + * Get + * Get All + * Update +* Customer + * Create + * Get + * Get All + * Update +* Employee + * Create + * Get + * Get All + * Update +* Estimate + * Create + * Delete + * Get + * Get All + * Send + * Update +* Invoice + * Create + * Delete + * Get + * Get All + * Send + * Update + * Void +* Item + * Get + * Get All +* Payment + * Create + * Delete + * Get + * Get All + * Send + * Update + * Void +* Purchase + * Get + * Get All +* Transaction + * Get Report +* Vendor + * Create + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'quickbooks-online') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.quickchart.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: QuickChart node documentation +description: Learn how to use the QuickChart node in n8n. Follow technical documentation to integrate QuickChart node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# QuickChart node + +Use the QuickChart node to automate work in QuickChart, and integrate QuickChart with other applications. n8n has built-in support for a wide range of QuickChart chart types, including bar, doughnut, line, pie, and polar charts. + +On this page, you'll find a list of operations the QuickChart node supports and links to more resources. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +Create a chart by selecting the chart type: + +* Chart Type + * Bar Chart + * Doughnut Chart + * Line Chart + * Pie Chart + * Polar Chart + +## Templates and examples + + +[[ templatesWidget(page.title, 'quickchart') ]] + +## Related resources + +Refer to [QuickChart's API documentation](https://quickchart.io/documentation/){:target=_blank .external-link} for more information about the service. + + +# integrations/builtin/app-nodes/n8n-nodes-base.rabbitmq.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: RabbitMQ node documentation +description: Learn how to use the RabbitMQ node in n8n. Follow technical documentation to integrate RabbitMQ node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# RabbitMQ node + +Use the RabbitMQ node to automate work in RabbitMQ, and integrate RabbitMQ with other applications. n8n has built-in support for a wide range of RabbitMQ features, including accepting, and forwarding messages. + +On this page, you'll find a list of operations the RabbitMQ node supports and links to more resources. + +/// note | Credentials +Refer to [RabbitMQ credentials](/integrations/builtin/credentials/rabbitmq.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Delete From Queue +* Send a Message to RabbitMQ + +## Templates and examples + + +[[ templatesWidget(page.title, 'rabbitmq') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.raindrop.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Raindrop node documentation +description: Learn how to use the Raindrop node in n8n. Follow technical documentation to integrate Raindrop node into your workflows. +contentType: [integration, reference] +--- + +# Raindrop node + +Use the Raindrop node to automate work in Raindrop, and integrate Raindrop with other applications. n8n has built-in support for a wide range of Raindrop features, including getting users, deleting tags, and creating, updating, deleting and getting collections and bookmarks. + +On this page, you'll find a list of operations the Raindrop node supports and links to more resources. + +/// note | Credentials +Refer to [Raindrop credentials](/integrations/builtin/credentials/raindrop.md) for guidance on setting up authentication. +/// + +## Operations + +* Bookmark + * Create + * Delete + * Get + * Get All + * Update +* Collection + * Create + * Delete + * Get + * Get All + * Update +* Tag + * Delete + * Get All +* User + * Get + +## Templates and examples + + +[[ templatesWidget(page.title, 'raindrop') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.reddit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Reddit node documentation +description: Learn how to use the Reddit node in n8n. Follow technical documentation to integrate Reddit node into your workflows. +contentType: [integration, reference] +--- + +# Reddit node + +Use the Reddit node to automate work in Reddit, and integrate Reddit with other applications. n8n has built-in support for a wide range of Reddit features, including getting profiles, and users, retrieving post comments and subreddit, as well as submitting, getting, and deleting posts. + +On this page, you'll find a list of operations the Reddit node supports and links to more resources. + +/// note | Credentials +Refer to [Reddit credentials](/integrations/builtin/credentials/reddit.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Post + * Submit a post to a subreddit + * Delete a post from a subreddit + * Get a post from a subreddit + * Get all posts from a subreddit + * Search posts in a subreddit or in all of Reddit. +* Post Comment + * Create a top-level comment in a post + * Retrieve all comments in a post + * Remove a comment from a post + * Write a reply to a comment in a post +* Profile + * Get +* Subreddit + * Retrieve background information about a subreddit. + * Retrieve information about subreddits from all of Reddit. +* User + * Get + +## Templates and examples + + +[[ templatesWidget(page.title, 'reddit') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.redis.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Redis node documentation +description: Learn how to use the Redis node in n8n. Follow technical documentation to integrate Redis node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Redis node + +Use the Redis node to automate work in Redis, and integrate Redis with other applications. n8n has built-in support for a wide range of Redis features, including deleting keys, getting key values, setting key value, and publishing messages to the Redis channel. + +On this page, you'll find a list of operations the Redis node supports and links to more resources. + +/// note | Credentials +Refer to [Redis credentials](/integrations/builtin/credentials/redis.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Delete a key from Redis. +* Get the value of a key from Redis. +* Returns generic information about the Redis instance. +* Atomically increments a key by 1. Creates the key if it doesn't exist. +* Returns all the keys matching a pattern. +* Set the value of a key in Redis. +* Publish message to Redis channel. + +## Templates and examples + + +[[ templatesWidget(page.title, 'redis') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.rocketchat.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Rocket.Chat node documentation +description: Learn how to use the Rocket.Chat node in n8n. Follow technical documentation to integrate Rocket.Chat node into your workflows. +contentType: [integration, reference] +--- + +# Rocket.Chat node + +Use the Rocket.Chat node to automate work in Rocket.Chat, and integrate Rocket.Chat with other applications. n8n supports posting messages to channels, and sending direct messages, with Rocket.Chat. + +On this page, you'll find a list of operations the Rocket.Chat node supports and links to more resources. + +/// note | Credentials +Refer to [Rocket.Chat credentials](/integrations/builtin/credentials/rocketchat.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Chat + * Post a message to a channel or a direct message + +## Templates and examples + + +[[ templatesWidget(page.title, 'rocketchat') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.rundeck.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Rundeck node documentation +description: Learn how to use the Rundeck node in n8n. Follow technical documentation to integrate Rundeck node into your workflows. +contentType: [integration, reference] +--- + +# Rundeck node + +Use the Rundeck node to automate work in Rundeck, and integrate Rundeck with other applications. n8n has built-in support for executing jobs and getting metadata. + +On this page, you'll find a list of operations the Rundeck node supports and links to more resources. + +/// note | Credentials +Refer to [Rundeck credentials](/integrations/builtin/credentials/rundeck.md) for guidance on setting up authentication. +/// + +## Operations + +- **Job** + - Execute a job + - Get metadata of a job + +## Templates and examples + + +[[ templatesWidget(page.title, 'rundeck') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Find the job ID + +1. Access your Rundeck dashboard. +2. Open the project that contains the job you want to use with n8n. +3. In the sidebar, select **JOBS**. +4. Under **All Jobs**, select the name of the job you want to use with n8n. +5. In the top left corner, under the name of the job, copy the string that's displayed in smaller font below the job name. This is your job ID. +6. Paste this job ID in the **Job Id** field in n8n. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.s3.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: S3 node documentation +description: Learn how to use the S3 node in n8n. Follow technical documentation to integrate S3 node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# S3 node + +Use the S3 node to automate work in non-AWS S3 storage and integrate S3 with other applications. n8n has built-in support for a wide range of S3 features, including creating, deleting, and getting buckets, files, and folders. For AWS S3, use [AWS S3](/integrations/builtin/app-nodes/n8n-nodes-base.awss3.md). + +Use the S3 node for non-AWS S3 solutions like: + +* [MinIO](https://min.io/){:target="_blank" .external-link} +* [Wasabi](https://wasabi.com/){:target="_blank" .external-link} +* [Digital Ocean spaces](https://www.digitalocean.com/products/spaces){:target="_blank" .external-link} + +On this page, you'll find a list of operations the S3 node supports and links to more resources. + +/// note | Credentials +Refer to [S3 credentials](/integrations/builtin/credentials/s3.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Bucket + * Create a bucket + * Delete a bucket + * Get all buckets + * Search within a bucket +* File + * Copy a file + * Delete a file + * Download a file + * Get all files + * Upload a file + + /// note | Attach file for upload + To attach a file for upload, use another node to pass the file as a data property. Nodes like the [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) node or the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) work well. + /// + +* Folder + * Create a folder + * Delete a folder + * Get all folders + +## Templates and examples + + +[[ templatesWidget(page.title, 's3') ]] + +## Node reference + +### Setting file permissions in Wasabi + +When uploading files to [Wasabi](https://wasabi.com/){:target="_blank" .external-link}, you must set permissions for the files using the **ACL** dropdown and not the toggles. + +![File permissions when using the S3 node with Wasabi](/_images/integrations/builtin/app-nodes/s3/acl_dropdown.png) + + +# integrations/builtin/app-nodes/n8n-nodes-base.salesforce.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Salesforce node documentation +description: Learn how to use the Salesforce node in n8n. Follow technical documentation to integrate Salesforce node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Salesforce node + +Use the Salesforce node to automate work in Salesforce, and integrate Salesforce with other applications. n8n has built-in support for a wide range of Salesforce features, including creating, updating, deleting, and getting accounts, attachments, cases, and leads, as well as uploading documents. + +On this page, you'll find a list of operations the Salesforce node supports and links to more resources. + +/// note | Credentials +Refer to [Salesforce credentials](/integrations/builtin/credentials/salesforce.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Account + * Add note to an account + * Create an account + * Create a new account, or update the current one if it already exists (upsert) + * Get an account + * Get all accounts + * Returns an overview of account's metadata. + * Delete an account + * Update an account +* Attachment + * Create a attachment + * Delete a attachment + * Get a attachment + * Get all attachments + * Returns an overview of attachment's metadata. + * Update a attachment +* Case + * Add a comment to a case + * Create a case + * Get a case + * Get all cases + * Returns an overview of case's metadata + * Delete a case + * Update a case +* Contact + * Add lead to a campaign + * Add note to a contact + * Create a contact + * Create a new contact, or update the current one if it already exists (upsert) + * Delete a contact + * Get a contact + * Returns an overview of contact's metadata + * Get all contacts + * Update a contact +* Custom Object + * Create a custom object record + * Create a new record, or update the current one if it already exists (upsert) + * Get a custom object record + * Get all custom object records + * Delete a custom object record + * Update a custom object record +* Document + * Upload a document +* Flow + * Get all flows + * Invoke a flow +* Lead + * Add lead to a campaign + * Add note to a lead + * Create a lead + * Create a new lead, or update the current one if it already exists (upsert) + * Delete a lead + * Get a lead + * Get all leads + * Returns an overview of Lead's metadata + * Update a lead +* Opportunity + * Add note to an opportunity + * Create an opportunity + * Create a new opportunity, or update the current one if it already exists (upsert) + * Delete an opportunity + * Get an opportunity + * Get all opportunities + * Returns an overview of opportunity's metadata + * Update an opportunity +* Search + * Execute a SOQL query that returns all the results in a single response +* Task + * Create a task + * Delete a task + * Get a task + * Get all tasks + * Returns an overview of task's metadata + * Update a task +* User + * Get a user + * Get all users + +## Templates and examples + + +[[ templatesWidget(page.title, 'salesforce') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Working with Salesforce custom fields + +To add custom fields to your request: + +1. Select **Additional Fields** > **Add Field**. +2. In the dropdown, select **Custom Fields**. + +You can then find and add your custom fields. + + +# integrations/builtin/app-nodes/n8n-nodes-base.salesmate.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Salesmate node documentation +description: Learn how to use the Salesmate node in n8n. Follow technical documentation to integrate Salesmate node into your workflows. +contentType: [integration, reference] +--- + +# Salesmate node + +Use the Salesmate node to automate work in Salesmate, and integrate Salesmate with other applications. n8n has built-in support for a wide range of Salesmate features, including creating, updating, deleting, and getting activities, companies, and deals. + +On this page, you'll find a list of operations the Salesmate node supports and links to more resources. + +/// note | Credentials +Refer to [Salesmate credentials](/integrations/builtin/credentials/salesmate.md) for guidance on setting up authentication. +/// + +## Operations + +* Activity + * Create an activity + * Delete an activity + * Get an activity + * Get all companies + * Update an activity +* Company + * Create a company + * Delete a company + * Get a company + * Get all companies + * Update a company +* Deal + * Create a deal + * Delete a deal + * Get a deal + * Get all deals + * Update a deal + +## Templates and examples + + +[[ templatesWidget(page.title, 'salesmate') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.seatable.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SeaTable node documentation +description: Learn how to use the SeaTable node in n8n. Follow technical documentation to integrate SeaTable node into your workflows. +contentType: [integration, reference] +--- + +# SeaTable node + +Use the SeaTable node to automate work in SeaTable, and integrate SeaTable with other applications. n8n has built-in support for a wide range of SeaTable features, including creating, updating, deleting, updating, and getting rows. + +On this page, you'll find a list of operations the SeaTable node supports and links to more resources. + +/// note | Credentials +Refer to [SeaTable credentials](/integrations/builtin/credentials/seatable.md) for guidance on setting up authentication. +/// + +## Operations + +* Row + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'seatable') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.securityscorecard.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SecurityScorecard node documentation +description: Learn how to use the SecurityScorecard node in n8n. Follow technical documentation to integrate SecurityScorecard node into your workflows. +contentType: [integration, reference] +--- + +# SecurityScorecard node + +Use the SecurityScorecard node to automate work in SecurityScorecard, and integrate SecurityScorecard with other applications. n8n has built-in support for a wide range of SecurityScorecard features, including creating, updating, deleting, and getting portfolio, as well as getting a company's data. + +On this page, you'll find a list of operations the SecurityScorecard node supports and links to more resources. + +/// note | Credentials +Refer to [SecurityScorecard credentials](/integrations/builtin/credentials/securityscorecard.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Get company factor scores and issue counts + * Get company's historical factor scores + * Get company's historical scores + * Get company information and summary of their scorecard + * Get company's score improvement plan +* Industry + * Get Factor Scores + * Get Historical Factor Scores + * Get Score +* Invite + * Create an invite for a company/user +* Portfolio + * Create a portfolio + * Delete a portfolio + * Get all portfolios + * Update a portfolio +* Portfolio Company + * Add a company to portfolio + * Get all companies in a portfolio + * Remove a company from portfolio +* Report + * Download a generated report + * Generate a report + * Get list of recently generated report + +## Templates and examples + + +[[ templatesWidget(page.title, 'securityscorecard') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.segment.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Segment node documentation +description: Learn how to use the Segment node in n8n. Follow technical documentation to integrate Segment node into your workflows. +contentType: [integration, reference] +--- + +# Segment node + +Use the Segment node to automate work in Segment, and integrate Segment with other applications. n8n has built-in support for a wide range of Segment features, including adding users to groups, creating identities, and tracking activities. + +On this page, you'll find a list of operations the Segment node supports and links to more resources. + +/// note | Credentials +Refer to [Segment credentials](/integrations/builtin/credentials/segment.md) for guidance on setting up authentication. +/// + +## Operations + +* Group + * Add a user to a group +* Identify + * Create an identity +* Track + * Record the actions your users perform. Every action triggers an event, which can also have associated properties. + * Record page views on your website, along with optional extra information about the page being viewed. + +## Templates and examples + + +[[ templatesWidget(page.title, 'segment') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.sendgrid.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SendGrid node documentation +description: Learn how to use the SendGrid node in n8n. Follow technical documentation to integrate SendGrid node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# SendGrid node + +Use the SendGrid node to automate work in SendGrid, and integrate SendGrid with other applications. n8n has built-in support for a wide range of SendGrid features, including creating, updating, deleting, and getting contacts, and lists, as well as sending emails. + +On this page, you'll find a list of operations the SendGrid node supports and links to more resources. + +/// note | Credentials +Refer to [SendGrid credentials](/integrations/builtin/credentials/sendgrid.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Contact + * Create/update a contact + * Delete a contact + * Get a contact by ID + * Get all contacts +* List + * Create a list + * Delete a list + * Get a list + * Get all lists + * Update a list +* Mail + * Send an email. + +## Templates and examples + + +[[ templatesWidget(page.title, 'sendgrid') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.sendy.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Sendy node documentation +description: Learn how to use the Sendy node in n8n. Follow technical documentation to integrate Sendy node into your workflows. +contentType: [integration, reference] +--- + +# Sendy node + +Use the Sendy node to automate work in Sendy, and integrate Sendy with other applications. n8n has built-in support for a wide range of Sendy features, including creating campaigns, and adding, counting, deleting, and getting subscribers. + +On this page, you'll find a list of operations the Sendy node supports and links to more resources. + +/// note | Credentials +Refer to [Sendy credentials](/integrations/builtin/credentials/sendy.md) for guidance on setting up authentication. +/// + +## Operations + +* Campaign + * Create a campaign +* Subscriber + * Add a subscriber to a list + * Count subscribers + * Delete a subscriber from a list + * Unsubscribe user from a list + * Get the status of subscriber + +## Templates and examples + + +[[ templatesWidget(page.title, 'sendy') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.sentryio.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Sentry.io node documentation +description: Learn how to use the Sentry.io node in n8n. Follow technical documentation to integrate Sentry.io node into your workflows. +contentType: [integration, reference] +--- + +# Sentry.io node + +Use the Sentry.io node to automate work in Sentry.io, and integrate Sentry.io with other applications. n8n has built-in support for a wide range of Sentry.io features, including creating, updating, deleting, and getting, issues, projects, and releases, as well as getting all events. + +On this page, you'll find a list of operations the Sentry.io node supports and links to more resources. + +/// note | Credentials +Refer to [Sentry.io credentials](/integrations/builtin/credentials/sentryio.md) for guidance on setting up authentication. +/// + +## Operations + +* Event + * Get event by ID + * Get all events +* Issue + * Delete an issue + * Get issue by ID + * Get all issues + * Update an issue +* Project + * Create a new project + * Delete a project + * Get project by ID + * Get all projects + * Update a project +* Release + * Create a release + * Delete a release + * Get release by version identifier + * Get all releases + * Update a release +* Organization + * Create an organization + * Get organization by slug + * Get all organizations + * Update an organization +* Team + * Create a new team + * Delete a team + * Get team by slug + * Get all teams + * Update a team + +## Templates and examples + + +[[ templatesWidget(page.title, 'sentryio') ]] + +## Related resources + +Refer to [Sentry.io's documentation](https://docs.sentry.io/api/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.servicenow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ServiceNow node documentation +description: Learn how to use the ServiceNow node in n8n. Follow technical documentation to integrate ServiceNow node into your workflows. +contentType: [integration, reference] +--- + +# ServiceNow node + +Use the ServiceNow node to automate work in ServiceNow, and integrate ServiceNow with other applications. n8n has built-in support for a wide range of ServiceNow features, including getting business services, departments, configuration items, and dictionary as well as creating, updating, and deleting incidents, users, and table records. + +On this page, you'll find a list of operations the ServiceNow node supports and links to more resources. + +/// note | Credentials +Refer to [ServiceNow credentials](/integrations/builtin/credentials/servicenow.md) for guidance on setting up authentication. +/// + +## Operations + +* Business Service + * Get All +* Configuration Items + * Get All +* Department + * Get All +* Dictionary + * Get All +* Incident + * Create + * Delete + * Get + * Get All + * Update +* Table Record + * Create + * Delete + * Get + * Get All + * Update +* User + * Create + * Delete + * Get + * Get All + * Update +* User Group + * Get All +* User Role + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'servicenow') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.shopify.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Shopify node documentation +description: Learn how to use the Shopify node in n8n. Follow technical documentation to integrate Shopify node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Shopify node + +Use the Shopify node to automate work in Shopify, and integrate Shopify with other applications. n8n has built-in support for a wide range of Shopify features, including creating, updating, deleting, and getting orders and products. + +On this page, you'll find a list of operations the Shopify node supports and links to more resources. + +/// note | Credentials +Refer to [Shopify credentials](/integrations/builtin/credentials/shopify.md) for guidance on setting up authentication. +/// + +## Operations + +* Order + * Create an order + * Delete an order + * Get an order + * Get all orders + * Update an order +* Product + * Create a product + * Delete a product + * Get a product + * Get all products + * Update a product + +## Templates and examples + + +[[ templatesWidget(page.title, 'shopify') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.signl4.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SIGNL4 node documentation +description: Learn how to use the SIGNL4 node in n8n. Follow technical documentation to integrate SIGNL4 node into your workflows. +contentType: [integration, reference] +--- + +# SIGNL4 node + +Use the SIGNL4 node to automate work in SIGNL4, and integrate SIGNL4 with other applications. n8n supports sending and resolving alerts with SIGNL4. + +On this page, you'll find a list of operations the SIGNL4 node supports and links to more resources. + +/// note | Credentials +Refer to [SIGNL4 credentials](/integrations/builtin/credentials/signl4.md) for guidance on setting up authentication. +/// + +## Operations + +* Alert + * Send an alert + * Resolve an alert + +## Templates and examples + + +[[ templatesWidget(page.title, 'signl4') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.slack.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Slack node documentation +description: Learn how to use the Slack node in n8n. Follow technical documentation to integrate Slack node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Slack node + +Use the Slack node to automate work in Slack, and integrate Slack with other applications. n8n has built-in support for a wide range of Slack features, including creating, archiving, and closing channels, getting users and files, as well as deleting messages. + +On this page, you'll find a list of operations the Slack node supports and links to more resources. + +/// note | Credentials +Refer to [Slack credentials](/integrations/builtin/credentials/slack.md) for guidance on setting up authentication. +/// + +## Operations + +* **Channel** + * **Archive** a channel. + * **Close** a direct message or multi-person direct message. + * **Create** a public or private channel-based conversation. + * **Get** information about a channel. + * **Get Many**: Get a list of channels in Slack. + * **History**: Get a channel's history of messages and events. + * **Invite** a user to a channel. + * **Join** an existing channel. + * **Kick**: Remove a user from a channel. + * **Leave** a channel. + * **Member**: List the members of a channel. + * **Open** or resume a direct message or multi-person direct message. + * **Rename** a channel. + * **Replies**: Get a thread of messages posted to a channel. + * **Sets purpose** of a channel. + * **Sets topic** of a channel. + * **Unarchive** a channel. +* **File** + * **Get** a file. + * **Get Many**: Get and filter team files. + * **Upload**: Create or upload an existing file. +* **Message** + * **Delete** a message + * **Get permalink**: Get a message's permalink. + * **Search** for messages + * **Send** a message + * **Send and Wait for Approval**: Send a message and wait for approval from the recipient before continuing. + * **Update** a message +* **Reaction** + * **Add** a reaction to a message. + * **Get** a message's reactions. + * **Remove** a reaction from a message. +* **Star** + * **Add** a star to an item. + * **Delete** a star from an item. + * **Get Many**: Get a list of an authenticated user's stars. +* **User** + * **Get** information about a user. + * **Get Many**: Get a list of users. + * **Get User's Profile**. + * **Get User's Status**. + * **Update User's Profile**. +* **User Group** + * **Create** a user group. + * **Disable** a user group. + * **Enable** a user group. + * **Get Many**: Get a list of user groups. + * **Update** a user group. + +## Templates and examples + + +[[ templatesWidget(page.title, 'slack') ]] + +## Related resources + +Refer to [Slack's documentation](https://api.slack.com/){:target=_blank .external-link} for more information about the service. + +## Required scopes + +Once you create a Slack app for your [Slack credentials](/integrations/builtin/credentials/slack.md), you must add the appropriate scopes to your Slack app for this node to work. Start with the scopes listed in the [Scopes | Slack credentials](/integrations/builtin/credentials/slack.md#scopes) page. + +If those aren't enough, use the table below to look up the resource and operation you want to use, then follow the link to Slack's API documentation to find the correct scopes. + + + +| **Resource** | **Operation** | **Slack API method** | +| --- | --- | --- | +| Channel | Archive | [conversations.archive](https://api.slack.com/methods/conversations.archive){:target=blank .external-link} | +| Channel | Close | [conversations.close](https://api.slack.com/methods/conversations.close){:target=blank .external-link} | +| Channel | Create | [conversations.create](https://api.slack.com/methods/conversations.create){:target=blank .external-link} | +| Channel | Get | [conversations.info](https://api.slack.com/methods/conversations.info){:target=blank .external-link} | +| Channel | Get Many | [conversations.list](https://api.slack.com/methods/conversations.list){:target=blank .external-link} | +| Channel | History | [conversations.history](https://api.slack.com/methods/conversations.history){:target=blank .external-link} | +| Channel | Invite | [conversations.invite](https://api.slack.com/methods/conversations.invite){:target=blank .external-link} | +| Channel | Join | [conversations.join](https://api.slack.com/methods/conversations.join){:target=blank .external-link} | +| Channel | Kick | [conversations.kick](https://api.slack.com/methods/conversations.kick){:target=blank .external-link} | +| Channel | Leave | [conversations.leave](https://api.slack.com/methods/conversations.leave){:target=blank .external-link} | +| Channel | Member | [conversations.members](https://api.slack.com/methods/conversations.members){:target=blank .external-link} | +| Channel | Open | [conversations.open](https://api.slack.com/methods/conversations.open){:target=blank .external-link} | +| Channel | Rename | [conversations.rename](https://api.slack.com/methods/conversations.rename){:target=blank .external-link} | +| Channel | Replies | [conversations.replies](https://api.slack.com/methods/conversations.replies){:target=blank .external-link} | +| Channel | Set Purpose | [conversations.setPurpose](https://api.slack.com/methods/conversations.setPurpose){:target=blank .external-link} | +| Channel | Set Topic | [conversations.setTopic](https://api.slack.com/methods/conversations.setTopic){:target=blank .external-link} | +| Channel | Unarchive | [conversations.unarchive](https://api.slack.com/methods/conversations.unarchive){:target=blank .external-link} | +| File | Get | [files.info](https://api.slack.com/methods/files.info){:target=blank .external-link} | +| File | Get Many | [files.list](https://api.slack.com/methods/files.list){:target=blank .external-link} | +| File | Upload | [files.upload](https://api.slack.com/methods/files.upload){:target=blank .external-link} | +| Message | Delete | [chat.delete](https://api.slack.com/methods/chat.delete){:target=blank .external-link} | +| Message | Get Permalink | [chat.getPermalink](https://api.slack.com/methods/chat.getPermalink){:target=blank .external-link} | +| Message | Search | [search.messages](https://api.slack.com/methods/search.messages){:target=blank .external-link} | +| Message | Send | [chat.postMessage](https://api.slack.com/methods/chat.postMessage){:target=blank .external-link} | +| Message | Send and Wait for Approval | [chat.postMessage](https://api.slack.com/methods/chat.postMessage){:target=blank .external-link} | +| Message | Update | [chat.update](https://api.slack.com/methods/chat.update){:target=blank .external-link} | +| Reaction | Add | [reactions.add](https://api.slack.com/methods/reactions.add){:target=blank .external-link} | +| Reaction | Get | [reactions.get](https://api.slack.com/methods/reactions.get){:target=blank .external-link} | +| Reaction | Remove | [reactions.remove](https://api.slack.com/methods/reactions.remove){:target=blank .external-link} | +| Star | Add | [stars.add](https://api.slack.com/methods/stars.add){:target=blank .external-link} | +| Star | Delete | [stars.remove](https://api.slack.com/methods/stars.remove){:target=blank .external-link} | +| Star | Get Many | [stars.list](https://api.slack.com/methods/stars.list){:target=blank .external-link} | +| User | Get | [users.info](https://api.slack.com/methods/users.info){:target=blank .external-link} | +| User | Get Many | [users.list](https://api.slack.com/methods/users.list){:target=blank .external-link} | +| User | Get User's Profile | [users.profile.get](https://api.slack.com/methods/users.profile.get){:target=blank .external-link} | +| User | Get User's Status | [users.getPresence](https://api.slack.com/methods/users.getPresence){:target=blank .external-link} | +| User | Update User's Profile | [users.profile.set](https://api.slack.com/methods/users.profile.set){:target=blank .external-link} | +| User Group | Create | [usergroups.create](https://api.slack.com/methods/usergroups.create){:target=blank .external-link} | +| User Group | Disable | [usergroups.disable](https://api.slack.com/methods/usergroups.disable){:target=blank .external-link} | +| User Group | Enable | [usergroups.enable](https://api.slack.com/methods/usergroups.enable){:target=blank .external-link} | +| User Group | Get Many | [usergroups.list](https://api.slack.com/methods/usergroups.list){:target=blank .external-link} | +| User Group | Update | [usergroups.update](https://api.slack.com/methods/usergroups.update){:target=blank .external-link} | + + + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.sms77.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: seven node documentation +description: Learn how to use the seven node in n8n. Follow technical documentation to integrate seven node into your workflows. +contentType: [integration, reference] +--- + +# seven node + +Use the seven node to automate work in seven, and integrate seven with other applications. n8n has built-in support for a wide range of seven features, including sending SMS, and converting text to voice. + +On this page, you'll find a list of operations the seven node supports and links to more resources. + +/// note | Credentials +Refer to [seven credentials](/integrations/builtin/credentials/sms77.md) for guidance on setting up authentication. +/// + +## Operations + +* SMS + * Send SMS +* Voice Call + * Converts text to voice and calls a given number + +## Templates and examples + + +[[ templatesWidget(page.title, 'sms77') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.snowflake.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Snowflake node documentation +description: Learn how to use the Snowflake node in n8n. Follow technical documentation to integrate Snowflake node into your workflows. +contentType: [integration, reference] +--- + +# Snowflake node + +Use the Snowflake node to automate work in Snowflake, and integrate Snowflake with other applications. n8n has built-in support for a wide range of Snowflake features, including executing SQL queries, and inserting rows in a database. + +On this page, you'll find a list of operations the Snowflake node supports and links to more resources. + +/// note | Credentials +Refer to [Snowflake credentials](/integrations/builtin/credentials/snowflake.md) for guidance on setting up authentication. +/// + +## Operations + +* Execute an SQL query. +* Insert rows in database. +* Update rows in database. + +## Templates and examples + + +[[ templatesWidget(page.title, 'snowflake') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.splunk.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Splunk node documentation +description: Learn how to use the Splunk node in n8n. Follow technical documentation to integrate Splunk node into your workflows. +contentType: [integration, reference] +--- + +# Splunk node + +Use the Splunk node to automate work in Splunk, and integrate Splunk with other applications. n8n has built-in support for a wide range of Splunk features, including getting fired alerts reports, as well as deleting and getting search configuration. + +On this page, you'll find a list of operations the Splunk node supports and links to more resources. + +/// note | Credentials +Refer to [Splunk credentials](/integrations/builtin/credentials/splunk.md) for guidance on setting up authentication. +/// + +## Operations + +* Fired Alert + * Get a fired alerts report +* Search Configuration + * Delete a search configuration + * Get a search configuration + * Get many search configurations +* Search Job + * Create a search job + * Delete a search job + * Get a search job + * Get many search jobs +* Search Result + * Get many search results +* User + * Create a user + * Delete a user + * Get a user + * Get many users + * Update a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'splunk') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.spontit.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Spontit node documentation +description: Learn how to use the Spontit node in n8n. Follow technical documentation to integrate Spontit node into your workflows. +contentType: [integration, reference] +--- + +# Spontit node + +Use the Spontit node to automate work in Spontit, and integrate Spontit with other applications. n8n supports creating push notifications with Spontit. + +On this page, you'll find a list of operations the Spontit node supports and links to more resources. + +/// note | Credentials +Refer to [Spontit credentials](/integrations/builtin/credentials/spontit.md) for guidance on setting up authentication. +/// + +## Operations + +* Push + * Create a push notification + +## Templates and examples + + +[[ templatesWidget(page.title, 'spontit') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.spotify.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Spotify node documentation +description: Learn how to use the Spotify node in n8n. Follow technical documentation to integrate Spotify node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Spotify node + +Use the Spotify node to automate work in Spotify, and integrate Spotify with other applications. n8n has built-in support for a wide range of Spotify features, including getting album and artist information. + +On this page, you'll find a list of operations the Spotify node supports and links to more resources. + +/// note | Credentials +Refer to [Spotify credentials](/integrations/builtin/credentials/spotify.md) for guidance on setting up authentication. +/// + +## Operations + +* Album + * Get an album by URI or ID. + * Get a list of new album releases. + * Get an album's tracks by URI or ID. + * Search albums by keyword. +* Artist + * Get an artist by URI or ID. + * Get an artist's albums by URI or ID. + * Get an artist's related artists by URI or ID. + * Get an artist's top tracks by URI or ID. + * Search artists by keyword. +* Library + * Get the user's liked tracks. +* My Data + * Get your followed artists. +* Player + * Add a song to your queue. + * Get your currently playing track. + * Skip to your next track. + * Pause your music. + * Skip to your previous song. + * Get your recently played tracks. + * Resume playback on the current active device. + * Set volume on the current active device. + * Start playing a playlist, artist, or album. +* Playlist + * Add tracks from a playlist by track and playlist URI or ID. + * Create a new playlist. + * Get a playlist by URI or ID. + * Get a playlist's tracks by URI or ID. + * Get a user's playlists. + * Remove tracks from a playlist by track and playlist URI or ID. + * Search playlists by keyword. +* Track + * Get a track by its URI or ID. + * Get audio features for a track by URI or ID. + * Search tracks by keyword + +## Templates and examples + + +[[ templatesWidget(page.title, 'spotify') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.stackby.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Stackby node documentation +description: Learn how to use the Stackby node in n8n. Follow technical documentation to integrate Stackby node into your workflows. +contentType: [integration, reference] +--- + +# Stackby node + +Use the Stackby node to automate work in Stackby, and integrate Stackby with other applications. n8n has built-in support for a wide range of Stackby features, including appending, deleting, listing and reading. + +On this page, you'll find a list of operations the Stackby node supports and links to more resources. + +/// note | Credentials +Refer to [Stackby credentials](/integrations/builtin/credentials/stackby.md) for guidance on setting up authentication. +/// + +## Operations + +- Append +- Delete +- List +- Read + +## Templates and examples + + +[[ templatesWidget(page.title, 'stackby') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.storyblok.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Storyblok node documentation +description: Learn how to use the Storyblok node in n8n. Follow technical documentation to integrate Storyblok node into your workflows. +contentType: [integration, reference] +--- + +# Storyblok node + +Use the Storyblok node to automate work in Storyblok, and integrate Storyblok with other applications. n8n has built-in support for a wide range of Storyblok features, including getting, deleting, and publishing stories. + +On this page, you'll find a list of operations the Storyblok node supports and links to more resources. + +/// note | Credentials +Refer to [Storyblok credentials](/integrations/builtin/credentials/storyblok.md) for guidance on setting up authentication. +/// + +## Operations + +### Content API + +- **Story** + - Get a story + - Get all stories + + +### Management API + +- **Story** + - Delete a story + - Get a story + - Get all stories + - Publish a story + - Unpublish a story + +## Templates and examples + + +[[ templatesWidget(page.title, 'storyblok') ]] + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.strapi.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Strapi node documentation +description: Learn how to use the Strapi node in n8n. Follow technical documentation to integrate Strapi node into your workflows. +contentType: [integration, reference] +--- + +# Strapi node + +Use the Strapi node to automate work in Strapi, and integrate Strapi with other applications. n8n has built-in support for a wide range of Strapi features, including creating and deleting entries. + +On this page, you'll find a list of operations the Strapi node supports and links to more resources. + +/// note | Credentials +Refer to [Strapi credentials](/integrations/builtin/credentials/strapi.md) for guidance on setting up authentication. +/// + +## Operations + +* Entry + * Create + * Delete + * Get + * Get Many + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'strapi') ]] + +## Related resources + +Refer to [Strapi's documentation](https://docs.strapi.io/dev-docs/api/rest){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.strava.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Strava node documentation +description: Learn how to use the Strava node in n8n. Follow technical documentation to integrate Strava node into your workflows. +contentType: [integration, reference] +--- + +# Strava node + +Use the Strava node to automate work in Strava, and integrate Strava with other applications. n8n has built-in support for a wide range of Strava features, including creating new activities, and getting activity information. + +On this page, you'll find a list of operations the Strava node supports and links to more resources. + +/// note | Credentials +Refer to [Strava credentials](/integrations/builtin/credentials/strava.md) for guidance on setting up authentication. +/// + +## Operations + +* Activity + * Create a new activity + * Get an activity + * Get all activities + * Get all activity comments + * Get all activity kudos + * Get all activity laps + * Get all activity zones + * Update an activity + +## Templates and examples + + +[[ templatesWidget(page.title, 'strava') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.stripe.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Stripe node documentation +description: Learn how to use the Stripe node in n8n. Follow technical documentation to integrate Stripe node into your workflows. +contentType: [integration, reference] +--- + +# Stripe node + +Use the Stripe node to automate work in Stripe, and integrate Stripe with other applications. n8n has built-in support for a wide range of Stripe features, including getting balance, creating charge, and deleting customers. + +On this page, you'll find a list of operations the Stripe node supports and links to more resources. + +/// note | Credentials +Refer to [Stripe credentials](/integrations/builtin/credentials/stripe.md) for guidance on setting up authentication. +/// + +## Operations + +* Balance + * Get a balance +* Charge + * Create a charge + * Get a charge + * Get all charges + * Update a charge +* Coupon + * Create a coupon + * Get all coupons +* Customer + * Create a customer + * Delete a customer + * Get a customer + * Get all customers + * Update a customer +* Customer Card + * Add a customer card + * Get a customer card + * Remove a customer card +* Source + * Create a source + * Delete a source + * Get a source +* Token + * Create a token + +## Templates and examples + + +[[ templatesWidget(page.title, 'stripe') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.supabase/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Supabase node common issues +description: Documentation for common issues and questions in the Supabase node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Supabase node common issues + +Here are some common errors and issues with the [Supabase node](/integrations/builtin/app-nodes/n8n-nodes-base.supabase/index.md) and steps to resolve or troubleshoot them. + +## Filtering rows by metadata + +To filter rows by [Supabase metadata](https://supabase.com/docs/guides/ai/python/metadata), set the **Select Type** to **String**. + +From there, you can construct a query in the **Filters (String)** parameter to filter the metadata using the [Supabase metadata query language](https://supabase.com/docs/guides/ai/python/metadata#metadata-query-language), inspired by the [MongoDB selectors](https://www.mongodb.com/docs/manual/reference/operator/query/) format. Access the metadata properties using the [Postgres `->>` arrow JSON operator](https://www.postgresql.org/docs/current/functions-json.html#FUNCTIONS-JSON-PROCESSING) like this (curly brackets denote components to fill in): + +``` +metadata->>{your-property}={comparison-operator}.{comparison-value} +``` + +For example to access an `age` property in the metadata and return results greater than or equal to 21, you could enter the following in the **Filters (String)** field: + +``` +metadata->>age=gte.21 +``` + +You can combine these operators to construct more complex queries. + +## Can't connect to a local Supabase database when using Docker + +When you run Supabase in Docker, you need to configure the network so that n8n can connect to Supabase. + +The solution depends on how you're hosting the two components. + +### If only Supabase is in Docker + +If only Supabase is running in Docker, the Docker Compose file used by the [self-hosting guide](https://supabase.com/docs/guides/self-hosting/docker) already runs Supabase bound to the correct interfaces. + +When configuring [Supabase credentials](/integrations/builtin/credentials/supabase.md), the `localhost` address should work without a problem (set the **Host** to `localhost`). + +### If Supabase and n8n are running in separate Docker containers + +If both n8n and Supabase are running in Docker in separate containers, you can use Docker networking to connect them. + +Configure Supabase to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official [Docker compose configuration](https://supabase.com/docs/guides/self-hosting/docker) already does this this). Add both the Supabase and n8n components to the same [user-defined bridge network](https://docs.docker.com/engine/network/drivers/bridge/) if you aren't already managing them together in the same Docker Compose file. + +When configuring [Supabase credentials](/integrations/builtin/credentials/supabase.md), use the Supabase API gateway container's name (`supabase-kong` by default) as the host address instead of `localhost`. For example, if you use the default configuration, you would set the **Host** to `http://supabase-kong:8000`. + +## Records are accessible through Postgres but not Supabase + +If queries for records return empty using the Supabase node, but are available through the [Postgres](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/index.md) node or with a Postgres client, there may be a conflict with Supabase's [Row Level Security (RLS)](https://supabase.com/docs/guides/database/postgres/row-level-security) policy. + +Supabase always enables RLS when you create a table in a public schema with the Table Editor. When RLS is active, the API doesn't return any data with the public `anon` key until you create policies. This is a security measure to ensure that you only expose data you intend to. + +To access data from a table with RLS enabled as the `anon` role, [create a policy](https://supabase.com/docs/guides/database/postgres/row-level-security#creating-policies) to enable the access patterns you intend to use. + + +# integrations/builtin/app-nodes/n8n-nodes-base.supabase/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Supabase node documentation +description: Learn how to use the Supabase node in n8n. Follow technical documentation to integrate Supabase node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Supabase node + +Use the Supabase node to automate work in Supabase, and integrate Supabase with other applications. n8n has built-in support for a wide range of Supabase features, including creating, deleting, and getting rows. + +On this page, you'll find a list of operations the Supabase node supports and links to more resources. + +/// note | Credentials +Refer to [Supabase credentials](/integrations/builtin/credentials/supabase.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Row + * Create a new row + * Delete a row + * Get a row + * Get all rows + * Update a row + +## Templates and examples + + +[[ templatesWidget(page.title, 'supabase') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-base.supabase/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.syncromsp.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SyncroMSP node documentation +description: Learn how to use the SyncroMSP node in n8n. Follow technical documentation to integrate SyncroMSP node into your workflows. +contentType: [integration, reference] +--- + +# SyncroMSP node + +Use the SyncroMSP node to automate work in SyncroMSP, and integrate SyncroMSP with other applications. n8n has built-in support for a wide range of SyncroMSP features, including creating and deleting new customers, tickets, and contacts. + +On this page, you'll find a list of operations the SyncroMSP node supports and links to more resources. + +/// note | Credentials +Refer to [SyncroMSP credentials](/integrations/builtin/credentials/syncromsp.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create new contact + * Delete contact + * Retrieve contact + * Retrieve all contacts + * Update contact +* Customer + * Create new customer + * Delete customer + * Retrieve customer + * Retrieve all customers + * Update customer +* RMM + * Create new RMM Alert + * Delete RMM Alert + * Retrieve RMM Alert + * Retrieve all RMM Alerts + * Mute RMM Alert +* Ticket + * Create new ticket + * Delete ticket + * Retrieve ticket + * Retrieve all tickets + * Update ticket + +## Templates and examples + + +[[ templatesWidget(page.title, 'syncromsp') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.taiga.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Taiga node documentation +description: Learn how to use the Taiga node in n8n. Follow technical documentation to integrate Taiga node into your workflows. +contentType: [integration, reference] +--- + +# Taiga node + +Use the Taiga node to automate work in Taiga, and integrate Taiga with other applications. n8n has built-in support for a wide range of Taiga features, including creating, updating, deleting, and getting issues. + +On this page, you'll find a list of operations the Taiga node supports and links to more resources. + +/// note | Credentials +Refer to [Taiga credentials](/integrations/builtin/credentials/taiga.md) for guidance on setting up authentication. +/// + +## Operations + +- **Issue** + - Create an issue + - Delete an issue + - Get an issue + - Get all issues + - Update an issue + +## Templates and examples + + +[[ templatesWidget(page.title, 'taiga') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.tapfiliate.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Tapfiliate node documentation +description: Learn how to use the Tapfiliate node in n8n. Follow technical documentation to integrate Tapfiliate node into your workflows. +contentType: [integration, reference] +--- + +# Tapfiliate node + +Use the Tapfiliate node to automate work in Tapfiliate, and integrate Tapfiliate with other applications. n8n has built-in support for a wide range of Tapfiliate features, including creating and deleting affiliates, and adding affiliate metadata. + +On this page, you'll find a list of operations the Tapfiliate node supports and links to more resources. + +/// note | Credentials +Refer to [Tapfiliate credentials](/integrations/builtin/credentials/tapfiliate.md) for guidance on setting up authentication. +/// + +## Operations + +* Affiliate + * Create an affiliate + * Delete an affiliate + * Get an affiliate by ID + * Get all affiliates +* Affiliate Metadata + * Add metadata to affiliate + * Remove metadata from affiliate + * Update affiliate's metadata +* Program Affiliate + * Add affiliate to program + * Approve an affiliate for a program + * Disapprove an affiliate + * Get an affiliate in a program + * Get all affiliates in program + +## Templates and examples + + +[[ templatesWidget(page.title, 'tapfiliate') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.telegram/callback-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Telegram node Callback operations documentation +description: Documentation for the Callback operations in the Telegram node in n8n, a workflow automation platform. Includes details to configure all Callback operations. +contentType: [integration, reference] +priority: critical +--- + +# Telegram node Callback operations + +Use these operations to respond to callback queries sent from the in-line keyboard or in-line queries. Refer to [Telegram](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md) for more information on the Telegram node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Answer Query + +Use this operation to send answers to callback queries sent from [inline keyboards](https://core.telegram.org/bots/features#inline-keyboards){:target=_blank .external-link} using the Bot API [answerCallbackQuery](https://core.telegram.org/bots/api#answercallbackquery){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Callback**. +* **Operation**: Select **Answer Query**. +* **Query ID**: Enter the unique identifier of the query you want to answer. + * To feed a Query ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node triggered on the **Callback Query**. +* **Results**: Enter a JSON-serialized array of results you want to use as answers to the query. Refer to the Telegram [InlineQueryResults](https://core.telegram.org/bots/api#inlinequeryresult){:target=_blank .external-link} documentation for more information on formatting your array. + +Refer to the Telegram Bot API [answerCallbackQuery](https://core.telegram.org/bots/api#answercallbackquery){:target=_blank .external-link} documentation for more information. + + +### Answer Query additional fields + +Use the **Additional Fields** to further refine the behavior of the node. Select **Add Field** to add any of the following: + +* **Cache Time**: Enter the maximum amount of time in seconds that the client may cache the result of the callback query. Telegram defaults to `0` seconds for this method. +* **Show Alert**: Telegram can display the answer as a notification at the top of the chat screen or as an alert. Choose whether you want to keep the default notification display (turned off) or display the answer as an alert (turned on). +* **Text**: If you want the answer to show text, enter up to 200 characters of text here. +* **URL**: Enter a URL that will be opened by the user's client. Refer to the **url** parameter instructions at the Telegram Bot API [answerCallbackQuery](https://core.telegram.org/bots/api#answercallbackquery){:target=_blank .external-link} documentation for more information. + + +## Answer Inline Query + +Use this operation to send answers to callback queries sent from inline queries using the Bot API [answerInlineQuery](https://core.telegram.org/bots/api#answerinlinequery){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Callback**. +* **Operation**: Select **Answer Inline Query**. +* **Query ID**: Enter the unique identifier of the query you want to answer. + * To feed a Query ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node triggered on the **Inline Query**. +* **Results**: Enter a JSON-serialized array of results you want to use as answers to the query. Refer to the Telegram [InlineQueryResults](https://core.telegram.org/bots/api#inlinequeryresult){:target=_blank .external-link} documentation for more information on formatting your array. + +Telegram allows a maximum of 50 results per query. + +Refer to the Telegram Bot API [answerInlineQuery](https://core.telegram.org/bots/api#answerinlinequery){:target=_blank .external-link} documentation for more information. + + +### Answer Inline Query additional fields + +Use the **Additional Fields** to further refine the behavior of the node. Select **Add Field** to add any of the following: + +* **Cache Time**: The maximum amount of time in seconds that the client may cache the result of the callback query. Telegram defaults to `300` seconds for this method. +* **Show Alert**: Telegram can display the answer as a notification at the top of the chat screen or as an alert. Choose whether you want to keep the default notification display (turned off) or display the answer as an alert (turned on). +* **Text**: If you want the answer to show text, enter up to 200 characters of text here. +* **URL**: Enter a URL that the user's client will open. + + +# integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Telegram node Chat operations documentation +description: Documentation for the Chat operations in the Telegram node in n8n, a workflow automation platform. Includes details to configure all Chat operations. +contentType: [integration, reference] +priority: critical +--- + +# Telegram node Chat operations + +Use these operations to get information about chats, members, administrators, leave chat, and set chat titles and descriptions. Refer to [Telegram](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md) for more information on the Telegram node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Get Chat + +Use this operation to get up to date information about a chat using the Bot API [getChat](https://core.telegram.org/bots/api#getchat){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Chat**. +* **Operation**: Select **Get**. +* **Chat ID**: Enter the Chat ID or username of the target channel in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. + +Refer to the Telegram Bot API [getChat](https://core.telegram.org/bots/api#getchat){:target=_blank .external-link} documentation for more information. + +## Get Administrators + +Use this operation to get a list of all administrators in a chat using the Bot API [getChatAdministrators](https://core.telegram.org/bots/api#getchatadministrators){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Chat**. +* **Operation**: Select **Get Administrators**. +* **Chat ID**: Enter the Chat ID or username of the target channel in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. + +Refer to the Telegram Bot API [getChatAdministrators](https://core.telegram.org/bots/api#getchatadministrators){:target=_blank .external-link} documentation for more information. + +## Get Chat Member + +Use this operation to get the details of a chat member using the Bot API [getChatMember](https://core.telegram.org/bots/api#getchatmember){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Chat**. +* **Operation**: Select **Get Member**. +* **Chat ID**: Enter the Chat ID or username of the target channel in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **User ID**: Enter the unique identifier of the user whose information you want to get. + +Refer to the Telegram Bot API [getChatMember](https://core.telegram.org/bots/api#getchatmember){:target=_blank .external-link} documentation for more information. + +## Leave Chat + +Use this operation to leave a chat using the Bot API [leaveChat](https://core.telegram.org/bots/api#leavechat){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Chat**. +* **Operation**: Select **Leave**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to leave in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. + +Refer to the Telegram Bot API [leaveChat](https://core.telegram.org/bots/api#leavechat){:target=_blank .external-link} documentation for more information. + +## Set Description + +Use this operation to set the description of a chat using the Bot API [setChatDescription](https://core.telegram.org/bots/api#setchatdescription){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Chat**. +* **Operation**: Select **Set Description**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to leave in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Description**: Enter the new description you'd like to set the chat to use, maximum of 255 characters. + +Refer to the Telegram Bot API [setChatDescription](https://core.telegram.org/bots/api#setchatdescription){:target=_blank .external-link} documentation for more information. + +## Set Title + +Use this operation to set the title of a chat using the Bot API [setChatTitle](https://core.telegram.org/bots/api#setchattitle){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Chat**. +* **Operation**: Select **Set Title**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to leave in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Title**: Enter the new title you'd like to set the chat to use, maximum of 255 characters. + +Refer to the Telegram Bot API [setChatTitle](https://core.telegram.org/bots/api#setchattitle){:target=_blank .external-link} documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Telegram node common issues +description: Documentation for common issues and questions in the Telegram node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: critical +--- + +# Telegram node common issues + +Here are some common errors and issues with the [Telegram node](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md) and steps to resolve or troubleshoot them. + +## Add a bot to a Telegram channel + +For a bot to send a message to a channel, you must add the bot to the channel. If you haven't added the bot to the channel, you'll see an error with a description like: +`Error: Forbidden: bot is not a participant of the channel`. + +To add a bot to a channel: + +1. In the Telegram app, access the target channel and select the channel name. +2. Label the channel name as **public channel**. +3. Select **Administrators** > **Add Admin**. +4. Search for the bot's username and select it. +5. Select the checkmark on the top-right corner to add the bot to the channel. + +## Get the Chat ID + +You can only use `@channelusername` on public channels. To interact with a Telegram group, you need that group's Chat ID. + +There are three ways to get that ID: + +1. From the Telegram Trigger: Use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node in your workflow to get a Chat ID. This node can trigger on different events and returns a Chat ID on successful execution. +2. From your web browser: Open Telegram in a web browser and open the group chat. The group's Chat ID is the series of digits behind the letter "g." Prefix your group Chat ID with a `-` when you enter it in n8n. +3. Invite Telegram's [@RawDataBot](https://t.me/RawDataBot){:target=_blank .external-link} to the group: Once you add it, the bot outputs a JSON file that includes a `chat` object. The `id` for that object is the group Chat ID. Then remove the RawDataBot from your group. + +## Send more than 30 messages per second + +The Telegram API has a [limitation](https://core.telegram.org/bots/faq#broadcasting-to-users){:target=_blank .external-link} of sending only 30 messages per second. Follow these steps to send more than 30 messages: + +1. **Loop Over Items node**: Use the [Loop Over Items](/integrations/builtin/core-nodes/n8n-nodes-base.splitinbatches.md) node to get at most 30 chat IDs from your database. +2. **Telegram node**: Connect the Telegram node with the Loop Over Items node. Use the **Expression Editor** to select the Chat IDs from the Loop Over Items node. +3. **Code node**: Connect the [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node with the Telegram node. Use the Code node to wait for a few seconds before fetching the next batch of chat IDs. Connect this node with the Loop Over Items node. + +You can also use this [workflow](https://n8n.io/workflows/772){:target=_blank .external-link}. + +## Remove the n8n attribution from sent messages + +If you're using the node to [send Telegram messages](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-message), the message automatically gets an n8n attribution appended to the end: + +> This message was sent automatically with n8n + +To remove this attribution: + +1. In the node's **Additional Fields** section, select **Add Field**. +2. Select **Append n8n attribution**. +3. Turn the toggle off. + +Refer to [Send Message additional fields](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-message-additional-fields) for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.telegram/file-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Telegram node File operations documentation +description: Documentation for the File operations in the Telegram node in n8n, a workflow automation platform. Includes details to configure all File operations. +contentType: [integration, reference] +priority: critical +--- + +# Telegram node File operations + +Use this operation to get a file from Telegram. Refer to [Telegram](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md) for more information on the Telegram node itself. + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Get File + +Use this operation to get a file from Telegram using the Bot API [getFile](https://core.telegram.org/bots/api#getfile){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **File**. +* **Operation**: Select **Get**. +* **File ID**: Enter the ID of the file you want to get. +* **Download**: Choose whether you want the node to download the file (turned on) or not (turned off). + +Refer to the Telegram Bot API [getFile](https://core.telegram.org/bots/api#getfile){:target=_blank .external-link} documentation for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Telegram node documentation +description: Documentation for the Telegram node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# Telegram node + +Use the Telegram node to automate work in [Telegram](https://telegram.org/){:target=_blank .external-link} and integrate Telegram with other applications. n8n has built-in support for a wide range of Telegram features, including getting files as well as deleting and editing messages. + +On this page, you'll find a list of operations the Telegram node supports and links to more resources. + +/// note | Credentials +Refer to [Telegram credentials](/integrations/builtin/credentials/telegram.md) for guidance on setting up authentication. +/// + +## Operations + +* [**Chat** operations](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md) + * [**Get**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md#get-chat) up-to-date information about a chat. + * [**Get Administrators**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md#get-administrators): Get a list of all administrators in a chat. + * [**Get Member**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md#get-chat-member): Get the details of a chat member. + * [**Leave**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md#leave-chat) a chat. + * [**Set Description**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md#set-description) of a chat. + * [**Set Title**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/chat-operations.md#set-title) of a chat. +* [**Callback** operations](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/callback-operations.md) + * [**Answer Query**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/callback-operations.md#answer-query): Send answers to callback queries sent from [inline keyboards](https://core.telegram.org/bots/features#inline-keyboards){:target=_blank .external-link}. + * [**Answer Inline Query**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/callback-operations.md#answer-inline-query): Send answers to callback queries sent from inline queries. +* [**File** operations](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/file-operations.md) + * [**Get File**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/file-operations.md#get-file) from Telegram. +* [**Message** operations](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md) + * [**Delete Chat Message**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#delete-chat-message). + * [**Edit Message Text**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#edit-message-text): Edit the text of an existing message. + * [**Pin Chat Message**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#pin-chat-message) for the chat. + * [**Send Animation**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-animation) to the chat. + * For use with GIFs or H.264/MPEG-4 AVC videos without sound up to 50 MB in size. + * [**Send Audio**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-audio) file to the chat and display it in the music player. + * [**Send Chat Action**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-chat-action): Tell the user that something is happening on the bot's side. The status is set for 5 seconds or less. + * [**Send Document**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-document) to the chat. + * [**Send Location**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-location): Send a geolocation to the chat. + * [**Send Media Group**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-media-group): Send a group of photos and/or videos. + * [**Send Message**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-message) to the chat. + * [**Send Photo**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-photo) to the chat. + * [**Send Sticker**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-sticker) to the chat. + * For use with static .WEBP, animated .TGS, or video .WEBM stickers. + * [**Send Video**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#send-video) to the chat. + * [**Unpin Chat Message**](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md#unpin-chat-message) from the chat. + + /// note | Add bot to channel + To use most of the **Message** operations, you must add your bot to a channel so that it can send messages to that channel. Refer to [Common Issues | Add a bot to a Telegram channel](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#add-a-bot-to-a-telegram-channel) for more information. + /// + + ## Templates and examples + + +[[ templatesWidget(page.title, 'telegram') ]] + +## Related resources + +Refer to [Telegram's API documentation](https://core.telegram.org/bots/api){:target=_blank .external-link} for more information about the service. + +n8n provides a trigger node for Telegram. Refer to the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-base.telegram/message-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Telegram node Message operations documentation +description: Documentation for the Message operations in the Telegram node in n8n, a workflow automation platform. Includes details to configure all Message operations. +contentType: [integration, reference] +priority: critical +--- + +# Telegram node Message operations + +Use these operations to send, edit, and delete messages in a chat; send files to a chat; and pin/unpin message from a chat. Refer to [Telegram](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md) for more information on the Telegram node itself. + +/// note | Add bot to channel +To use most of these operations, you must add your bot to a channel so that it can send messages to that channel. Refer to [Common Issues | Add a bot to a Telegram channel](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#add-a-bot-to-a-telegram-channel) for more information. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" +s +## Delete Chat Message + +Use this operation to delete a message from chat using the Bot API [deleteMessage](https://core.telegram.org/bots/api#deletemessage){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Delete Chat Message**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to delete in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Message ID**: Enter the unique identifier of the message you want to delete. + +Refer to the Telegram Bot API [deleteMessage](https://core.telegram.org/bots/api#deletemessage){:target=_blank .external-link} documentation for more information. + +## Edit Message Text + +Use this operation to edit the text of an existing message using the Bot API [editMessageText](https://core.telegram.org/bots/api#editmessagetext){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Edit Message Text**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to leave in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Message ID**: Enter the unique identifier of the message you want to edit. +* **Reply Markup**: Select whether to use the **Inline Keyboard** to display the InlineKeyboardMarkup **None** not to. This sets the `reply_markup` parameter. Refer to the [InlineKeyboardMarkup](https://core.telegram.org/bots/api#inlinekeyboardmarkup){:target=_blank .external-link} documentation for more information. +* **Text**: Enter the text you want to edit the message to. + +Refer to the Telegram Bot API [editMessageText](https://core.telegram.org/bots/api#editmessagetext){:target=_blank .external-link} documentation for more information. + + +### Edit Message Text additional fields + +Use the **Additional Fields** to further refine the behavior of the node. Select **Add Field** to add any of the following: + +* **Disable WebPage Preview**: Select whether you want to enable link previews for links in this message (turned off) or disable link previews for links in this message (turned on). This sets the `link_preview_options` parameter for `is_disabled`. Refer to the [LinkPreviewOptions](https://core.telegram.org/bots/api#linkpreviewoptions){:target=_blank .external-link} documentation for more information. +* **Parse Mode**: Choose whether the message should be parsed using **HTML** (default), **Markdown (Legacy)**, or **MarkdownV2**. This sets the `parse_mode` parameter. + + +## Pin Chat Message + +Use this operation to pin a message for the chat using the Bot API [pinChatMessage](https://core.telegram.org/bots/api#pinchatmessage){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Pin Chat Message**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to pin the message to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Message ID**: Enter the unique identifier of the message you want to pin. + +Refer to the Telegram Bot API [pinChatMessage](https://core.telegram.org/bots/api#pinchatmessage){:target=_blank .external-link} documentation for more information. + + +### Pin Chat Message additional fields + +Use the **Additional Fields** to further refine the behavior of the node. Select **Add Field** to add any of the following: + +* **Disable Notifications**: By default, Telegram will notify all chat members that the message has been pinned. If you don't want these notifications to go out, turn this control on. Sets the `disable_notification` parameter to `true`. + + +## Send Animation + +Use this operation to send GIFs or H.264/MPEG-4 AVC videos without sound up to 50 MB in size to the chat using the Bot API [sendAnimation](https://core.telegram.org/bots/api#sendanimation){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Animation**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the animation to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Binary File**: To send a binary file from the node itself, turn this option on. If you turn this parameter on, you must enter the **Input Binary Field** containing the file you want to send. +* **Animation**: If you aren't using the **Binary File**, enter the animation to send here. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to the Telegram Bot API [sendAnimation](https://core.telegram.org/bots/api#sendanimation){:target=_blank .external-link} documentation for more information. + + +### Send Animation additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendAnimation method. Select **Add Field** to add any of the following: + +* **Caption**: Enter a caption text for the animation, max of 1024 characters. +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Duration**: Enter the animation's duration in seconds. +* **Height**: Enter the height of the animation. +* **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to Telegram's [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. +* **Thumbnail**: Add the thumbnail of the file sent. Ignore this field if thumbnail generation for the file is supported server-side. The thumbnail should meet these specs: + * JPEG format + * Less than 200 KB in size + * Width and height less than 320px. +* **Width**: Enter the width of the video clip. + + + +### Send Audio + +Use this operation to send an audio file to the chat and display it in the music player using the Bot API [sendAudio](https://core.telegram.org/bots/api#sendaudio){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Audio**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the audio to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Binary File**: To send a binary file from the node itself, turn this option on. If you turn this parameter on, you must enter the **Input Binary Field** containing the file you want to send. +* **Audio**: If you aren't using the **Binary File**, enter the audio to send here. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to the Telegram Bot API [sendAudio](https://core.telegram.org/bots/api#sendaudio){:target=_blank .external-link} documentation for more information. + + +### Send Audio additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendAudio method. Select **Add Field** to add any of the following: + +* **Caption**: Enter a caption text for the audio, max of 1024 characters. +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Duration**: Enter the audio's duration in seconds. +* **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to Telegram's [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. +* **Performer**: Enter the name of the performer. +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. +* **Title**: Enter the audio track's name. +* **Thumbnail**: Add the thumbnail of the file sent. Ignore this field if thumbnail generation for the file is supported server-side. The thumbnail should meet these specs: + * JPEG format + * Less than 200 KB in size + * Width and height less than 320px. + + +## Send Chat Action + +Use this operation when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less using the Bot API [sendChatAction](https://core.telegram.org/bots/api#sendchataction){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Chat Action**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the chat action to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Action**: Select the action you'd like to broadcast the bot as taking. The options here include: **Find Location**, **Typing**, **Recording** audio or video, and **Uploading** file types. + +Refer to Telegram's Bot API [sendChatAction](https://core.telegram.org/bots/api#sendchataction){:target=_blank .external-link} documentation for more information. + +## Send Document + +Use this operation to send a document to the chat using the Bot API [sendDocument](https://core.telegram.org/bots/api#senddocument){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Document**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the document to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Binary File**: To send a binary file from the node itself, turn this option on. If you turn this parameter on, you must enter the **Input Binary Field** containing the file you want to send. +* **Document**: If you aren't using the **Binary File**, enter the document to send here. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to Telegram's Bot API [sendDocument](https://core.telegram.org/bots/api#sendchataction){:target=_blank .external-link} documentation for more information. + + +### Send Document additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendDocument method. Select **Add Field** to add any of the following: + +* **Caption**: Enter a caption text for the file, max of 1024 characters. +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. +* **Thumbnail**: Add the thumbnail of the file sent. Ignore this field if thumbnail generation for the file is supported server-side. The thumbnail should meet these specs: + * JPEG format + * Less than 200 KB in size + * Width and height less than 320px. + + +## Send Location + +Use this operation to send a geolocation to the chat using the Bot API [sendLocation](https://core.telegram.org/bots/api#sendlocation){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Location**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the location to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Latitude**: Enter the latitude of the location. +* **Longitude**: Enter the longitude of the location. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to Telegram's Bot API [sendLocation](https://core.telegram.org/bots/api#sendlocation){:target=_blank .external-link} documentation for more information. + + +### Send Location additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendLocation method. Select **Add Field** to add any of the following: + +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. + + + +## Send Media Group + +Use this operation to send a group of photos and/or videos using the Bot API [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Media Group**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the media group to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Media**: Use **Add Media** to add different media types to your media group. For each medium, select: + * **Type**: The type of media this is. Choose from **Photo** and **Video**. + * **Media File**: Enter the media file to send. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. + * **Additional Fields**: For each media file, you can choose to add these fields: + * **Caption**: Enter a caption text for the file, max of 1024 characters. + * **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. + +Refer to Telegram's Bot API [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup){:target=_blank .external-link} documentation for more information. + + +### Send Media Group additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendMediaGroup method. Select **Add Field** to add any of the following: + +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. + + +## Send Message + +Use this operation to send a message to the chat using the Bot API [sendMessage](https://core.telegram.org/bots/api#sendmessage){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Message**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the message to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Text**: Enter the text to send, max 4096 characters after entities parsing. + +Refer to Telegram's Bot API [sendMessage](https://core.telegram.org/bots/api#sendmessage){:target=_blank .external-link} documentation for more information. + +/// warning | Send Message limits +Telegram limits the number of messages you can send to 30 per second. If you expect to hit this limit, refer to [Send more than 30 messages per second](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#send-more-than-30-messages-per-second) for a suggested workaround. +/// + + +### Send Message additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendMessage method. Select **Add Field** to add any of the following: + +* **Append n8n Attribution**: Choose whether to include the phrase `This message was sent automatically with n8n` to the end of the message (turned on, default) or not (turned off). +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Disable WebPage Preview**: Select whether you want to enable link previews for links in this message (turned off) or disable link previews for links in this message (turned on). This sets the `link_preview_options` parameter for `is_disabled`. Refer to the [LinkPreviewOptions](https://core.telegram.org/bots/api#linkpreviewoptions){:target=_blank .external-link} documentation for more information. +* **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to Telegram's [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. + + + +## Send and Wait for Response + +Use this operation to send a message to the chat using the Bot API [`sendMessage`](https://core.telegram.org/bots/api#sendmessage) method and pause the workflow execution until the user confirms the operation. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send and Wait for Response**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the message to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Message**: Enter the text to send. +* **Response Type**: The approval or response type to use: + * **Approval**: Users can approve or disapprove from within the message. + * **Free Text**: Users can submit a response with a form. + * **Custom Form**: Users can submit a response with a custom form. + +Refer to Telegram's Bot API [`sendMessage`](https://core.telegram.org/bots/api#sendmessage) documentation for more information. + +/// warning | Send Message limits +Telegram limits the number of messages you can send to 30 per second. If you expect to hit this limit, refer to [Send more than 30 messages per second](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#send-more-than-30-messages-per-second) for a suggested workaround. +/// + + +### Send and Wait for Response additional fields + +The additional fields depend on which **Response Type** you choose. + +#### Approval + +The **Approval** response type adds these options: + +* **Type of Approval**: Whether to present only an approval button or both an approval and disapproval buttons. +* **Button Label**: The label for the approval or disapproval button. The default choice is `✅ Approve` and `❌ Decline` for approval and disapproval actions respectively. +* **Limit Wait Time**: Whether the workflow will automatically resume execution after a specified time limit. This can be an interval or a specific wall time. + +#### Free Text + +When using the Free Text response type, the following options are available: + +* **Message Button Label**: The label to use for message button. The default choice is `Respond`. +* **Response Form Title**: The title of the form where users provide their response. +* **Response Form Description**: A description for the form where users provide their response. +* **Response Form Button Label**: The label for the button on the form to submit their response. The default choice is `Submit`. +* **Limit Wait Time**: Whether the workflow will automatically resume execution after a specified time limit. This can be an interval or a specific wall time. + +#### Custom Form + +When using the Custom Form response type, you build a form using the fields and options you want. + +You can customize each form element with the settings outlined in the [n8n Form trigger's form elements](/integrations/builtin/core-nodes/n8n-nodes-base.formtrigger.md#form-elements). To add more fields, select the **Add Form Element** button. + +The following options are also available: + +* **Message Button Label**: The label to use for message button. The default choice is `Respond`. +* **Response Form Title**: The title of the form where users provide their response. +* **Response Form Description**: A description for the form where users provide their response. +* **Response Form Button Label**: The label for the button on the form to submit their response. The default choice is `Submit`. +* **Limit Wait Time**: Whether the workflow will automatically resume execution after a specified time limit. This can be an interval or a specific wall time. + + + +## Send Photo + +Use this operation to send a photo to the chat using the Bot API [sendPhoto](https://core.telegram.org/bots/api#sendphoto){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Photo**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the photo to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Binary File**: To send a binary file from the node itself, turn this option on. If you turn this parameter on, you must enter the **Input Binary Field** containing the file you want to send. +* **Photo**: If you aren't using the **Binary File**, enter the photo to send here. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to Telegram's Bot API [sendPhoto](https://core.telegram.org/bots/api#sendphoto){:target=_blank .external-link} documentation for more information. + + +### Send Photo additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendPhoto method. Select **Add Field** to add any of the following: + +* **Caption**: Enter a caption text for the file, max of 1024 characters. +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to Telegram's [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. + + +## Send Sticker + +Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers using the Bot API [sendSticker](https://core.telegram.org/bots/api#sendsticker){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Sticker**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the sticker to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Binary File**: To send a binary file from the node itself, turn this option on. If you turn this parameter on, you must enter the **Input Binary Field** containing the file you want to send. +* **Sticker**: If you aren't using the **Binary File**, enter the photo to send here. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to Telegram's Bot API [sendSticker](https://core.telegram.org/bots/api#sendsticker){:target=_blank .external-link} documentation for more information. + + +### Send Sticker additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendSticker method. Select **Add Field** to add any of the following: + +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. + + +## Send Video + +Use this operation to send a video to the chat using the Bot API [sendVideo](https://core.telegram.org/bots/api#sendvideo){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Send Video**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to send the video to in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Binary File**: To send a binary file from the node itself, turn this option on. If you turn this parameter on, you must enter the **Input Binary Field** containing the file you want to send. +* **Video**: If you aren't using the **Binary File**, enter the video to send here. Pass a `file_id` to send a file that exists on the Telegram servers (recommended) or an HTTP URL for Telegram to get a file from the internet. +* **Reply Markup**: Use this parameter to set more interface options. Refer to [Reply Markup parameters](#reply-markup-parameters) for more information on these options and how to use them. + +Refer to Telegram's Bot API [sendVideo](https://core.telegram.org/bots/api#sendvideo){:target=_blank .external-link} documentation for more information. + + +### Send Video additional fields + +Use the **Additional Fields** to further refine the behavior of the node using optional fields in Telegram's sendVideo method. Select **Add Field** to add any of the following: + +* **Caption**: Enter a caption text for the video, max of 1024 characters. +* **Disable Notification**: Choose whether to send the notification silently (turned on) or with a standard notification (turned off). +* **Duration**: Enter the video's duration in seconds. +* **Height**: Enter the height of the video. +* **Parse Mode**: Enter the parser to use for any related text. Options include **HTML** (default), **Markdown (Legacy)**, **MarkdownV2**. Refer to Telegram's [Formatting options](https://core.telegram.org/bots/api#formatting-options){:target=_blank .external-link} for more information on these options. +* **Reply To Message ID**: If the message is a reply, enter the ID of the message it's replying to. +* **Message Thread ID**: Enter a unique identifier for the target message thread (topic) of the forum; for forum supergroups only. +* **Thumbnail**: Add the thumbnail of the file sent. Ignore this field if thumbnail generation for the file is supported server-side. The thumbnail should meet these specs: + * JPEG format + * Less than 200 KB in size + * Width and height less than 320px. +* **Width**: Enter the width of the video. + + + +## Unpin Chat Message + +Use this operation to unpin a message from the chat using the Bot API [unpinChatMessage](https://core.telegram.org/bots/api#unpinchatmessage){:target=_blank .external-link} method. + +Enter these parameters: + +* **Credential to connect with**: Create or select an existing [Telegram credential](/integrations/builtin/credentials/telegram.md). +* **Resource**: Select **Message**. +* **Operation**: Select **Pin Chat Message**. +* **Chat ID**: Enter the Chat ID or username of the channel you wish to unpin the message from in the format `@channelusername`. + * To feed a Chat ID directly into this node, use the [Telegram Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.telegramtrigger/index.md) node. Refer to [Common Issues | Get the Chat ID](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/common-issues.md#get-the-chat-id) for more information. +* **Message ID**: Enter the unique identifier of the message you want to unpin. + +Refer to the Telegram Bot API [unpinChatMessage](https://core.telegram.org/bots/api#unpinchatmessage){:target=_blank .external-link} documentation for more information. + +## Reply Markup parameters + +For most of the **Message** **Send** actions (such as Send Animation, Send Audio), use the **Reply Markup** parameter to set more interface options: + +* **Force Reply**: The Telegram client will act as if the user has selected the bot's message and tapped **Reply**, automatically displaying a reply interface to the user. Refer to [Force Reply parameters](#force-reply-parameters) for further guidance on this option. +* **Inline Keyboard**: Display an inline keyboard right next to the message. Refer to [Inline Keyboard parameters](#inline-keyboard-parameters) for further guidance on this option. +* **Reply Keyboard**: Display a custom keyboard with reply options. Refer to [Reply Keyboard parameters](#reply-keyboard-parameters) for further guidance on this option. +* **Reply Keyboard Remove**: The Telegram client will remove the current custom keyboard and display the default letter-keyboard. Refer to [Reply Keyboard parameters](#reply-keyboard-remove-parameters) for further guidance on this option. + +/// note | Telegram Business accounts +Telegram restricts the following options in channels and for messages sent on behalf of a Telegram Business account: + +* Force Reply +* Reply Keyboard +* Reply Keyboard Remove +/// + +### Force Reply parameters + +**Force Reply** is useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. + +If you select **Reply Markup > Force Reply**, choose from these **Force Reply** parameters: + +* **Force Reply**: Turn on to show the reply interface to the user, as described above. +* **Selective**: Turn this on if you want to force reply from these users only: + * Users that are `@mentioned` in the text of the message. + * The sender of the original message, if this Send Animation message is a reply to a message. + +Refer to [ForceReply](https://core.telegram.org/bots/api#forcereply){:target=_blank .external-link} for more information. + +### Inline Keyboard parameters + +If you select **Reply Markup > Inline Keyboard**, define the inline keyboard buttons you want to display using the **Add Button** option. To add more rows to your keyboard, use **Add Keyboard Row**. + +Refer to [InlineKeyboardMarkup](https://core.telegram.org/bots/api#inlinekeyboardmarkup){:target=_blank .external-link} and [InlineKeyboardButtons](https://core.telegram.org/bots/api#inlinekeyboardbutton){:target=_blank .external-link} for more information. + +### Reply Keyboard parameters + +If you select **Reply Markup > Reply Keyboard**, use the **Reply Keyboard** section to define the buttons and rows in your Reply Keyboard. + +Use the **Reply Keyboard Options** to further refine the keyboard's behavior: + +* **Resize Keyboard**: Choose whether to request the Telegram client to resize the keyboard vertically for optimal fit (turned on) or whether to use the same height as the app's standard keyboard (turned off). +* **One Time Keyboard**: Choose whether the Telegram client should hide the keyboard as soon as a user uses it (turned on) or to keep displaying it (turned off). +* **Selective**: Turn this on if you want to show the keyboard to these users only: + * Users that are `@mentioned` in the text of the message. + * The sender of the original message, if this Send Animation message is a reply to a message. + +Refer to [ReplyKeyboardMarkup](https://core.telegram.org/bots/api#replykeyboardmarkup){:target=_blank .external-link} for more information. + +### Reply Keyboard Remove parameters + +If you select **Reply Markup > Reply Keyboard Remove**, choose from these **Reply Keyboard Remove** parameters: + +* **Remove Keyboard**: Choose whether to request the Telegram client to remove the custom keyboard (turned on) or to keep it (turned off). +* **Selective**: Turn this on if you want to remove the keyboard for these users only: + * Users that are `@mentioned` in the text of the message. + * The sender of the original message, if this Send Animation message is a reply to a message. + +Refer to [ReplyKeyboardRemove](https://core.telegram.org/bots/api#replykeyboardremove){:target=_blank .external-link} for more information. + + +# integrations/builtin/app-nodes/n8n-nodes-base.thehive.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: TheHive node documentation +description: Learn how to use the TheHive node in n8n. Follow technical documentation to integrate TheHive node into your workflows. +contentType: [integration, reference] +--- + +# TheHive node + +Use the TheHive node to automate work in TheHive, and integrate TheHive with other applications. n8n has built-in support for a wide range of TheHive features, including creating alerts, counting tasks logs, cases, and observables. + +On this page, you'll find a list of operations the TheHive node supports and links to more resources. + +/// note | TheHive and TheHive 5 +n8n provides two nodes for TheHive. Use this node (TheHive) if you want to use TheHive's version 3 or 4 API. If you want to use version 5, use [TheHive 5](/integrations/builtin/app-nodes/n8n-nodes-base.thehive5.md). +/// +/// note | Credentials +Refer to [TheHive credentials](/integrations/builtin/credentials/thehive.md) for guidance on setting up authentication. +/// + +## Operations + +The available operations depend on your API version. To see the operations list, create your credentials, including selecting your API version. Then return to the node, select the resource you want to use, and n8n displays the available operations for your API version. + +* Alert +* Case +* Log +* Observable +* Task + +## Templates and examples + + +[[ templatesWidget(page.title, 'thehive') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Related resources + +n8n provides a trigger node for TheHive. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.thehivetrigger.md). + +Refer to TheHive's documentation for more information about the service: + +* [Version 3](https://docs.thehive-project.org/thehive/legacy/thehive3/api/){:target=_blank .external-link} +* [Version 4](https://docs.thehive-project.org/cortex/api/api-guide/){:target=_blank .external-link} + + +# integrations/builtin/app-nodes/n8n-nodes-base.thehive5.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: TheHive 5 node documentation +description: Learn how to use the TheHive 5 node in n8n. Follow technical documentation to integrate TheHive 5 node into your workflows. +contentType: [integration, reference] +--- + +# TheHive 5 node + +Use the TheHive 5 node to automate work in TheHive, and integrate TheHive with other applications. n8n has built-in support for a wide range of TheHive features, including creating alerts, counting tasks logs, cases, and observables. + +On this page, you'll find a list of operations the TheHive node supports and links to more resources. + +/// note | TheHive and TheHive 5 +n8n provides two nodes for TheHive. Use this node (TheHive 5) if you want to use TheHive's version 5 API. If you want to use version 3 or 4, use [TheHive](/integrations/builtin/app-nodes/n8n-nodes-base.thehive.md). +/// +/// note | Credentials +Refer to [TheHive credentials](/integrations/builtin/credentials/thehive5.md) for guidance on setting up authentication. +/// + +## Operations + +* Alert + * Create + * Delete + * Execute Responder + * Get + * Merge Into Case + * Promote to Case + * Search + * Update + * Update Status +* Case + * Add Attachment + * Create + * Delete Attachment + * Delete Case + * Execute Responder + * Get + * Get Attachment + * Get Timeline + * Search + * Update +* Comment + * Create + * Delete + * Search + * Update +* Observable + * Create + * Delete + * Execute Analyzer + * Execute Responder + * Get + * Search + * Update +* Page + * Create + * Delete + * Search + * Update +* Query + * Execute Query +* Task + * Create + * Delete + * Execute Responder + * Get + * Search + * Update +* Task Log + * Add Attachment + * Create + * Delete + * Delete Attachment + * Execute Responder + * Get + * Search + +## Templates and examples + + +[[ templatesWidget(page.title, 'thehive-5') ]] + +## Related resources + +n8n provides a trigger node for TheHive. You can find the trigger node docs [here](/integrations/builtin/trigger-nodes/n8n-nodes-base.thehive5trigger.md). + +Refer to TheHive's [documentation](https://docs.strangebee.com/){:target=_blank .external-link} for more information about the service. + + +# integrations/builtin/app-nodes/n8n-nodes-base.timescaledb.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: TimescaleDB node documentation +description: Learn how to use the TimescaleDB node in n8n. Follow technical documentation to integrate TimescaleDB node into your workflows. +contentType: [integration, reference] +--- + +# TimescaleDB node + +Use the TimescaleDB node to automate work in TimescaleDB, and integrate TimescaleDB with other applications. n8n has built-in support for a wide range of TimescaleDB features, including executing an SQL query, as well as inserting and updating rows in a database. + +On this page, you'll find a list of operations the TimescaleDB node supports and links to more resources. + +/// note | Credentials +Refer to [TimescaleDB credentials](/integrations/builtin/credentials/timescaledb.md) for guidance on setting up authentication. +/// + +## Operations + +* Execute an SQL query +* Insert rows in database +* Update rows in database + +## Templates and examples + + +[[ templatesWidget(page.title, 'timescaledb') ]] + +## Specify a column's data type + +To specify a column's data type, append the column name with `:type`, where `type` is the data type you want for the column. For example, if you want to specify the type `int` for the column **id** and type `text` for the column **name**, you can use the following snippet in the **Columns** field: `id:int,name:text`. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.todoist.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Todoist node documentation +description: Learn how to use the Todoist node in n8n. Follow technical documentation to integrate Todoist node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Todoist node + +Use the Todoist node to automate work in Todoist, and integrate Todoist with other applications. n8n has built-in support for a wide range of Todoist features, including creating, updating, deleting, and getting tasks. + +On this page, you'll find a list of operations the Todoist node supports and links to more resources. + +/// note | Credentials +Refer to [Todoist credentials](/integrations/builtin/credentials/todoist.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Task + * Create a new task + * Close a task + * Delete a task + * Get a task + * Get all tasks + * Reopen a task + * Update a task + +## Templates and examples + + +[[ templatesWidget(page.title, 'todoist') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.travisci.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Travis CI node documentation +description: Learn how to use the Travis CI node in n8n. Follow technical documentation to integrate Travis CI node into your workflows. +contentType: [integration, reference] +--- + +# Travis CI node + +Use the Travis CI node to automate work in Travis CI, and integrate Travis CI with other applications. n8n has built-in support for a wide range of Travis CI features, including cancelling and getting builds. + +On this page, you'll find a list of operations the Travis CI node supports and links to more resources. + +/// note | Credentials +Refer to [Travis CI credentials](/integrations/builtin/credentials/travisci.md) for guidance on setting up authentication. +/// + +## Operations + +* Build + * Cancel a build + * Get a build + * Get all builds + * Restart a build + * Trigger a build + +## Templates and examples + + +[[ templatesWidget(page.title, 'travisci') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.trello.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Trello node documentation +description: Learn how to use the Trello node in n8n. Follow technical documentation to integrate Trello node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Trello node + +Use the Trello node to automate work in Trello, and integrate Trello with other applications. n8n has built-in support for a wide range of Trello features, including creating and updating cards, and adding and removing members. + +On this page, you'll find a list of operations the Trello node supports and links to more resources. + +/// note | Credentials +Refer to [Trello credentials](/integrations/builtin/credentials/trello.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Attachment + * Create a new attachment for a card + * Delete an attachment + * Get the data of an attachment + * Returns all attachments for the card +* Board + * Create a new board + * Delete a board + * Get the data of a board + * Update a board +* Board Member + * Add + * Get All + * Invite + * Remove +* Card + * Create a new card + * Delete a card + * Get the data of a card + * Update a card +* Card Comment + * Create a comment on a card + * Delete a comment from a card + * Update a comment on a card +* Checklist + * Create a checklist item + * Create a new checklist + * Delete a checklist + * Delete a checklist item + * Get the data of a checklist + * Returns all checklists for the card + * Get a specific checklist on a card + * Get the completed checklist items on a card + * Update an item in a checklist on a card +* Label + * Add a label to a card. + * Create a new label + * Delete a label + * Get the data of a label + * Returns all labels for the board + * Remove a label from a card. + * Update a label. +* List + * Archive/Unarchive a list + * Create a new list + * Get the data of a list + * Get all the lists + * Get all the cards in a list + * Update a list + +## Templates and examples + + +[[ templatesWidget(page.title, 'trello') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Find the List ID + +1. Open the Trello board that contains the list. +2. If the list doesn't have any cards, add a card to the list. +3. Open the card, add `.json` at the end of the URL, and press enter. +4. In the JSON file, you will see a field called `idList`. +5. Copy the contents of the `idList`field and paste it in the ***List ID** field in n8n. + + + + + + + + +# integrations/builtin/app-nodes/n8n-nodes-base.twake.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Twake node documentation +description: Learn how to use the Twake node in n8n. Follow technical documentation to integrate Twake node into your workflows. +contentType: [integration, reference] +--- + +# Twake node + +Use the Twake node to automate work in Twake, and integrate Twake with other applications. n8n supports sending messages with Twake. + +On this page, you'll find a list of operations the Twake node supports and links to more resources. + +/// note | Credentials +Refer to [Twake credentials](/integrations/builtin/credentials/twake.md) for guidance on setting up authentication. +/// + +## Operations + +* Message + * Send a message + +## Templates and examples + + +[[ templatesWidget(page.title, 'twake') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.twilio.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Twilio node documentation +description: Learn how to use the Twilio node in n8n. Follow technical documentation to integrate Twilio node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Twilio node + +Use the Twilio node to automate work in Twilio, and integrate Twilio with other applications. n8n supports sending MMS/SMS and WhatsApp messages with Twilio. + +On this page, you'll find a list of operations the Twilio node supports and links to more resources. + +/// note | Credentials +Refer to [Twilio credentials](/integrations/builtin/credentials/twilio.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* SMS + * Send SMS/MMS/WhatsApp message +* Call + * Make a phone call using text-to-speech to say a message + +## Templates and examples + + +[[ templatesWidget(page.title, 'twilio') ]] + +## Related resources + +Refer to [Twilio's documentation](https://www.twilio.com/docs/usage/api){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.twist.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Twist node documentation +description: Learn how to use the Twist node in n8n. Follow technical documentation to integrate Twist node into your workflows. +contentType: [integration, reference] +--- + +# Twist node + +Use the Twist node to automate work in Twist, and integrate Twist with other applications. n8n has built-in support for a wide range of Twist features, including creating conversations in a channel, as well as creating and deleting comments on a thread. + +On this page, you'll find a list of operations the Twist node supports and links to more resources. + +/// note | Credentials +Refer to [Twist credentials](/integrations/builtin/credentials/twist.md) for guidance on setting up authentication. +/// + +## Operations + +* Channel + * Archive a channel + * Initiates a public or private channel-based conversation + * Delete a channel + * Get information about a channel + * Get all channels + * Unarchive a channel + * Update a channel +* Comment + * Create a new comment to a thread + * Delete a comment + * Get information about a comment + * Get all comments + * Update a comment +* Message Conversation + * Create a message in a conversation + * Delete a message in a conversation + * Get a message in a conversation + * Get all messages in a conversation + * Update a message in a conversation +* Thread + * Create a new thread in a channel + * Delete a thread + * Get information about a thread + * Get all threads + * Update a thread + +## Templates and examples + + +[[ templatesWidget(page.title, 'twist') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Get the User ID + +To get the User ID for a user: + +1. Open the **Team** tab. +2. Select a user's avatar. +3. Copy the string of characters located after `/u/` in your Twist URL. This string is the User ID. For example, if the URL is `https://twist.com/a/4qw45/people/u/475370` the User ID is `475370`. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.twitter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: X (Formerly Twitter) node documentation +description: Learn how to use the X (Formerly Twitter) node in n8n. Follow technical documentation to integrate X (Formerly Twitter) node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# X (Formerly Twitter) node + +Use the X node to automate work in X and integrate X with other applications. n8n has built-in support for a wide range of X features, including creating direct messages and deleting, searching, liking, and retweeting a tweet. + +On this page, you'll find a list of operations the X node supports and links to more resources. + +/// note | Credentials +Refer to [X credentials](/integrations/builtin/credentials/twitter.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Direct Message + * Create a direct message +* Tweet + * Create or reply a tweet + * Delete a tweet + * Search tweets + * Like a tweet + * Retweet a tweet +* User + * Get a user +* List + * Add a member to a list + +## Templates and examples + + +[[ templatesWidget(page.title, 'twitter') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.unleashedsoftware.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Unleashed Software node documentation +description: Learn how to use the Unleashed Software node in n8n. Follow technical documentation to integrate Unleashed Software node into your workflows. +contentType: [integration, reference] +--- + +# Unleashed Software node + +Use the Unleashed Software node to automate work in Unleashed Software, and integrate Unleashed Software with other applications. n8n has built-in support for a wide range of Unleashed Software features, including getting sales orders and stock on hand. + +On this page, you'll find a list of operations the Unleashed Software node supports and links to more resources. + +/// note | Credentials +Refer to [Unleashed Software credentials](/integrations/builtin/credentials/unleashedsoftware.md) for guidance on setting up authentication. +/// + +## Operations + +* Sales Order + * Get all sales orders +* Stock On Hand + * Get a stock on hand + * Get all stocks on hand + +## Templates and examples + + +[[ templatesWidget(page.title, 'unleashed-software') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.uplead.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: UpLead node documentation +description: Learn how to use the UpLead node in n8n. Follow technical documentation to integrate UpLead node into your workflows. +contentType: [integration, reference] +--- + +# UpLead node + +Use the UpLead node to automate work in UpLead, and integrate UpLead with other applications. n8n supports several UpLead operations, including getting company information. + +On this page, you'll find a list of operations the UpLead node supports and links to more resources. + +/// note | Credentials +Refer to [UpLead credentials](/integrations/builtin/credentials/uplead.md) for guidance on setting up authentication. +/// + +## Operations + +* Company + * Enrich +* Person + * Enrich + +## Templates and examples + + +[[ templatesWidget(page.title, 'uplead') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.uproc.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: uProc node documentation +description: Learn how to use the uProc node in n8n. Follow technical documentation to integrate uProc node into your workflows. +contentType: [integration, reference] +--- + +# uProc node + +Use the uProc node to automate work in uProc, and integrate uProc with other applications. n8n has built-in support for a wide range of uProc features, including getting advanced human audio file, communication data, company, finance and product information. + +On this page, you'll find a list of operations the uProc node supports and links to more resources. + +/// note | Credentials +Refer to [uProc credentials](/integrations/builtin/credentials/uproc.md) for guidance on setting up authentication. +/// + +## Operations + +### Audio + +- Get advanced human audio file by provided text and language +- Get an audio file by provided text and language + +### Communication + +- Discover if a domain has a social network presence +- Discover if an email is valid, hard bounce, soft bounce, spam-trap, free, temporary, and recipient exists +- Discover if the email recipient exists, returning email status +- Check if an email domain has an SMTP server to receive emails +- Discover if the email has a social network presence +- Check if an email has a valid format +- Check if an email domain belongs to a disposable email service +- Check if email belongs to free service provider like Gmail +- Check if email is catchall +- Discover if an email exists in the Robinson list (only Spain) +- Check if email belongs to a system or role-based account +- Check if an email is a spam trap +- Discover if an IMEI number has a valid format +- Check if a LinkedIn profile is a first-degree contact +- Discover if mobile phone number exists in network operator, with worldwide coverage +- Discover if a mobile phone number has a valid format with worldwide coverage +- Discover if a mobile phone number has a valid format (only Spain) +- Discover if a mobile phone number has a valid prefix, with worldwide coverage +- Discover if a Spanish mobile phone number has a valid prefix +- Discover if a mobile number is switched on to call it later, with worldwide coverage +- Discover if a mobile number can receive SMS with worldwide coverage +- Discover if a phone (landline or mobile) exists in a Robinson list (only Spain) +- Discover if a landline or mobile number has a valid prefix +- Discover if a landline phone number is valid, with Spain coverage +- Allows discovering if landline number has a good international format, depending on the country +- Discover if a landline phone number prefix exists, with worldwide coverage +- Clean a phone removing non allowed characters +- Allows getting country code of a mobile phone number with international format +- Allows getting a domain from an email +- Discover an email by company website or domain and prospect's first-name and last-name +- Check if an email is personal or generic +- Get emails list found on the internet by domain or URI +- Get an emails list found on the internet by non-free email +- Get emails list found inside the website by domain or URI +- Get three first web references of an email published on the internet +- Allows you to fix the email domain of those misspelled emails +- Fix the international prefix of a phone based on the ISO code of a country +- Get GDPR compliant emails list by domain for your Email Marketing campaigns in Europe +- Discover if mobile exist using real-time HLR query +- Get personal email by social network profile +- Get portability data about a landline or mobile number, only for Spain +- Extract results from a LinkedIn search (employees in a company) +- Get members in a LinkedIn group +- Get 'Search LinkedIn Contacts' URL +- Extract the last 80 connections from your LinkedIn profile +- Extract the last 80 invitations sent from your LinkedIn +- Get users who comment on a post on LinkedIn +- Get users who like a post on LinkedIn +- Extract a LinkedIn profile +- Extract results from a LinkedIn search (profiles) +- Extract last profiles that have published content on LinkedIn by specific keywords +- Discover if mobile exist using real-time HLR query, as well as portability and roaming data +- Get existence, portability, and roaming of a mobile phone using MNP query +- Discover if mobile or landline prefix exists in Spain +- Allows normalizing email address, removing non allowed characters +- Allows normalizing a mobile phone, removing non-allowed characters +- Parse phone number in multiple fields and verify format and prefix validity +- Allows getting country prefix number by country code +- Discover an email by company website or domain and prospect's first-name and last-name +- This tool parses a social URI address and extracts any available indicators +- Search all social networks by domain, parses all found URLs, and returns social networks data +- Discover if a domain or a website has social activity and returns all social network profiles found +- Discover if an email has social activity, and get all social network profiles found +- Discover if a mobile phone has social activity, and get all social network profiles found +- Get web references for an email published on the internet +- Send a custom message invitation to a non connected LinkedIn profile +- Send a custom email to a recipient +- Send a custom SMS to a recipient with worldwide coverage +- Send a custom invitation message if a profile is connected or a custom message otherwise +- Visits a profile to show interest and get profile views in return from contact, increasing your LinkedIn network +- Send a custom private message to a connected LinkedIn profile +- Get an email by contact's LinkedIn profile URI +- Discover an email by company's name and prospect's full name +- Discover an email by company's website or domain and prospect's full name +- Get email by first name, last name, and company +- Get parsed and validated phone + +### Company + +- Discover if a CIF card number is valid +- Check if a company is a debtor by TaxID +- Check if the ISIN number is valid +- Check if the SS number is valid, only for Spain +- Identify and classify a prospecting role in detecting the right area and seniority to filter later +- Get a company's contact, social, and technology data by domain +- Get a company's contact, social, and technology data by email +- Get a company's data by CIF +- Get a company's data by DUNS +- Get a company's data by domain +- Get a company's data by email +- Get a company's data by IP address +- Get a company's data by name +- Get a company's data by phone number +- Get a company's data by social networks URI (LinkedIn, Twitter) +- Get a company's name by company domain +- Get professional data of a decision-maker by company name/domain and area +- Discover more suitable decision-maker using search engines (Bing) by company name and area +- Get professional emails of decision-makers by company domain and area +- Discover up to ten decision-makers using search engines (Bing) by company name and area +- Get a company's domain by company name +- Get employees by company name or domain, area, seniority, and country +- Get a company's Facebook profile by name without manually searching on Google or Facebook +- Get geocoded company data by IP address +- Get a company's LinkedIn profile by name without manually searching on Google or LinkedIn +- Allows normalizing a CIF number, removing non-allowed characters +- Get a company's phone by company domain +- Get a company's sales data by a company's DUNS number +- Get a company's sales data by a company's domain name +- Get a company's sales data by a company's name +- Get a company's sales data by a company's tax ID (CIF) +- Get a company's Twitter profile by name without manually searching on Google or Twitter +- Get decision maker by search engine +- Get decision makers by search engine +- Get Facebook URI by company's domain +- Get GitHub URI by company's domain +- Get Instagram URI by company's domain +- Get LinkedIn URI by company's domain +- Get Pinterest URI by company's domain +- Get Twitter URI by company's domain +- Get YouTube URI by company's domain + +### Finance + +- Check if crypto wallet is valid +- Discover if a BIC number has a valid format +- Discover if an account number has a valid format +- Check if credit card number checksum is valid +- Discover if an IBAN account number has a valid format +- Discover if an ISO currency code is valid +- Check if a TIN exists in Europe +- Convert amount between supported currencies and an exchange date +- Get credit card type +- Get multiple ISO currency codes by a country name +- Get all ISO currency by an IP address +- Get multiple ISO currency codes by a country ISO code +- Get ISO currency code by IP address +- Get ISO currency code by a currency ISO code +- Get ISO currency code by an ISO country code +- Get ISO currency code by a country name +- Get related European TIN in Europe +- Get IBAN by account number of the country +- Get to search data bank information by IBAN account number +- Get country VAT by address +- Get country VAT by coordinates +- Get Swift code lookup +- Get VAT by IP address +- Get VAT value by country ISO code +- Get VAT by phone number, with worldwide coverage +- Get VAT by zip code + + +### Geographical + +- Check if a country's ISO code exists +- Discover if the distance between two coordinates is equal to another +- Discover if the distance (kilometers) between two coordinates is greater than the given input +- Discover if the distance (kilometers) between two coordinates is greater or equal to the given input +- Discover if the distance(kilometers) between two coordinates is lower than the given input +- Check if an address exists by a partial address search +- Check if a house number exists by a partial address search +- Check if coordinates have a valid format +- Discover if a zip code number prefix exists (only for Spain) +- Discover if a zip code number has a valid format (only for Spain) +- Get cartesian coordinates(X, Y, Z/WGS84) by Latitude and Longitude +- Get location by parameters +- Get multiple cities by phone prefix (only for Spain) +- Get multiple cities by partial initial text (only for Spain) +- Get multiple cities by zip code prefix (only for Spain) +- Get a city from IP +- City search by partial name (only for Spain) +- Discover the city name by a local phone number (only for Spain) +- Discover the city name by the zip code (only for Spain) +- Discover the community name from a zip code (only for Spain) +- Discover latitude and longitude coordinates of an IP address +- Discover latitude and longitude coordinates of a postal address +- Get multiple country names by currency ISO code +- Get multiple countries by ISO code +- Get multiple country names by initial name +- Get country name by currency ISO code +- Get country name by IP address +- Get country name by its ISO code +- Get country by a prefix +- Get country name by phone number, with worldwide coverage +- Get Aplha2 code by a country prefix or a name +- Get decimal coordinates (degrees, minutes, and seconds) by latitude and longitude +- Returns straight-line distance (kilometers) between two addresses +- Returns straight-line distance (kilometers) between two GPS coordinates (latitude and longitude) +- Returns straight-line distance (kilometers) between two IP addresses +- Returns straight-line distance (kilometers) between two landline phones, using city and province of every phone +- Returns straight-line distance (kilometers) between two zip codes, using city and province of every zip code +- Get an exact address by a partial address search +- Discover geographical, company, timezone, and reputation data by IPv4 address +- Discover the city name, zip code, province, country, latitude, and longitude from an IPv4 or IPv6 address and geocodes it +- Parse postal address into separated fields, getting an improved resolution +- Discover locale data (currency, language) by IPv4 or IPv6 address +- Discover the city name, zip code, province, or country by latitude and longitude +- Discover the city name, zip code, province, country, latitude, and longitude from an IPv4 or IPv6 address +- Discover the city and the province from a landline phone number (only Spain) +- Discover location data by name +- Discover the city and the province from a zip code number (only Spain) +- Get the most relevant locations by name +- Get the most relevant locations by name, category, location, and radius +- Get multiple personal names by a prefix +- Discover network data by IPv4 or IPv6 address +- Allow normalizing an address by removing non allowed characters +- Allow normalizing a city by removing non allowed characters +- Allow normalizing a country by removing non allowed characters +- Allow normalizing a province by removing non allowed characters +- Allow normalizing a zip code by removing non allowed characters +- Get normalized country +- Parse postal address into separated fields, getting a basic resolution +- Discover the province name from an IP address +- Get the first province by a name prefix (only for Spain) +- Discover the province name from a landline phone number (only for Spain) +- Discover the province name from a zip code number (only for Spain) +- Get a province list by a name prefix (only for Spain) +- Get a province list by a phone prefix (only for Spain) +- Get a province list by a zip code prefix (only for Spain) +- Discover reputation by IPv4 or IPv6 address +- Returns driving routing time, distance, fuel consumption, and cost between two addresses +- Returns driving routing time, distance, fuel consumption, and cost between two GPS coordinates +- Returns driving routing time, distance, fuel consumption, and cost between two IP addresses +- Returns driving routing time, distance, fuel consumption, and cost between two landline phones, using city and province of every phone (only for Spain) +- Returns driving routing time, distance, fuel consumption, and cost between two zip codes, using city and province of every zip code +- Discover date-time data by IPv4 or IPv6 address +- Get USNG coordinates by latitude and longitude +- Get UTM coordinates by latitude and longitude +- Discover the zip code if you have an IP address +- Get the first zip code by prefix, only for Spain +- Get multiple zip codes by prefix, with worldwide coverage +- Get time data by coordinates +- Get time data by postal address + + +### Image + +- Get QR code decoded content by an image URL +- It allows discovering all geographical and technical EXIF metadata present in a photographic JPEG image +- Get an encoded barcode by number and a required standard +- Get QR code encoded by a text +- Generate a new image by URL and text +- Discover logo (favicon) used in a domain +- Generate a screenshot by URL provided using Chrome browser +- Get OCR text from image + + +### Internet + +- Check if a domain exists +- Check if a domain has a DNS record +- Check if a domain has the given IP address assigned +- Check if a domain has an MX record +- Check if a domain has a valid SSL certificate +- Check if a domain has a valid format +- Check if a domain accepts all emails, existing or not +- Check if a domain is a free service domain provider +- Check if a domain is temporary or not +- Discover if a computer is switched on +- Discover if service in a port is available +- Check if an URL contains a string or regular expression +- Check if an URL exists +- Check that an URL has a valid format +- Get full SSL certificate data by a domain (or website) and monitor your certificate status +- Get feed entries by domain +- Get last feed entry by domain +- Get text data from web, PDF or image allowing to filter some elements by regular expressions or field names +- Decode URL to recover original +- Get valid, existing, and default URL when accessing a domain using a web browser +- Get long version of shortened URL +- Discover device features by a user agent +- Get the network name of and IP address +- Get the domain record by its type +- Encode URL to avoid problems +- Copy file from one URL to another URL +- Fix an IP address to the right format +- Get the IPv4 address linked with a domain +- Convert a number to an IP address +- Get ISP known name of email domain name +- Convert an IP address to numeric notation +- Scan a host and returns the most commonly open ports +- Obtains a list with multiple results from a website +- Obtains the content of a website +- Decode URL into multiple fields +- Generate a PDF file by URL (provided using Chrome browser) +- Get the root domain of any web address, removing non needed characters +- Generates shareable URIs to use on social networks and email using a content URI and a text +- Get data from the existing table in an HTML page or a PDF file +- Discover client and server technologies used in a domain +- Discover client and server technologies used in web pages +- Analyze URL's health status about SSL, broken links, conflictive HTTP links with SSL, and more +- Get website visits and rank of any domain +- Get a domain's WHOIS data by fields +- Get WHOIS data fields by IP address provided + + +### Personal + +- Check if age is between two numbers +- Check if date returns an age between 20 and 29 +- Check if date returns an age between 40 and 49 +- Check if age is greater than another +- Check if birth date returns an age greater than 64 +- Check if birth date belongs to an adult (18 years for Spain) +- Check if age is lower than another +- Check if age is lower or equal than another +- Check if ages are equal +- Discover if a date is between two dates +- Discover if a date is greater +- Discover if a date is greater or equal +- Discover if a date belongs to a leap year +- Discover if a date is lower +- Discover if a date is lower or equal +- Discover if a date has a valid format +- Discover if a gender value is valid +- Discover if an NIE card number is valid +- Discover if a NIF card number is valid +- Check if a personal name exists in the INE data source (only for Spain) +- Check if a name contains accepted characters +- Discover if a NIF exists in the Robinson list (only for Spain) +- Check if surname contains accepted characters +- Check if a personal surname appears in INE data source (only for Spain) +- Discover if a DNI card number is valid +- Discover the age of a birth date +- Discover the age range of a person by birth date +- Get the difference between two dates +- Discover the gender of a person by the email +- Discover the gender of a person or company by the name +- Get LinkedIn employee profile URI by business email +- Get LinkedIn employee profile URI by first name, last name, and company +- Discover the letter of a DNI card number +- Get first personal name matching by prefix and gender from INE data source (only for Spain) +- Get LinkedIn URI by email +- Get LinkedIn URI by phone +- Allow normalizing a DNI number by removing non allowed characters +- Allow normalizing an NIE number by removing non allowed characters +- Normalize name by removing non allowed characters +- Normalize surname +- Get parsed date-time +- Normalize full name, fixing abbreviations, sorting if necessary, and returning first name, last name, and gender +- Get prospect's contact data and the company's location and social data by email +- Get contact, location, and social data by email and company name and location +- Get personal and social data by social profile +- Get personal data by email +- Get personal data by first name, last name, company, and location +- Get personal data by mobile +- Get personal data by social network profile +- Generate random fake data +- Get first personal surname matching by prefix from INE data source (only for Spain) +- Get personal surname matching by prefix from INE data source (only for Spain) +- Get Twitter profile by first name, last name, and company +- Get XING profile by first name, last name, and company +- Add a contact email to a person list + +### Product + +- Check if an ASIN code exists on the Amazon Marketplace +- Check if an ASIN code has a valid format +- Check if an EAN code exists on Amazon Marketplace +- Check if an EAN barcode has a valid format +- Check if an EAN barcode of 13 digits has a valid format +- Check if an EAN barcode of 14 digits has a valid format +- Check if an EAN barcode of 18 digits has a valid format +- Check if an EAN barcode of 8 digits has a valid format +- Check if a GTIN barcode has a valid format +- Check if a GTIN barcode of 13 digits has a valid format +- Check if a GTIN barcode of 14 digits has a valid format +- Check if a GTIN barcode of 8 digits has a valid format +- Check if VIN Number is valid +- Allows checking if an ISBN book exists +- Allows checking if an ISBN10/13 code has a valid format +- Allows checking if an ISBN10 code has a valid format +- Allows checking if an ISBN13 code has a valid format +- Check if a UPC exists +- Check if a UPC has a valid format +- Get ASIN by EAN +- Get a book by author's surname +- Get all publications by category +- Get book data by an editor's name +- Get book or publication data by 10 or 13 digits ISBN code +- Get book data by title +- Get books by author's surname +- Get all books by category +- Get all books by editor +- Get all books by title +- Get EAN code by ASIN code +- Get product data on a UPC on Amazon Marketplace +- Get ISBN10 code by ISBN13 code +- Get ISBN13 code by ISBN10 code +- Get data By VIN number + +### Security + +- Check if a Luhn number is valid +- Check if a password is strong +- Check if a UUID number is valid +- Get blacklists for a domain +- Get blacklists for an IP address + +### Text + +- Check if a string only contains alphabets +- Check if a string is alphanumeric +- Check if a string is boolean +- Check if the largest item in a list matches the provided item +- Check if IPv4 or IPv6 address has a valid format +- Check if IPv4 address has a valid format +- Check if IPv6 address has a valid format +- Check if the length of a list is between two quantities +- Checks if the length of a list equals a specified quantity +- Checks if the length of a list is greater than or equal to a certain amount +- Check if the length of a list is lower than a certain amount +- Check if the list contains a specific item +- Check if the list ends with a specific element +- Check if a list is sorted in ascending order +- Check if the list starts with a specific element +- Checks if the smallest element in a list matches the provided element +- Check if a string contains only numbers +- Check if a string contains a character +- Check if a string ends with a character +- Check if a string has no content +- Check if a string contains random characters +- Check if a string contains a value that matches with a regular expression +- Check if the length of a string is between two numbers +- Check if the length of a string is equal to a number +- Check if the length of a string is greater than a number +- Check if the length of a string is greater or equal to a number +- Check if the length of a string is lower than a number +- Check if the length of a string is lower or equal to a number +- Check if a string starts with a character +- Check if a string contains only lowercase characters +- Check if a string contains only uppercase characters +- Check if a list consists of unique elements +- Check if the supplied values form a valid list of elements +- Check if the number of words in a sentence is between two determined quantities +- Check if the number of words in a sentence equals a certain amount +- Check if the number of words in a sentence is greater than a certain amount +- Check if the number of words in a sentence is greater than +- Check if the word count is lower +- Check if the number of words present in a sentence is less than or equal to a quantity +- Convert a string to Base64 encoded value +- Discover banned English words in an email body or subject +- Get field names by analyzing the field value provided +- Get HTML code from Markdown +- Get Markdown text from HTML +- Get text without HTML +- Get spin string +- Format a string using a format pattern +- Generate random string using a regular expression as a pattern +- Return the largest item in a list +- Return the smallest item in a list +- Convert to lowercase +- Convert a string to MD5 encoded value +- Merge two strings +- Normalize a string depending on the field name +- Analyze string and return all emails, phones, zip codes, and links +- Convert a string to an SHA encoded value +- Analyze an English text with emojis and detect sentiment +- Returns an ascending sorted list +- Split a value into two parts and join them using a separator from the original string +- Split a value into two parts using a separator from the original string +- Get the length of a string +- Lookup string between multiple values by fuzzy logic and regex patterns +- Clean abuse words from a string +- Replace the first value found in a string with another +- Replace all values found in a string with another +- Translate a text into any language +- Return a single list with no repeating elements +- Convert all letters to uppercase +- Count total words in a text + +## Templates and examples + + +[[ templatesWidget(page.title, 'uproc') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.uptimerobot.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: UptimeRobot node documentation +description: Learn how to use the UptimeRobot node in n8n. Follow technical documentation to integrate UptimeRobot node into your workflows. +contentType: [integration, reference] +--- + +# UptimeRobot node + +Use the UptimeRobot node to automate work in UptimeRobot, and integrate UptimeRobot with other applications. n8n has built-in support for a wide range of UptimeRobot features, including creating and deleting alerts, as well as getting account details. + +On this page, you'll find a list of operations the UptimeRobot node supports and links to more resources. + +/// note | Credentials +Refer to [UptimeRobot credentials](/integrations/builtin/credentials/uptimerobot.md) for guidance on setting up authentication. +/// + +## Operations + +* Account + * Get account details +* Alert Contact + * Create an alert contact + * Delete an alert contact + * Get an alert contact + * Get all alert contacts + * Update an alert contact +* Maintenance Window + * Create a maintenance window + * Delete a maintenance window + * Get a maintenance window + * Get all a maintenance windows + * Update a maintenance window +* Monitor + * Create a monitor + * Delete a monitor + * Get a monitor + * Get all monitors + * Reset a monitor + * Update a monitor +* Public Status Page + * Create a public status page + * Delete a public status page + * Get a public status page + * Get all a public status pages + +## Templates and examples + + +[[ templatesWidget(page.title, 'uptimerobot') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.urlscanio.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: urlscan.io node documentation +description: Learn how to use the urlscan.io node in n8n. Follow technical documentation to integrate urlscan.io node into your workflows. +contentType: [integration, reference] +--- + +# urlscan.io node + +Use the urlscan.io node to automate work in urlscan.io, and integrate urlscan.io with other applications. n8n has built-in support for a wide range of urlscan.io features, including getting and performing scans. + +On this page, you'll find a list of operations the urlscan.io node supports and links to more resources. + +/// note | Credentials +Refer to [urlscan.io credentials](/integrations/builtin/credentials/urlscanio.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Scan + * Get + * Get All + * Perform + +## Templates and examples + + +[[ templatesWidget(page.title, 'urlscanio') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.venafitlsprotectcloud.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Venafi TLS Protect Cloud node documentation +description: Learn how to use the Venafi TLS Protect Cloud node in n8n. Follow technical documentation to integrate Venafi TLS Protect Cloud node into your workflows. +contentType: [integration, reference] +--- + +# Venafi TLS Protect Cloud node + +Use the Venafi TLS Protect Cloud node to automate work in Venafi TLS Protect Cloud, and integrate Venafi TLS Protect Cloud with other applications. n8n has built-in support for a wide range of Venafi TLS Protect Cloud features, including deleting and downloading certificates, as well as creating certificates requests. + +On this page, you'll find a list of operations the Venafi TLS Protect Cloud node supports and links to more resources. + +/// note | Credentials +Refer to [Venafi TLS Protect Cloud credentials](/integrations/builtin/credentials/venafitlsprotectcloud.md) for guidance on setting up authentication. +/// + +## Operations + +* Certificate + * Delete + * Download + * Get + * Get Many + * Renew +* Certificate Request + * Create + * Get + * Get Many + +## Templates and examples + + +[[ templatesWidget(page.title, 'venafi-tls-protect-cloud') ]] + +## Related resources + +Refer to [Venafi's REST API documentation](https://docs.venafi.cloud/api/vaas-rest-api/){:target=_blank .external-link} for more information on this service. + +n8n also provides: + +* A [trigger node](/integrations/builtin/trigger-nodes/n8n-nodes-base.venafitlsprotectcloudtrigger.md) for Venafi TLS Protect Cloud. +* A [node](/integrations/builtin/app-nodes/n8n-nodes-base.venafitlsprotectdatacenter.md) for Venafi TLS Protect Datacenter. + + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.venafitlsprotectdatacenter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Venafi TLS Protect Datacenter node documentation +description: Learn how to use the Venafi TLS Protect Datacenter node in n8n. Follow technical documentation to integrate Venafi TLS Protect Datacenter node into your workflows. +contentType: [integration, reference] +--- + + +# Venafi TLS Protect Datacenter node + +Use the Venafi TLS Protect Datacenter node to automate work in Venafi TLS Protect Datacenter, and integrate Venafi TLS Protect Datacenter with other applications. n8n has built-in support for a wide range of Venafi TLS Protect Datacenter features, including creating, deleting, and getting certificates. + +On this page, you'll find a list of operations the Venafi TLS Protect Datacenter node supports and links to more resources. + +/// note | Credentials +Refer to [Venafi TLS Protect Datacenter credentials](/integrations/builtin/credentials/venafitlsprotectdatacenter.md) for guidance on setting up authentication. +/// + +## Operations + +* Certificate + * Create + * Delete + * Download + * Get + * Get Many + * Renew +* Policy + * Get + +## Templates and examples + + +[[ templatesWidget(page.title, 'venafi-tls-protect-datacenter') ]] + +## Related resources + +n8n also provides: + +* A [node](/integrations/builtin/app-nodes/n8n-nodes-base.venafitlsprotectcloud.md) and [trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.venafitlsprotectcloudtrigger.md) node for Venafi TLS Protect Cloud. + + + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.vero.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Vero node documentation +description: Learn how to use the Vero node in n8n. Follow technical documentation to integrate Vero node into your workflows. +contentType: [integration, reference] +--- + +# Vero node + +Use the Vero node to automate work in Vero and integrate Vero with other applications. n8n has built-in support for a wide range of Vero features, including creating and deleting users. + +On this page, you'll find a list of operations the Vero node supports and links to more resources. + +/// note | Credentials +Refer to [Vero credentials](/integrations/builtin/credentials/vero.md) for guidance on setting up authentication. +/// + +## Operations + +* User + * Create or update a user profile + * Change a users identifier + * Unsubscribe a user. + * Resubscribe a user. + * Delete a user. + * Adds a tag to a users profile. + * Removes a tag from a users profile. +* Event + * Track an event for a specific customer + +## Templates and examples + + +[[ templatesWidget(page.title, 'vero') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.vonage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Vonage node documentation +description: Learn how to use the Vonage node in n8n. Follow technical documentation to integrate Vonage node into your workflows. +contentType: [integration, reference] +--- + +# Vonage node + +Use the Vonage node to automate work in Vonage, and integrate Vonage with other applications. n8n supports sending SMS with Vonage. + +On this page, you'll find a list of operations the Vonage node supports and links to more resources. + +/// note | Credentials +Refer to [Vonage credentials](/integrations/builtin/credentials/vonage.md) for guidance on setting up authentication. +/// + +## Operations + +* SMS + * Send + +## Templates and examples + + +[[ templatesWidget(page.title, 'vonage') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.webflow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Webflow node documentation +description: Learn how to use the Webflow node in n8n. Follow technical documentation to integrate Webflow node into your workflows. +contentType: [integration, reference] +--- + +# Webflow node + +Use the Webflow node to automate work in Webflow, and integrate Webflow with other applications. n8n has built-in support for a wide range of Webflow features, including creating, updating, deleting, and getting items. + +On this page, you'll find a list of operations the Webflow node supports and links to more resources. + +/// note | Credentials +Refer to [Webflow credentials](/integrations/builtin/credentials/webflow.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Item + * Create + * Delete + * Get + * Get All + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'webflow') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.wekan.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Wekan node documentation +description: Learn how to use the Wekan node in n8n. Follow technical documentation to integrate Wekan node into your workflows. +contentType: [integration, reference] +--- + +# Wekan node + +Use the Wekan node to automate work in Wekan, and integrate Wekan with other applications. n8n has built-in support for a wide range of Wekan features, including creating, updating, deleting, and getting boards and cards. + +On this page, you'll find a list of operations the Wekan node supports and links to more resources. + +/// note | Credentials +Refer to [Wekan credentials](/integrations/builtin/credentials/wekan.md) for guidance on setting up authentication. +/// + +## Operations + +* Board + * Create a new board + * Delete a board + * Get the data of a board + * Get all user boards +* Card + * Create a new card + * Delete a card + * Get a card + * Get all cards + * Update a card +* Card Comment + * Create a comment on a card + * Delete a comment from a card + * Get a card comment + * Get all card comments +* Checklist + * Create a new checklist + * Delete a checklist + * Get the data of a checklist + * Returns all checklists for the card +* Checklist Item + * Delete a checklist item + * Get a checklist item + * Update a checklist item +* List + * Create a new list + * Delete a list + * Get the data of a list + * Get all board lists + +## Templates and examples + + +[[ templatesWidget(page.title, 'wekan') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Load all the parameters for the node + +To load all the parameters, for example, Author ID, you need to give admin permissions to the user. Refer to the [Wekan documentation](https://github.com/wekan/wekan/wiki/Features#members-click-member-initials-or-avatar--permissions-adminnormalcomment-only){:target=_blank .external-link} to learn how to change permissions. + + + +# integrations/builtin/app-nodes/n8n-nodes-base.whatsapp/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: WhatsApp Business Cloud node common issues +description: Documentation for common issues and questions in the WhatsApp Business Cloud node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# WhatsApp Business Cloud node common issues + +Here are some common errors and issues with the [WhatsApp Business Cloud node](/integrations/builtin/app-nodes/n8n-nodes-base.whatsapp/index.md) and steps to resolve or troubleshoot them. + +## Bad request - please check your parameters + +This error occurs when WhatsApp Business Cloud rejects your request because of a problem with its parameters. It's common to see this when using the **Send Template** operation if the data you send doesn't match the format of your template. + +To resolve this issue, review the parameters in your [message template](https://www.facebook.com/business/help/2055875911147364?id=2129163877102343). Pay attention to each parameter's data type and the order they're defined in the template. + +Check the data that n8n is mapping to the template parameters. If you're using expressions to set parameter values, check the input data to make sure each item resolves to a valid value. You may want to use the [Edit Fields (Set) node](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) or [set a fallback value](/code/cookbook/expressions/check-incoming-data.md) to ensure you send a value with the correct format. + +## Working with non-text media + +The WhatsApp Business Cloud node can work with non-text messages and media like images, audio, documents, and more. + +If your operation includes a **Input Data Field Name** or **Property Name** parameter, set this to the field name itself rather than referencing the data in an expression. + +For example, if you are trying to send a message with an "Image" **MessageType** and **Take Image From** set to "n8n", set **Input Data Field Name** to a field name like `data` instead of an expression like `{{ $json.input.data }}`. + + +# integrations/builtin/app-nodes/n8n-nodes-base.whatsapp/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: WhatsApp Business Cloud node documentation +description: Learn how to use the WhatsApp Business Cloud node in n8n. Follow technical documentation to integrate WhatsApp Business Cloud node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# WhatsApp Business Cloud node + +Use the WhatsApp Business Cloud node to automate work in WhatsApp Business, and integrate WhatsApp Business with other applications. n8n has built-in support for a wide range of WhatsApp Business features, including sending messages, and uploading, downloading, and deleting media. + +On this page, you'll find a list of operations the WhatsApp Business Cloud node supports and links to more resources. + +/// note | Credentials +Refer to [WhatsApp Business Cloud credentials](/integrations/builtin/credentials/whatsapp.md) for guidance on setting up authentication. +/// + +## Operations + +* Message + * Send + * Send and Wait for Response + * Send Template +* Media + * Upload + * Download + * Delete + +--8<-- "_snippets/integrations/builtin/send-and-wait-operation.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'whatsapp-business-cloud') ]] + +## Related resources + +Refer to [WhatsApp Business Platform's Cloud API documentation](https://developers.facebook.com/docs/whatsapp/cloud-api){:target=_blank} for details about the operations. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-base.whatsapp/common-issues.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.wise.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Wise node documentation +description: Learn how to use the Wise node in n8n. Follow technical documentation to integrate Wise node into your workflows. +contentType: [integration, reference] +--- + +# Wise node + +Use the Wise node to automate work in Wise, and integrate Wise with other applications. n8n has built-in support for a wide range of Wise features, including getting profiles, exchange rates, and recipients. + +On this page, you'll find a list of operations the Wise node supports and links to more resources. + +/// note | Credentials +Refer to [Wise credentials](/integrations/builtin/credentials/wise.md) for guidance on setting up authentication. +/// + +## Operations + +* Account + * Retrieve balances for all account currencies of this user. + * Retrieve currencies in the borderless account of this user. + * Retrieve the statement for the borderless account of this user. +* Exchange Rate + * Get +* Profile + * Get + * Get All +* Recipient + * Get All +* Quote + * Create + * Get +* Transfer + * Create + * Delete + * Execute + * Get + * Get All + +## Templates and examples + + +[[ templatesWidget(page.title, 'wise') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.woocommerce.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: WooCommerce node documentation +description: Learn how to use the WooCommerce node in n8n. Follow technical documentation to integrate WooCommerce node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# WooCommerce node + +Use the WooCommerce node to automate work in WooCommerce, and integrate WooCommerce with other applications. n8n has built-in support for a wide range of WooCommerce features, including creating and deleting customers, orders, and products. + +On this page, you'll find a list of operations the WooCommerce node supports and links to more resources. + +/// note | Credentials +Refer to [WooCommerce credentials](/integrations/builtin/credentials/woocommerce.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Customer + * Create a customer + * Delete a customer + * Retrieve a customer + * Retrieve all customers + * Update a customer +* Order + * Create a order + * Delete a order + * Get a order + * Get all orders + * Update an order +* Product + * Create a product + * Delete a product + * Get a product + * Get all products + * Update a product + +## Templates and examples + + +[[ templatesWidget(page.title, 'woocommerce') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.wordpress.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: WordPress node documentation +description: Learn how to use the WordPress node in n8n. Follow technical documentation to integrate WordPress node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# WordPress node + +Use the WordPress node to automate work in WordPress, and integrate WordPress with other applications. n8n has built-in support for a wide range of WordPress features, including creating, updating, and getting posts and users. + +On this page, you'll find a list of operations the WordPress node supports and links to more resources. + +/// note | Credentials +Refer to [WordPress credentials](/integrations/builtin/credentials/wordpress.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Post + * Create a post + * Get a post + * Get all posts + * Update a post +* Pages + * Create a page + * Get a page + * Get all pages + * Update a page +* User + * Create a user + * Get a user + * Get all users + * Update a user + +## Templates and examples + + +[[ templatesWidget(page.title, 'wordpress') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + + +# integrations/builtin/app-nodes/n8n-nodes-base.xero.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Xero node documentation +description: Learn how to use the Xero node in n8n. Follow technical documentation to integrate Xero node into your workflows. +contentType: [integration, reference] +--- + +# Xero node + +Use the Xero node to automate work in Xero, and integrate Xero with other applications. n8n has built-in support for a wide range of Xero features, including creating, updating, and getting contacts and invoices. + +On this page, you'll find a list of operations the Xero node supports and links to more resources. + +/// note | Credentials +Refer to [Xero credentials](/integrations/builtin/credentials/xero.md) for guidance on setting up authentication. +/// + +## Operations + +* Contact + * Create a contact + * Get a contact + * Get all contacts + * Update a contact +* Invoice + * Create a invoice + * Get a invoice + * Get all invoices + * Update a invoice + +## Templates and examples + + +[[ templatesWidget(page.title, 'xero') ]] + +## Related resources + +Refer to [Xero's API documentation](https://developer.xero.com/documentation/api/accounting/overview){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.yourls.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Yourls node documentation +description: Learn how to use the Yourls node in n8n. Follow technical documentation to integrate Yourls node into your workflows. +contentType: [integration, reference] +--- + +# Yourls node + +Use the Yourls node to automate work in Yourls, and integrate Yourls with other applications. n8n has built-in support for a wide range of Yourls features, including expanding and shortening URLs. + +On this page, you'll find a list of operations the Yourls node supports and links to more resources. + +/// note | Credentials +Refer to [Yourls credentials](/integrations/builtin/credentials/yourls.md) for guidance on setting up authentication. +/// + +## Operations + +* URL + * Expand a URL + * Shorten a URL + * Get stats about one short URL + +## Templates and examples + + +[[ templatesWidget(page.title, 'yourls') ]] + + + +# integrations/builtin/app-nodes/n8n-nodes-base.youtube.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: YouTube node documentation +description: Learn how to use the YouTube node in n8n. Follow technical documentation to integrate YouTube node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# YouTube node + +Use the YouTube node to automate work in YouTube, and integrate YouTube with other applications. n8n has built-in support for a wide range of YouTube features, including retrieving and updating channels, as well as creating and deleting playlists. + +On this page, you'll find a list of operations the YouTube node supports and links to more resources. + +/// note | Credentials +Refer to [YouTube credentials](/integrations/builtin/credentials/google/index.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Channel + * Retrieve a channel + * Retrieve all channels + * Update a channel + * Upload a channel banner +* Playlist + * Create a playlist + * Delete a playlist + * Get a playlist + * Retrieve all playlists + * Update a playlist +* Playlist Item + * Add an item to a playlist + * Delete a item from a playlist + * Get a playlist's item + * Retrieve all playlist items +* Video + * Delete a video + * Get a video + * Retrieve all videos + * Rate a video + * Update a video + * Upload a video +* Video Category + * Retrieve all video categories + +## Templates and examples + + +[[ templatesWidget(page.title, 'youtube') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.zammad.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zammad node documentation +description: Learn how to use the Zammad node in n8n. Follow technical documentation to integrate Zammad node into your workflows. +contentType: [integration, reference] +--- + +# Zammad node + +Use the Zammad node to automate work in Zammad, and integrate Zammad with other applications. n8n has built-in support for a wide range of Zammad features, including creating, retrieving, and deleting groups and organizations. + +On this page, you'll find a list of operations the Zammad node supports and links to more resources. + +/// note | Credentials +Refer to [Zammad credentials](/integrations/builtin/credentials/zammad.md) for guidance on setting up authentication. +/// + +## Operations + +* Group + * Create + * Delete + * Get + * Get many + * Update +* Organization + * Create + * Delete + * Get + * Get many + * Update +* Ticket + * Create + * Delete + * Get + * Get many +* User + * Create + * Delete + * Get + * Get many + * Get self + * Update + +## Templates and examples + + +[[ templatesWidget(page.title, 'zammad') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zendesk node documentation +description: Learn how to use the Zendesk node in n8n. Follow technical documentation to integrate Zendesk node into your workflows. +contentType: [integration, reference] +--- + +# Zendesk node + +Use the Zendesk node to automate work in Zendesk, and integrate Zendesk with other applications. n8n has built-in support for a wide range of Zendesk features, including creating, and deleting tickets, users, and organizations. + +On this page, you'll find a list of operations the Zendesk node supports and links to more resources. + +/// note | Credentials +Refer to [Zendesk credentials](/integrations/builtin/credentials/zendesk.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Ticket + * Create a ticket + * Delete a ticket + * Get a ticket + * Get all tickets + * Recover a suspended ticket + * Update a ticket +* Ticket Field + * Get a ticket field + * Get all system and custom ticket fields +* User + * Create a user + * Delete a user + * Get a user + * Get all users + * Get a user's organizations + * Get data related to the user + * Search users + * Update a user +* Organization + * Create an organization + * Delete an organization + * Count organizations + * Get an organization + * Get all organizations + * Get data related to the organization + * Update a organization + +## Templates and examples + + +[[ templatesWidget(page.title, 'zendesk') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.zohocrm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zoho CRM node documentation +description: Learn how to use the Zoho CRM node in n8n. Follow technical documentation to integrate Zoho CRM node into your workflows. +contentType: [integration, reference] +--- + +# Zoho CRM node + +Use the Zoho CRM node to automate work in Zoho CRM, and integrate Zoho CRM with other applications. n8n has built-in support for a wide range of Zoho CRM features, including creating and deleting accounts, contacts, and deals. + +On this page, you'll find a list of operations the Zoho CRM node supports and links to more resources. + +/// note | Credentials +Refer to [Zoho CRM credentials](/integrations/builtin/credentials/zoho.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Account + * Create an account + * Create a new record, or update the current one if it already exists (upsert) + * Delete an account + * Get an account + * Get all accounts + * Update an account +* Contact + * Create a contact + * Create a new record, or update the current one if it already exists (upsert) + * Delete a contact + * Get a contact + * Get all contacts + * Update a contact +* Deal + * Create a deal + * Create a new record, or update the current one if it already exists (upsert) + * Delete a contact + * Get a contact + * Get all contacts + * Update a contact +* Invoice + * Create an invoice + * Create a new record, or update the current one if it already exists (upsert) + * Delete an invoice + * Get an invoice + * Get all invoices + * Update an invoice +* Lead + * Create a lead + * Create a new record, or update the current one if it already exists (upsert) + * Delete a lead + * Get a lead + * Get all leads + * Get lead fields + * Update a lead +* Product + * Create a product + * Create a new record, or update the current one if it already exists (upsert) + * Delete a product + * Get a product + * Get all products + * Update a product +* Purchase Order + * Create a purchase order + * Create a new record, or update the current one if it already exists (upsert) + * Delete a purchase order + * Get a purchase order + * Get all purchase orders + * Update a purchase order +* Quote + * Create a quote + * Create a new record, or update the current one if it already exists (upsert) + * Delete a quote + * Get a quote + * Get all quotes + * Update a quote +* Sales Order + * Create a sales order + * Create a new record, or update the current one if it already exists (upsert) + * Delete a sales order + * Get a sales order + * Get all sales orders + * Update a sales order +* Vendor + * Create a vendor + * Create a new record, or update the current one if it already exists (upsert) + * Delete a vendor + * Get a vendor + * Get all vendors + * Update a vendor + +## Templates and examples + + +[[ templatesWidget(page.title, 'zoho-crm') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.zoom.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zoom node documentation +description: Learn how to use the Zoom node in n8n. Follow technical documentation to integrate Zoom node into your workflows. +contentType: [integration, reference] +--- + +# Zoom node + +Use the Zoom node to automate work in Zoom, and integrate Zoom with other applications. n8n has built-in support for a wide range of Zoom features, including creating, retrieving, deleting, and updating meetings. + +On this page, you'll find a list of operations the Zoom node supports and links to more resources. + +/// note | Credentials +Refer to [Zoom credentials](/integrations/builtin/credentials/zoom.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +## Operations + +* Meeting + * Create a meeting + * Delete a meeting + * Retrieve a meeting + * Retrieve all meetings + * Update a meeting + +## Templates and examples + + +[[ templatesWidget(page.title, 'zoom') ]] + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + + +# integrations/builtin/app-nodes/n8n-nodes-base.zulip.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zulip node documentation +description: Learn how to use the Zulip node in n8n. Follow technical documentation to integrate Zulip node into your workflows. +contentType: [integration, reference] +--- + +# Zulip node + +Use the Zulip node to automate work in Zulip, and integrate Zulip with other applications. n8n has built-in support for a wide range of Zulip features, including creating, deleting, and getting users and streams, as well as sending messages. + +On this page, you'll find a list of operations the Zulip node supports and links to more resources. + +/// note | Credentials +Refer to [Zulip credentials](/integrations/builtin/credentials/zulip.md) for guidance on setting up authentication. +/// + +## Operations + +* Message + * Delete a message + * Get a message + * Send a private message + * Send a message to stream + * Update a message + * Upload a file +* Stream + * Create a stream. + * Delete a stream. + * Get all streams. + * Get subscribed streams. + * Update a stream. +* User + * Create a user. + * Deactivate a user. + * Get a user. + * Get all users. + * Update a user. + +## Templates and examples + + +[[ templatesWidget(page.title, 'zulip') ]] + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Assistant operations +description: Documentation for the Assistant operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI Assistant operations + +Use this operation to create, delete, list, message, or update an assistant in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself. + +## Create an Assistant + +Use this operation to create a new assistant. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Assistant**. +- **Operation**: Select **Create an Assistant**. +- **Model**: Select the model that the assistant will use. If you’re not sure which model to use, try `gpt-4o` if you need high intelligence or `gpt-4o-mini` if you need the fastest speed and lowest cost. Refer to [Models overview | OpenAI Platform](https://platform.openai.com/docs/models){:target=_blank .external-link} for more information. +- **Name**: Enter the name of the assistant. The maximum length is 256 characters. +- **Description**: Enter the description of the assistant. The maximum length is 512 characters. + ``` + A virtual assistant that helps users with daily tasks, including setting reminders, answering general questions, and providing quick information. + ``` +- **Instructions**: Enter the system instructions that the assistant uses. The maximum length is 32,768 characters. Use this to specify the persona used by the model in its replies. + ``` + Always respond in a friendly and engaging manner. When a user asks a question, provide a concise answer first, followed by a brief explanation or additional context if necessary. If the question is open-ended, offer a suggestion or ask a clarifying question to guide the conversation. Keep the tone positive and supportive, and avoid technical jargon unless specifically requested by the user. + ``` +- **Code Interpreter**: Turn on to enable the code interpreter for the assistant, where it can write and execute code in a sandbox environment. Enable this tool for tasks that require computations, data analysis, or any logic-based processing. +- **Knowledge Retrieval**: Turn on to enable knowledge retrieval for the assistant, allowing it to access external sources or a connected knowledge base. Refer to [File Search | OpenAI Platform](https://platform.openai.com/docs/assistants/tools/file-search){:target=_blank .external-link} for more information. + - **Files**: Select a file to upload for your external knowledge source. Use **Upload a File** operation to add more files. + +### Options + +- **Output Randomness (Temperature)**: Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. Defaults to `1.0`. +- **Output Randomness (Top P)**: Adjust the Top P setting to control the diversity of the assistant's responses. For example, `0.5` means half of all likelihood-weighted options are considered. We recommend altering this or **Output Randomness (Temperature)** but not both. Defaults to `1.0`. +- **Fail if Assistant Already Exists**: If enabled, the operation will fail if an assistant with the same name already exists. + +Refer to [Create assistant | OpenAI](https://platform.openai.com/docs/api-reference/assistants/createAssistant){:target=_blank .external-link} documentation for more information. + +## Delete an Assistant + +Use this operation to delete an existing assistant from your account. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Assistant**. +- **Operation**: Select **Delete an Assistant**. +- **Assistant**: Select the assistant you want to delete **From list** or **By ID**. + +Refer to [Delete assistant | OpenAI](https://platform.openai.com/docs/api-reference/assistants/deleteAssistant){:target=_blank .external-link} documentation for more information. + +## List Assistants + +Use this operation to retrieve a list of assistants in your organization. + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Assistant**. +- **Operation**: Select **List Assistants**. + +### Options + +- **Simplify Output**: Turn on to return a simplified version of the response instead of the raw data. This option is enabled by default. + +Refer to [List assistants | OpenAI](https://platform.openai.com/docs/api-reference/assistants/listAssistants){:target=_blank .external-link} documentation for more information. + +## Message an Assistant + +Use this operation to send a message to an assistant and receive a response. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Assistant**. +- **Operation**: Select **Message an Assistant**. +- **Assistant**: Select the assistant you want to message. +- **Prompt**: Enter the text prompt or message that you want to send to the assistant. + - **Connected Chat Trigger Node**: Automatically use the input from a previous node's `chatInput` field. + - **Define Below**: Manually define the prompt by entering static text or using an expression to reference data from previous nodes. + +### Options + +- **Base URL**: Enter the base URL that the assistant should use for making API requests. This option is useful for directing the assistant to use endpoints provided by other LLM providers that offer an OpenAI-compatible API. +- **Max Retries**: Specify the number of times the assistant should retry an operation in case of failure. +- **Timeout**: Set the maximum amount of time in milliseconds, that the assistant should wait for a response before timing out. Use this option to prevent long waits during operations. +- **Preserve Original Tools**: Turn off to remove the original tools associated with the assistant. Use this if you want to temporarily remove tools for this specific operation. + +Refer to [Assistants | OpenAI](https://platform.openai.com/docs/api-reference/assistants){:target=_blank .external-link} documentation for more information. + +## Update an Assistant + +Use this operation to update the details of an existing assistant. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Assistant**. +- **Operation**: Select **Update an Assistant**. +- **Assistant**: Select the assistant you want to update. + +### Options + +- **Code Interpreter**: Turn on to enable the code interpreter for the assistant, where it can write and execute code in a sandbox environment. Enable this tool for tasks that require computations, data analysis, or any logic-based processing. +- **Description**: Enter the description of the assistant. The maximum length is 512 characters. + ``` + A virtual assistant that helps users with daily tasks, including setting reminders, answering general questions, and providing quick information. + ``` +- **Instructions**: Enter the system instructions that the assistant uses. The maximum length is 32,768 characters. Use this to specify the persona used by the model in its replies. + ``` + Always respond in a friendly and engaging manner. When a user asks a question, provide a concise answer first, followed by a brief explanation or additional context if necessary. If the question is open-ended, offer a suggestion or ask a clarifying question to guide the conversation. Keep the tone positive and supportive, and avoid technical jargon unless specifically requested by the user. + ``` +- **Knowledge Retrieval**: Turn on to enable knowledge retrieval for the assistant, allowing it to access external sources or a connected knowledge base. Refer to [File Search | OpenAI Platform](https://platform.openai.com/docs/assistants/tools/file-search){:target=_blank .external-link} for more information. +- **Files**: Select a file to upload for your external knowledge source. Use [**Upload a File**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md#upload-a-file) operation to add more files. Note that this only updates the [Code Interpreter](https://platform.openai.com/docs/assistants/tools/code-interpreter) tool, not the [File Search](https://platform.openai.com/docs/assistants/tools/file-search) tool. +- **Model**: Select the model that the assistant will use. If you’re not sure which model to use, try `gpt-4o` if you need high intelligence or `gpt-4o-mini` if you need the fastest speed and lowest cost. Refer to [Models overview | OpenAI Platform](https://platform.openai.com/docs/models){:target=_blank .external-link} for more information. +- **Name**: Enter the name of the assistant. The maximum length is 256 characters. +- **Remove All Custom Tools (Functions)**: Turn on to remove all custom tools (functions) from the assistant. +- **Output Randomness (Temperature)**: Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. Defaults to `1.0`. +- **Output Randomness (Top P)**: Adjust the Top P setting to control the diversity of the assistant's responses. For example, `0.5` means half of all likelihood-weighted options are considered. We recommend altering this or **Output Randomness (Temperature)** but not both. Defaults to `1.0`. + +Refer to [Modify assistant | OpenAI](https://platform.openai.com/docs/api-reference/assistants/modifyAssistant){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/audio-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Audio operations +description: Documentation for the Audio operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI Audio operations + +Use this operation to generate an audio, or transcribe or translate a recording in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself. + +## Generate Audio + +Use this operation to create audio from a text prompt. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Audio**. +- **Operation**: Select **Generate Audio**. +- **Model**: Select the model you want to use to generate the audio. Refer to [TTS | OpenAI](https://platform.openai.com/docs/models/tts){:target=_blank .external-link} for more information. + - **TTS-1**: Use this to optimize for speed. + - **TTS-1-HD**: Use this to optimize for quality. +- **Text Input**: Enter the text to generate the audio for. The maximum length is 4096 characters. +- **Voice**: Select a voice to use when generating the audio. Listen to the previews of the voices in [Text to speech guide | OpenAI](https://platform.openai.com/docs/guides/text-to-speech/quickstart){:target=_blank .external-link}. + +### Options + +- **Response Format**: Select the format for the audio response. Choose from **MP3** (default), **OPUS**, **AAC**, **FLAC**, **WAV**, and **PCM**. +- **Audio Speed**: Enter the speed for the generated audio from a value from `0.25` to `4.0`. Defaults to `1`. +- **Put Output in Field**: Defaults to `data`. Enter the name of the output field to put the binary file data in. + +Refer to [Create speech | OpenAI](https://platform.openai.com/docs/api-reference/audio/createSpeech){:target=_blank .external-link} documentation for more information. + +## Transcribe a Recording + +Use this operation to transcribe audio into text. OpenAI API limits the size of the audio file to 25 MB. OpenAI will use the `whisper-1` model by default. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Audio**. +- **Operation**: Select **Transcribe a Recording**. +- **Input Data Field Name**: Defaults to `data`. Enter the name of the binary property that contains the audio file in one of these formats: `.flac`, `.mp3`, `.mp4`, `.mpeg`, `.mpga`, `.m4a`, `.ogg`, `.wav`, or `.webm`. + +### Options + +- **Language of the Audio File**: Enter the language of the input audio in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes){:target=_blank .external-link}. Use this option to improve accuracy and latency. +- **Output Randomness (Temperature)**: Defaults to `1.0`. Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. + +Refer to [Create transcription | OpenAI](https://platform.openai.com/docs/api-reference/audio/createTranscription){:target=_blank .external-link} documentation for more information. + +## Translate a Recording + +Use this operation to translate audio into English. OpenAI API limits the size of the audio file to 25 MB. OpenAI will use the `whisper-1` model by default. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Audio**. +- **Operation**: Select **Translate a Recording**. +- **Input Data Field Name**: Defaults to `data`. Enter the name of the binary property that contains the audio file in one of these formats: `.flac`, `.mp3`, `.mp4`, `.mpeg`, `.mpga`, `.m4a`, `.ogg`, `.wav`, or `.webm`. + +### Options + +- **Output Randomness (Temperature)**: Defaults to `1.0`. Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around 0.7) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. + +Refer to [Create transcription | OpenAI](https://platform.openai.com/docs/api-reference/audio/createTranscription){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI node common issues +description: Documentation for common issues and questions in the OpenAI node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI node common issues + +Here are some common errors and issues with the [OpenAI node](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) and steps to resolve or troubleshoot them. + +--8<-- "_snippets/integrations/openai-api-issues.md" +--8<-- "_snippets/integrations/referenced-node-unexecuted.md" + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI File operations +description: Documentation for the File operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI File operations + +Use this operation to create, delete, list, message, or update a file in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself. + +## Delete a File + +Use this operation to delete a file from the server. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **File**. +- **Operation**: Select **Delete a File**. +- **File**: Enter the ID of the file to use for this operation or select the file name from the dropdown. + +Refer to [Delete file | OpenAI](https://platform.openai.com/docs/api-reference/files/delete){:target=_blank .external-link} documentation for more information. + +## List Files + +Use this operation to list files that belong to the user's organization. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **File**. +- **Operation**: Select **List Files**. + +### Options + +- **Purpose**: Use this to only return files with the given purpose. Use **Assistants** to return only files related to Assistants and Message operations. Use **Fine-Tune** for files related to [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning){:target=_blank .external-link}. + +Refer to [List files | OpenAI](https://platform.openai.com/docs/api-reference/files/list) documentation for more information. + +## Upload a File + +Use this operation to upload a file. This can be used across various operations. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **File**. +- **Operation**: Select **Upload a File**. +- **Input Data Field Name**: Defaults to `data`. Enter the name of the binary property which contains the file. The size of individual files can be a maximum of 512 MB or 2 million tokens for Assistants. + +### Options + +- **Purpose**: Enter the intended purpose of the uploaded file. Use **Assistants** for files associated with Assistants and Message operations. Use **Fine-Tune** for [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning){:target=_blank .external-link}. + +Refer to [Upload file | OpenAI](https://platform.openai.com/docs/api-reference/files/create){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/image-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Image operations +description: Documentation for the Image operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI Image operations + +Use this operation to analyze or generate an image in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself. + +## Analyze Image + +Use this operation to take in images and answer questions about them. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Image**. +- **Operation**: Select **Analayze Image**. +- **Model**: Select the model you want to use to generate an image. +- **Text Input**: Ask a question about the image. +- **Input Type**: Select how you'd like to input the image. Options include: + - **Image URL(s)**: Enter the **URL(s)** of the image(s) to analyze. Add multiple URLs in a comma-separated list. + - **Binary File(s)**: Enter the name of the binary property which contains the image(s) in the **Input Data Field Name**. + +### Options + +- **Detail**: Specify the balance between response time versus token usage. +- **Length of Description (Max Tokens)**: Defaults to 300. Fewer tokens will result in shorter, less detailed image description. + +Refer to [Images | OpenAI](https://platform.openai.com/docs/api-reference/images){:target=_blank .external-link} documentation for more information. + +## Generate an Image + +Use this operation to create an image from a text prompt. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Image**. +- **Operation**: Select **Generate an Image**. +- **Model**: Select the model you want to use to generate an image. +- **Prompt**: Enter the text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`. + +### Options + +- **Quality**: The quality of the image you generate. **HD** creates images with finer details and greater consistency across the image. This option is only supported for `dall-e-3`. Otherwise, choose **Standard**. +- **Resolution**: Select the resolution of the generated images. Select **1024x1024** for `dall-e-2`. Select one of **1024x1024**, **1792x1024**, or **1024x1792** for `dall-e-3` models. +- **Style**: Select the style of the generated images. This option is only supported for `dall-e-3`. + - **Natural**: Use this to produce more natural looking images. + - **Vivid**: Use this to produce hyper-real and dramatic images. +- **Respond with image URL(s)**: Whether to return image URL(s) instead of binary file(s). +- **Put Output in Field**: Defaults to `data`. Enter the name of the output field to put the binary file data in. Only available if **Respond with image URL(s)** is turned off. + +Refer to [Create image | OpenAI](https://platform.openai.com/docs/api-reference/images/create){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI node documentation +description: Learn how to use the OpenAI node in n8n. Follow technical documentation to integrate OpenAI node into your workflows. +contentType: [integration, reference] +priority: critical +search: + boost: 3 +--- + +# OpenAI node + +Use the OpenAI node to automate work in OpenAI and integrate OpenAI with other applications. n8n has built-in support for a wide range of OpenAI features, including creating images and assistants, as well as chatting with models. + +On this page, you'll find a list of operations the OpenAI node supports and links to more resources. + +/// note | OpenAI Assistant node +The OpenAI node replaces the OpenAI assistant node from version 1.29.0 on. +/// + +/// note | Credentials +Refer to [OpenAI credentials](/integrations/builtin/credentials/openai.md) for guidance on setting up authentication. +/// + +## Operations + +- **Assistant** + - [**Create an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#create-an-assistant) + - [**Delete an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#delete-an-assistant) + - [**List Assistants**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#list-assistants) + - [**Message an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#message-an-assistant) + - [**Update an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#update-an-assistant) +- **Text** + - [**Message a Model**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/text-operations.md#message-a-model) + - [**Classify Text for Violations**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/text-operations.md#classify-text-for-violations) +- **Image** + - [**Analyze Image**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/image-operations.md#analyze-image) + - [**Generate an Image**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/image-operations.md#generate-an-image) +- **Audio** + - [**Generate Audio**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/audio-operations.md#generate-audio) + - [**Transcribe a Recording**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/audio-operations.md#transcribe-a-recording) + - [**Translate a Recording**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/audio-operations.md#translate-a-recording) +- **File** + - [**Delete a File**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md#delete-a-file) + - [**List Files**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md#list-files) + - [**Upload a File**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/file-operations.md#upload-a-file) + +## Templates and examples + + +[[ templatesWidget(page.title, 'openai') ]] + +## Related resources + +Refer to [OpenAI's documentation](https://beta.openai.com/docs/introduction){:target=_blank .external-link} for more information about the service. + +Refer to [OpenAI's assistants documentation](https://platform.openai.com/docs/assistants/how-it-works/objects){:target=_blank .external-link} for more information about how assistants work. + +For help dealing with rate limits, refer to [Handling rate limits](/integrations/builtin/rate-limits.md). + +--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" + +## Using tools with OpenAI assistants + +Some operations allow you to connect tools. [Tools](https://docs.n8n.io/advanced-ai/examples/understand-tools/) act like addons that your AI can use to access extra context or resources. + +Select the **Tools** connector to browse the available tools and add them. + +Once you add a tool connection, the OpenAI node becomes a [root node](/glossary.md#root-node-n8n), allowing it to form a [cluster node](/glossary.md#cluster-node-n8n) with the tools [sub-nodes](/glossary.md#sub-node-n8n). See [Node types](/integrations/builtin/node-types.md#cluster-nodes) for more information on cluster nodes and root nodes. + +### Operations that support tool connectors + +- **Assistant** + - [**Message an Assistant**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/assistant-operations.md#message-an-assistant) +- **Text** + - [**Message a Model**](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/text-operations.md#message-a-model) + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md). + + +# integrations/builtin/app-nodes/n8n-nodes-langchain.openai/text-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Text operations +description: Documentation for the Text operations in OpenAI node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI Text operations + +Use this operation to message a model or classify text for violations in OpenAI. Refer to [OpenAI](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/index.md) for more information on the OpenAI node itself. + +## Message a Model + +Use this operation to send a message or prompt to an OpenAI model and receive a response. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Text**. +- **Operation**: Select **Message a Model**. +- **Model**: Select the model you want to use. If you’re not sure which model to use, try `gpt-4o` if you need high intelligence or `gpt-4o-mini` if you need the fastest speed and lowest cost. Refer to [Models overview | OpenAI Platform](https://platform.openai.com/docs/models){:target=_blank .external-link} for more information. +- **Messages**: Enter a **Text** prompt and assign a **Role** that the model will use to generate responses. Refer to [Prompt engineering | OpenAI](https://platform.openai.com/docs/guides/prompt-engineering){:target=_blank .external-link} for more information on how to write a better prompt by using these roles. Choose from one of these roles: + - **User**: Sends a message as a user and gets a response from the model. + - **Assistant**: Tells the model to adopt a specific tone or personality. + - **System**: By default, the system message is `"You are a helpful assistant"`. You can define instructions in the user message, but the instructions set in the system message are more effective. You can only set one system message per conversation. Use this to set the model's behavior or context for the next user message. +- **Simplify Output**: Turn on to return a simplified version of the response instead of the raw data. +- **Output Content as JSON**: Turn on to attempt to return the response in JSON format. Compatible with `GPT-4 Turbo` and all `GPT-3.5 Turbo` models newer than `gpt-3.5-turbo-1106`. + +### Options + +- **Frequency Penalty**: Apply a penalty to reduce the model's tendency to repeat similar lines. The range is between `0.0` and `2.0`. +- **Maximum Number of Tokens**: Set the maximum number of tokens for the response. One token is roughly four characters for standard English text. Use this to limit the length of the output. +- **Number of Completions**: Defaults to 1. Set the number of completions you want to generate for each prompt. Use carefully since setting a high number will quickly consume your tokens. +- **Presence Penalty**: Apply a penalty to influence the model to discuss new topics. The range is between `0.0` and `2.0`. +- **Output Randomness (Temperature)**: Adjust the randomness of the response. The range is between `0.0` (deterministic) and `1.0` (maximum randomness). We recommend altering this or **Output Randomness (Top P)** but not both. Start with a medium temperature (around `0.7`) and adjust based on the outputs you observe. If the responses are too repetitive or rigid, increase the temperature. If they’re too chaotic or off-track, decrease it. Defaults to `1.0`. +- **Output Randomness (Top P)**: Adjust the Top P setting to control the diversity of the assistant's responses. For example, `0.5` means half of all likelihood-weighted options are considered. We recommend altering this or **Output Randomness (Temperature)** but not both. Defaults to `1.0`. + +Refer to [Message a Model | OpenAI](https://platform.openai.com/docs/api-reference/text-completion/create){:target=_blank .external-link} documentation for more information. + +## Classify Text for Violations + +Use this operation to identify and flag content that might be harmful. OpenAI model will analyze the text and return a response containing: + +- `flagged`: A boolean field indicating if the content is potentially harmful. +- `categories`: A list of category-specific violation flags. +- `category_scores`: Scores for each category. + +Enter these parameters: + +- **Credential to connect with**: Create or select an existing [OpenAI credential](/integrations/builtin/credentials/openai.md). +- **Resource**: Select **Text**. +- **Operation**: Select **Classify Text for Violations**. +- **Text Input**: Enter text to classify if it violates the moderation policy. +- **Simplify Output**: Turn on to return a simplified version of the response instead of the raw data. + +### Options + +- **Use Stable Model**: Turn on to use the stable version of the model instead of the latest version, accuracy may be slightly lower. + +Refer to [Moderations | OpenAI](https://platform.openai.com/docs/api-reference/moderations){:target=_blank .external-link} documentation for more information. + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/app-nodes/n8n-nodes-langchain.openai/common-issues.md). + + +# integrations/builtin/cluster-nodes/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +title: Cluster nodes +description: Understand cluster nodes in n8n, and browse the cluster nodes library. +--- + +# Cluster nodes + +--8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" + + +## Root nodes + +Each cluster starts with one [root node](/glossary.md#root-node-n8n). + +## Sub-nodes + +Each root node can have one or more [sub-nodes](/glossary.md#sub-node-n8n) attached to it. + + + +# integrations/builtin/cluster-nodes/root-nodes/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +title: Root nodes +description: Understand root nodes in n8n, and browse the root nodes library. +--- + +# Root nodes + +Root nodes are the foundational nodes within a group of cluster nodes. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AI Agent node common issues +description: Documentation for common issues and questions in the AI Agent node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: critical +--- + +# AI Agent node common issues + +Here are some common errors and issues with the [AI Agent node](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) and steps to resolve or troubleshoot them. + +## Internal error: 400 Invalid value for 'content' + +A full error message might look like this: + +``` +Internal error +Error: 400 Invalid value for 'content': expected a string, got null. + +``` + +This error can occur if the **Prompt** input contains a null value. + +You might see this in one of two scenarios: + +1. When you've set the **Prompt** to **Define below** and have an expression in your **Text** that isn't generating a value. + * To resolve, make sure your expressions reference valid fields and that they resolve to valid input rather than null. +2. When you've set the **Prompt** to **Connected Chat Trigger Node** and the incoming data has null values. + * To resolve, remove any null values from the `chatInput` field of the input node. + +## Error in sub-node Simple Memory + +This error displays when n8n runs into an issue with the [Simple Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md) sub-node. + +It most often occurs when your workflow or the workflow template you copied uses an older version of the Simple memory node (previously known as "Window Buffer Memory"). + +Try removing the Simple Memory node from your workflow and re-adding it, which will guarantee you're using the latest version of the node. + +## A Chat Model sub-node must be connected error + +This error displays when n8n tries to execute the node without having a Chat Model connected. + +To resolve this, click the + Chat Model button at the bottom of your screen when the node is open, or click the Chat Model + connector when the node is closed. n8n will then open a selection of possible Chat Models to pick from. + +## No prompt specified error + +This error occurs when the agent expects to get the prompt from the previous node automatically. Typically, this happens when you're using the [Chat Trigger Node](https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/). + +To resolve this issue, find the **Prompt** parameter of the AI Agent node and change it from **Connected Chat Trigger Node** to **Define below**. This allows you to manually build your prompt by referencing output data from other nodes or by adding static text. + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/conversational-agent.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Conversational AI Agent node documentation +description: Learn how to use the Conversational Agent of the AI Agent node in n8n. Follow technical documentation to integrate the Conversational Agent into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# Conversational AI Agent node + +The Conversational Agent has human-like conversations. It can maintain context, understand user intent, and provide relevant answers. This agent is typically used for building chatbots, virtual assistants, and customer support systems. + +The Conversational Agent describes [tools](/glossary.md#ai-tool) in the system prompt and parses JSON responses for tool calls. If your preferred AI model doesn't support tool calling or you're handling simpler interactions, this agent is a good general option. It's more flexible but may be less accurate than the [Tools Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md). + +Refer to [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for more information on the AI Agent node itself. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/use-with-chat-trigger.md" + +## Node parameters + +Configure the Conversational Agent using the following parameters. + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +### Require Specific Output Format + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/output-format.md" + +## Node options + +Refine the Conversational Agent node's behavior using these options: + +### Human Message + +Tell the agent about the tools it can use and add context to the user's input. + +You must include these expressions and variable: + +* `{tools}`: A LangChain expression that provides a string of the tools you've connected to the Agent. Provide some context or explanation about who should use the tools and how they should use them. +* `{format_instructions}`: A LangChain expression that provides the schema or format from the output parser node you've connected. Since the instructions themselves are context, you don't need to provide context for this expression. +* `{{input}}`: A LangChain variable containing the user's prompt. This variable populates with the value of the **Prompt** parameter. Provide some context that this is the user's input. + +Here's an example of how you might use these strings: + +Example: + +``` +TOOLS +------ +Assistant can ask the user to use tools to look up information that may be helpful in answering the user's original question. The tools the human can use are: + +{tools} + +{format_instructions} + +USER'S INPUT +-------------------- +Here is the user's input (remember to respond with a markdown code snippet of a JSON blob with a single action, and NOTHING else): + +{{input}} +``` + +### System Message + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/system-message.md" + +### Max Iterations + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/max-iterations.md" + +### Return Intermediate Steps + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/return-intermediate-steps.md" + +## Templates and examples + +Refer to the main AI Agent node's [Templates and examples](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md#templates-and-examples) section. + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AI Agent node documentation +description: Learn how to use the AI Agent node in n8n. Follow technical documentation to integrate AI Agent node into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# AI Agent node + +An [AI agent](/glossary.md#ai-agent) is an autonomous system that receives data, makes rational decisions, and acts within its environment to achieve specific goals. The AI agent's environment is everything the agent can access that isn't the agent itself. This agent uses external [tools](/glossary.md#ai-tool) and APIs to perform actions and retrieve information. It can understand the capabilities of different tools and determine which tool to use depending on the task. + +/// note | Connect a tool +You must connect at least one tool [sub-node](/integrations/builtin/cluster-nodes/sub-nodes/index.md) to an AI Agent node. +/// + +/// note | Agent type +Prior to version 1.82.0, the AI Agent had a setting for working as different agent types. This has now been removed and all AI Agent nodes work as a `Tools Agent` which was the recommended and most frequently used setting. If you're working with older versions of the AI Agent in workflows or templates, as long as they were set to 'Tools Agent', they should continue to behave as intended with the updated node. +/// + + +## Templates and examples + +[[ templatesWidget(page.title, 'agent') ]] + +## Related resources + +Refer to [LangChain's documentation on agents](https://js.langchain.com/docs/concepts/agents/){:target=_blank .external-link} for more information about the service. + +New to AI Agents? Read the [n8n blog introduction to AI agents](https://blog.n8n.io/ai-agents/){:target=_blank .external-link}. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/openai-functions-agent.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Functions Agent node documentation +description: Learn how to use the OpenAI Functions Agent of the AI Agent node in n8n. Follow technical documentation to integrate the OpenAI Functions Agent into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# OpenAI Functions Agent node + +Use the OpenAI Functions Agent node to use an [OpenAI functions model](https://platform.openai.com/docs/guides/function-calling){:target=_blank .external-link}. These are models that detect when a function should be called and respond with the inputs that should be passed to the function. + +Refer to [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for more information on the AI Agent node itself. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/use-with-chat-trigger.md" + +/// note | OpenAI Chat Model required +You must use the [OpenAI Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md) with this agent. +/// + +## Node parameters + +Configure the OpenAI Functions Agent using the following parameters. + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +### Require Specific Output Format + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/output-format.md" + +## Node options + +Refine the OpenAI Functions Agent node's behavior using these options: + +### System Message + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/system-message.md" + +### Max Iterations + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/max-iterations.md" + +### Return Intermediate Steps + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/return-intermediate-steps.md" + +## Templates and examples + +Refer to the main AI Agent node's [Templates and examples](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md#templates-and-examples) section. + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/plan-execute-agent.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Plan and Execute AI Agent node documentation +description: Learn how to use the Plan and Execute Agent of the AI Agent node in n8n. Follow technical documentation to integrate the Plan and Execute Agent into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# Plan and Execute Agent node + +The Plan and Execute Agent is like the [ReAct agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/react-agent.md) but with a focus on planning. It first creates a high-level plan to solve the given task and then executes the plan step by step. This agent is most useful for tasks that require a structured approach and careful planning. + +Refer to [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for more information on the AI Agent node itself. + +## Node parameters + +Configure the Plan and Execute Agent using the following parameters. + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +### Require Specific Output Format + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/output-format.md" + +## Node options + +Refine the Plan and Execute Agent node's behavior using these options: + +### Human Message Template + +Enter a message that n8n will send to the agent during each step execution. + +Available LangChain expressions: + +* `{previous_steps}`: Contains information about the previous steps the agent's already completed. +* `{current_step}`: Contains information about the current step. +* `{agent_scratchpad}`: Information to remember for the next iteration. + +## Templates and examples + +Refer to the main AI Agent node's [Templates and examples](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md#templates-and-examples) section. + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/react-agent.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: ReAct AI Agent node documentation +description: Learn how to use the ReAct Agent of the AI Agent node in n8n. Follow technical documentation to integrate the ReAct Agent into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# ReAct AI Agent node + +The ReAct Agent node implements [ReAct](https://react-lm.github.io/){:target=_blank .external-link} logic. ReAct (reasoning and acting) brings together the reasoning powers of chain-of-thought prompting and action plan generation. + +The ReAct Agent reasons about a given task, determines the necessary actions, and then executes them. It follows the cycle of reasoning and acting until it completes the task. The ReAct agent can break down complex tasks into smaller sub-tasks, prioritise them, and execute them one after the other. + +Refer to [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for more information on the AI Agent node itself. + +/// note | No memory +The ReAct agent doesn't support memory sub-nodes. This means it can't recall previous prompts or simulate an ongoing conversation. +/// + +## Node parameters + +Configure the ReAct Agent using the following parameters. + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +### Require Specific Output Format + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/output-format.md" + +## Node options + +Use the options to create a message to send to the agent at the start of the conversation. The message type depends on the model you're using: + +* **Chat models**: These models have the concept of three components interacting (AI, system, and human). They can receive system messages and human messages (prompts). +* **Instruct models**: These models don't have the concept of separate AI, system, and human components. They receive one body of text, the instruct message. + +### Human Message Template + +Use this option to extend the user prompt. This is a way for the agent to pass information from one iteration to the next. + +Available LangChain expressions: + +* `{input}`: Contains the user prompt. +* `{agent_scratchpad}`: Information to remember for the next iteration. + +### Prefix Message + +Enter text to prefix the tools list at the start of the conversation. You don't need to add the list of tools. LangChain automatically adds the tools list. + +### Suffix Message for Chat Model + +Add text to append after the tools list at the start of the conversation when the agent uses a chat model. You don't need to add the list of tools. LangChain automatically adds the tools list. + +### Suffix Message for Regular Model + +Add text to append after the tools list at the start of the conversation when the agent uses a regular/instruct model. You don't need to add the list of tools. LangChain automatically adds the tools list. + +### Return Intermediate Steps + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/return-intermediate-steps.md" + +## Related resources + +Refer to LangChain's [ReAct Agents](https://js.langchain.com/docs/concepts/agents/){:target=_blank .external-link} documentation for more information. + +## Templates and examples + +Refer to the main AI Agent node's [Templates and examples](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md#templates-and-examples) section. + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/sql-agent.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SQL AI Agent node documentation +description: Learn how to use the SQL Agent of the AI Agent node in n8n. Follow technical documentation to integrate the SQL Agent into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# SQL AI Agent node + +The SQL Agent uses a SQL database as a data source. It can understand natural language questions, convert them into SQL queries, execute the queries, and present the results in a user-friendly format. This agent is valuable for building natural language interfaces to databases. + +Refer to [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for more information on the AI Agent node itself. + +## Node parameters + +Configure the SQL Agent using the following parameters. + +### Data Source + +Choose the database to use as a data source for the node. Options include: + +* **MySQL**: Select this option to use a MySQL database. + * Also select the **Credential for MySQL**. +* **SQLite**: Select this option to use a SQLite database. + * You must add a [Read/Write File From Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) node before the Agent to read your SQLite file. + * Also enter the **Input Binary Field** name of your SQLite file coming from the Read/Write File From Disk node. +* **Postgres**: Select this option to use a Postgres database. + * Also select the **Credential for Postgres**. + +/// warning | Postgres and MySQL Agents +If you are using [Postgres](/integrations/builtin/credentials/postgres.md) or [MySQL](/integrations/builtin/credentials/mysql.md), this agent doesn't support the credential tunnel options. +/// + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +## Node options + +Refine the SQL Agent node's behavior using these options: + +### Ignored Tables + +If you'd like the node to ignore any tables from the database, enter a comma-separated list of tables you'd like it to ignore. + +If left empty, the agent doesn't ignore any tables. + +### Include Sample Rows + +Enter the number of sample rows to include in the prompt to the agent. Default is `3`. + +Sample rows help the agent understand the schema of the database, but they also increase the number of tokens used. + +### Included Tables + +If you'd only like to include specific tables from the database, enter a comma-separated list of tables to include. + +If left empty, the agent includes all tables. + +### Prefix Prompt + +Enter a message you'd like to send to the agent before the **Prompt** text. This initial message can provide more context and guidance to the agent about what it can and can't do, and how to format the response. + +n8n fills this field with an example. + +### Suffix Prompt + +Enter a message you'd like to send to the agent after the **Prompt** text. + +Available LangChain expressions: + +* `{chatHistory}`: A history of messages in this conversation, useful for maintaining context. +* `{input}`: Contains the user prompt. +* `{agent_scratchpad}`: Information to remember for the next iteration. + +n8n fills this field with an example. + +### Limit + +Enter the maximum number of results to return. + +Default is `10`. + +## Templates and examples + +Refer to the main AI Agent node's [Templates and examples](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md#templates-and-examples) section. + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/tools-agent.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Tools AI Agent node documentation +description: Learn how to use the Tools Agent of the AI Agent node in n8n. Follow technical documentation to integrate the Tools Agent into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# Tools AI Agent node + +The Tools Agent uses external [tools](/glossary.md#ai-tool) and APIs to perform actions and retrieve information. It can understand the capabilities of different tools and determine which tool to use depending on the task. This agent helps integrate LLMs with various external services and databases. + +This agent has an enhanced ability to work with tools and can ensure a standard output format. + +The Tools Agent implements [Langchain's tool calling](https://js.langchain.com/docs/concepts/tool_calling/){:target=_blank .external-link} interface. This interface describes available tools and their schemas. The agent also has improved output parsing capabilities, as it passes the parser to the model as a formatting tool. + +Refer to [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) for more information on the AI Agent node itself. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/use-with-chat-trigger.md" + +This agent supports the following chat models: + +* [OpenAI Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md) +* [Groq Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatgroq.md) +* [Mistral Cloud Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatmistralcloud.md) +* [Anthropic Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatanthropic.md) +* [Azure OpenAI Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatazureopenai.md) + +??? Details "The Tools Agent can use the following tools..." + * [Call n8n Workflow](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) + * [Code](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md) + * [HTTP Request](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolhttprequest.md) + * [Action Network](/integrations/builtin/app-nodes/n8n-nodes-base.actionnetwork.md) + * [ActiveCampaign](/integrations/builtin/app-nodes/n8n-nodes-base.activecampaign.md) + * [Affinity](/integrations/builtin/app-nodes/n8n-nodes-base.affinity.md) + * [Agile CRM](/integrations/builtin/app-nodes/n8n-nodes-base.agilecrm.md) + * [Airtable](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/index.md) + * [APITemplate.io](/integrations/builtin/app-nodes/n8n-nodes-base.apitemplateio.md) + * [Asana](/integrations/builtin/app-nodes/n8n-nodes-base.asana.md) + * [AWS Lambda](/integrations/builtin/app-nodes/n8n-nodes-base.awslambda.md) + * [AWS S3](/integrations/builtin/app-nodes/n8n-nodes-base.awss3.md) + * [AWS SES](/integrations/builtin/app-nodes/n8n-nodes-base.awsses.md) + * [AWS Textract](/integrations/builtin/app-nodes/n8n-nodes-base.awstextract.md) + * [AWS Transcribe](/integrations/builtin/app-nodes/n8n-nodes-base.awstranscribe.md) + * [Baserow](/integrations/builtin/app-nodes/n8n-nodes-base.baserow.md) + * [Bubble](/integrations/builtin/app-nodes/n8n-nodes-base.bubble.md) + * [Calculator](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcalculator.md) + * [ClickUp](/integrations/builtin/app-nodes/n8n-nodes-base.clickup.md) + * [CoinGecko](/integrations/builtin/app-nodes/n8n-nodes-base.coingecko.md) + * [Compression](/integrations/builtin/core-nodes/n8n-nodes-base.compression.md) + * [Crypto](/integrations/builtin/core-nodes/n8n-nodes-base.crypto.md) + * [DeepL](/integrations/builtin/app-nodes/n8n-nodes-base.deepl.md) + * [DHL](/integrations/builtin/app-nodes/n8n-nodes-base.dhl.md) + * [Discord](/integrations/builtin/app-nodes/n8n-nodes-base.discord/index.md) + * [Dropbox](/integrations/builtin/app-nodes/n8n-nodes-base.dropbox.md) + * [Elasticsearch](/integrations/builtin/app-nodes/n8n-nodes-base.elasticsearch.md) + * [ERPNext](/integrations/builtin/app-nodes/n8n-nodes-base.erpnext.md) + * [Facebook Graph API](/integrations/builtin/app-nodes/n8n-nodes-base.facebookgraphapi.md) + * [FileMaker](/integrations/builtin/app-nodes/n8n-nodes-base.filemaker.md) + * [Ghost](/integrations/builtin/app-nodes/n8n-nodes-base.ghost.md) + * [Git](/integrations/builtin/core-nodes/n8n-nodes-base.git.md) + * [GitHub](/integrations/builtin/app-nodes/n8n-nodes-base.github.md) + * [GitLab](/integrations/builtin/app-nodes/n8n-nodes-base.gitlab.md) + * [Gmail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) + * [Google Analytics](/integrations/builtin/app-nodes/n8n-nodes-base.googleanalytics.md) + * [Google BigQuery](/integrations/builtin/app-nodes/n8n-nodes-base.googlebigquery.md) + * [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md) + * [Google Chat](/integrations/builtin/app-nodes/n8n-nodes-base.googlechat.md) + * [Google Cloud Firestore](/integrations/builtin/app-nodes/n8n-nodes-base.googlecloudfirestore.md) + * [Google Cloud Realtime Database](/integrations/builtin/app-nodes/n8n-nodes-base.googlecloudrealtimedatabase.md) + * [Google Contacts](/integrations/builtin/app-nodes/n8n-nodes-base.googlecontacts.md) + * [Google Docs](/integrations/builtin/app-nodes/n8n-nodes-base.googledocs.md) + * [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md) + * [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md) + * [Google Slides](/integrations/builtin/app-nodes/n8n-nodes-base.googleslides.md) + * [Google Tasks](/integrations/builtin/app-nodes/n8n-nodes-base.googletasks.md) + * [Google Translate](/integrations/builtin/app-nodes/n8n-nodes-base.googletranslate.md) + * [Google Workspace Admin](/integrations/builtin/app-nodes/n8n-nodes-base.gsuiteadmin.md) + * [Gotify](/integrations/builtin/app-nodes/n8n-nodes-base.gotify.md) + * [Grafana](/integrations/builtin/app-nodes/n8n-nodes-base.grafana.md) + * [GraphQL](/integrations/builtin/core-nodes/n8n-nodes-base.graphql.md) + * [Hacker News](/integrations/builtin/app-nodes/n8n-nodes-base.hackernews.md) + * [Home Assistant](/integrations/builtin/app-nodes/n8n-nodes-base.homeassistant.md) + * [HubSpot](/integrations/builtin/app-nodes/n8n-nodes-base.hubspot.md) + * [Jenkins](/integrations/builtin/app-nodes/n8n-nodes-base.jenkins.md) + * [Jira Software](/integrations/builtin/app-nodes/n8n-nodes-base.jira.md) + * [JWT](/integrations/builtin/core-nodes/n8n-nodes-base.jwt.md) + * [Kafka](/integrations/builtin/app-nodes/n8n-nodes-base.kafka.md) + * [LDAP](/integrations/builtin/core-nodes/n8n-nodes-base.ldap.md) + * [Line](/integrations/builtin/app-nodes/n8n-nodes-base.line.md) + * [LinkedIn](/integrations/builtin/app-nodes/n8n-nodes-base.linkedin.md) + * [Mailcheck](/integrations/builtin/app-nodes/n8n-nodes-base.mailcheck.md) + * [Mailgun](/integrations/builtin/app-nodes/n8n-nodes-base.mailgun.md) + * [Mattermost](/integrations/builtin/app-nodes/n8n-nodes-base.mattermost.md) + * [Mautic](/integrations/builtin/app-nodes/n8n-nodes-base.mautic.md) + * [Medium](/integrations/builtin/app-nodes/n8n-nodes-base.medium.md) + * [Microsoft Excel 365](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftexcel.md) + * [Microsoft OneDrive](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftonedrive.md) + * [Microsoft Outlook](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftoutlook.md) + * [Microsoft SQL](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftsql.md) + * [Microsoft Teams](/integrations/builtin/app-nodes/n8n-nodes-base.microsoftteams.md) + * [Microsoft To Do](/integrations/builtin/app-nodes/n8n-nodes-base.microsofttodo.md) + * [Monday.com](/integrations/builtin/app-nodes/n8n-nodes-base.mondaycom.md) + * [MongoDB](/integrations/builtin/app-nodes/n8n-nodes-base.mongodb.md) + * [MQTT](/integrations/builtin/app-nodes/n8n-nodes-base.mqtt.md) + * [MySQL](/integrations/builtin/app-nodes/n8n-nodes-base.mysql/index.md) + * [NASA](/integrations/builtin/app-nodes/n8n-nodes-base.nasa.md) + * [Nextcloud](/integrations/builtin/app-nodes/n8n-nodes-base.nextcloud.md) + * [NocoDB](/integrations/builtin/app-nodes/n8n-nodes-base.nocodb.md) + * [Notion](/integrations/builtin/app-nodes/n8n-nodes-base.notion/index.md) + * [Odoo](/integrations/builtin/app-nodes/n8n-nodes-base.odoo.md) + * [OpenWeatherMap](/integrations/builtin/app-nodes/n8n-nodes-base.openweathermap.md) + * [Pipedrive](/integrations/builtin/app-nodes/n8n-nodes-base.pipedrive.md) + * [Postgres](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/index.md) + * [Pushover](/integrations/builtin/app-nodes/n8n-nodes-base.pushover.md) + * [QuickBooks Online](/integrations/builtin/app-nodes/n8n-nodes-base.quickbooks.md) + * [QuickChart](/integrations/builtin/app-nodes/n8n-nodes-base.quickchart.md) + * [RabbitMQ](/integrations/builtin/app-nodes/n8n-nodes-base.rabbitmq.md) + * [Reddit](/integrations/builtin/app-nodes/n8n-nodes-base.reddit.md) + * [Redis](/integrations/builtin/app-nodes/n8n-nodes-base.redis.md) + * [RocketChat](/integrations/builtin/app-nodes/n8n-nodes-base.rocketchat.md) + * [S3](/integrations/builtin/app-nodes/n8n-nodes-base.s3.md) + * [Salesforce](/integrations/builtin/app-nodes/n8n-nodes-base.salesforce.md) + * [Send Email](/integrations/builtin/core-nodes/n8n-nodes-base.sendemail.md) + * [SendGrid](/integrations/builtin/app-nodes/n8n-nodes-base.sendgrid.md) + * [SerpApi (Google Search)](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi.md) + * [Shopify](/integrations/builtin/app-nodes/n8n-nodes-base.shopify.md) + * [Slack](/integrations/builtin/app-nodes/n8n-nodes-base.slack.md) + * [Spotify](/integrations/builtin/app-nodes/n8n-nodes-base.spotify.md) + * [Stripe](/integrations/builtin/app-nodes/n8n-nodes-base.stripe.md) + * [Supabase](/integrations/builtin/app-nodes/n8n-nodes-base.supabase/index.md) + * [Telegram](/integrations/builtin/app-nodes/n8n-nodes-base.telegram/index.md) + * [Todoist](/integrations/builtin/app-nodes/n8n-nodes-base.todoist.md) + * [TOTP](/integrations/builtin/core-nodes/n8n-nodes-base.totp.md) + * [Trello](/integrations/builtin/app-nodes/n8n-nodes-base.trello.md) + * [Twilio](/integrations/builtin/app-nodes/n8n-nodes-base.twilio.md) + * [urlscan.io](/integrations/builtin/app-nodes/n8n-nodes-base.urlscanio.md) + * [Vector Store](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) + * [Webflow](/integrations/builtin/app-nodes/n8n-nodes-base.webflow.md) + * [Wikipedia](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia.md) + * [Wolfram|Alpha](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwolframalpha.md) + * [WooCommerce](/integrations/builtin/app-nodes/n8n-nodes-base.woocommerce.md) + * [Wordpress](/integrations/builtin/app-nodes/n8n-nodes-base.wordpress.md) + * [X (Formerly Twitter)](/integrations/builtin/app-nodes/n8n-nodes-base.twitter.md) + * [YouTube](/integrations/builtin/app-nodes/n8n-nodes-base.youtube.md) + * [Zendesk](/integrations/builtin/app-nodes/n8n-nodes-base.zendesk.md) + * [Zoho CRM](/integrations/builtin/app-nodes/n8n-nodes-base.zohocrm.md) + * [Zoom](/integrations/builtin/app-nodes/n8n-nodes-base.zoom.md) + +## Node parameters + +Configure the Tools Agent using the following parameters. + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +### Require Specific Output Format + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/output-format.md" + +## Node options + +Refine the Tools Agent node's behavior using these options: + +### System Message + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/system-message.md" + +### Max Iterations + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/max-iterations.md" + +### Return Intermediate Steps + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/return-intermediate-steps.md" + + +### Automatically Passthrough Binary Images + + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/binary-images.md" + +## Templates and examples + +Refer to the main AI Agent node's [Templates and examples](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md#templates-and-examples) section. + +## Dynamic parameters for tools with `$fromAI()` + +To learn how to dynamically populate parameters for app node tools, refer to [Let AI specify tool parameters with `$fromAI()`](/advanced-ai/examples/using-the-fromai-function.md). + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Basic LLM Chain node documentation +description: Learn how to use the Basic LLM Chain node in n8n. Follow technical documentation to integrate Basic LLM Chain node into your workflows. +contentType: [integration, reference] +priority: critical +--- + +# Basic LLM Chain node + +Use the Basic LLM Chain node to set the prompt that the model will use along with setting an optional parser for the response. + +On this page, you'll find the node parameters for the Basic LLM Chain node and links to more resources. + +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Basic LLM Chain integrations](https://n8n.io/integrations/basic-llm-chain/){:target=_blank .external-link} page. +/// + +## Node parameters + +### Prompt + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/prompt.md" + +### Require Specific Output Format + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/output-format.md" + +## Chat Messages + +Use **Chat Messages** when you're using a chat model to set a message. + +n8n ignores these options if you don't connect a chat model. Select the **Type Name or ID** you want the node to use: + +#### AI + +Enter a sample expected response in the **Message** field. The model will try to respond in the same way in its messages. + +#### System + +Enter a system **Message** to include with the user input to help guide the model in what it should do. + +Use this option for things like defining tone, for example: `Always respond talking like a pirate`. + +#### User + +Enter a sample user input. Using this with the AI option can help improve the output of the agent. Using both together provides a sample of an input and expected response (the **AI Message**) for the model to follow. + +Select one of these input types: + +* **Text**: Enter a sample user input as a text **Message**. +* **Image (Binary)**: Select a binary input from a previous node. Enter the **Image Data Field Name** to identify which binary field from the previous node contains the image data. +* **Image (URL)**: Use this option to feed an image in from a URL. Enter the **Image URL**. + +For both the **Image** types, select the **Image Details** to control how the model processes the image and generates its textual understanding. Choose from: + +* **Auto**: The model uses the auto setting, which looks at the image input size and decide if it should use the Low or High setting. +* **Low**: The model receives a low-resolution 512px x 512px version of the image and represents the image with a budget of 65 tokens. This allows the API to return faster responses and consume fewer input tokens. Use this option for use cases that don't require high detail. +* **High**: The model can access the low-resolution image and then creates detailed crops of input images as 512px squares based on the input image size. Each of the detailed crops uses twice the token budget (65 tokens) for a total of 129 tokens. Use this option for use cases that require high detail. + +## Templates and examples + + +[[ templatesWidget(page.title, 'basic-llm-chain') ]] + +## Related resources + +Refer to [LangChain's documentation on Basic LLM Chains](https://js.langchain.com/docs/tutorials/llm_chain/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + +## Common issues + +Here are some common errors and issues with the Basic LLM Chain node and steps to resolve or troubleshoot them. + +### No prompt specified error + +This error displays when the **Prompt** is empty or invalid. + +You might see this error in one of two scenarios: + +1. When you've set the **Prompt** to **Define below** and haven't entered anything in the **Text** field. + * To resolve, enter a valid prompt in the **Text** field. +2. When you've set the **Prompt** to **Connected Chat Trigger Node** and the incoming data has no field called `chatInput`. + * The node expects the `chatInput` field. If your previous node doesn't have this field, add an [Edit Fields (Set)](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node to edit an incoming field name to `chatInput`. + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Question and Answer Chain node common issues +description: Documentation for common issues and questions in the Question and Answer Chain node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Question and Answer Chain node common issues + +Here are some common errors and issues with the [Question and Answer Chain node](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) and steps to resolve or troubleshoot them. + +## No prompt specified error + +This error displays when the **Prompt** is empty or invalid. + +You might see this in one of two scenarios: + +1. When you've set the **Prompt** to **Define below** and have an expression in your **Text** that isn't generating a value. + * To resolve, enter a valid prompt in the **Text** field. + * Make sure any expressions reference valid fields and that they resolve to valid input rather than null. +2. When you've set the **Prompt** to **Connected Chat Trigger Node** and the incoming data has null values. + * To resolve, make sure your input contains a `chatInput` field. Add an [Edit Fields (Set)](/integrations/builtin/core-nodes/n8n-nodes-base.set.md) node to edit an incoming field name to `chatInput`. + * Remove any null values from the `chatInput` field of the input node. + + +## A Retriever sub-node must be connected error + + +This error displays when n8n tries to execute the node without having a Retriever connected. + +To resolve this, click the + Retriever button at the bottom of your screen when the node is open, or click the Retriever + connector when the node isn't open. n8n will then open a selection of possible Retrievers to pick from. + +## Can't produce longer responses + +If you need to generate longer responses than the Question and Answer Chain node produces by default, you can try one or more of the following techniques: + +* **Connect a more verbose model**: Some AI models produce more terse results than others. Swapping your model for one with a larger context window and more verbose output can increase the word length of your responses. +* **Increase the maximum number of tokens**: Many model nodes (for example the [OpenAI Chat Model](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md#maximum-number-of-tokens)) include a **Maximum Number of Tokens** option. You can set this to increase the maximum number of tokens the model can use to produce a response. +* **Build larger responses in stages**: For more detailed answers, you may want to construct replies in stages using a variety of AI nodes. You can use AI split up a single question into multiple prompts and create responses for each. You can then compose a final reply by combining the responses again. Though the details are different, you can find a good example of the general idea in this [template for writing a WordPress post with AI](https://n8n.io/workflows/2187-write-a-wordpress-post-with-ai-starting-from-a-few-keywords/). + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Question and Answer Chain node documentation +description: Learn how to use the Question and Answer Chain node in n8n. Follow technical documentation to integrate Question and Answer Chain node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Question and Answer Chain node + +Use the Question and Answer Chain node to use a [vector store](/glossary.md#ai-vector-store) as a retriever. + +On this page, you'll find the node parameters for the Question and Answer Chain node, and links to more resources. + +## Node parameters + +### Query + +The question you want to ask. + +## Templates and examples + + +[[ templatesWidget(page.title, 'retrieval-qanda-chain') ]] + +## Related resources + +Refer to [LangChain's documentation on retrieval chains](https://js.langchain.com/docs/tutorials/rag/){:target=_blank .external-link} for examples of how LangChain can use a vector store as a retriever. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common errors or issues and suggested resolution steps, refer to [Common Issues](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainsummarization.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Summarization Chain node documentation +description: Learn how to use the Summarize Chain node in n8n. Follow technical documentation to integrate Summarize Chain node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Summarization Chain node + +Use the Summarization Chain node to summarize multiple documents. + +On this page, you'll find the node parameters for the Summarization Chain node, and links to more resources. + +## Node parameters + +Choose the type of data you need to summarize in **Data to Summarize**. The data type you choose determines the other node parameters. + +* **Use Node Input (JSON)** and **Use Node Input (Binary)**: summarize the data coming into the node from the workflow. + * You can configure the **Chunking Strategy**: choose what strategy to use to define the data chunk sizes. + * If you choose **Simple (Define Below)** you can then set **Characters Per Chunk** and **Chunk Overlap (Characters)**. + * Choose **Advanced** if you want to connect a splitter sub-node that provides more configuration options. +* **Use Document Loader**: summarize data provided by a document loader sub-node. + +## Node Options + +You can configure the summarization method and prompts. Select **Add Option** > **Summarization Method and Prompts**. + +Options in **Summarization Method**: + +* **Map Reduce**: this is the recommended option. Learn more about [Map Reduce](https://js.langchain.com/v0.1/docs/modules/chains/document/map_reduce/){:target=_blank .external-link} in the LangChain documentation. +* **Refine**: learn more about [Refine](https://js.langchain.com/v0.1/docs/modules/chains/document/refine/){:target=_blank .external-link} in the LangChain documentation. +* **Stuff**: learn more about [Stuff](https://js.langchain.com/v0.1/docs/modules/chains/document/stuff/){:target=_blank .external-link} in the LangChain documentation. + +You can customize the **Individual Summary Prompts** and the **Final Prompt to Combine**. There are examples in the node. You must include the `"{text}"` placeholder. + +## Templates and examples + + +[[ templatesWidget(page.title, 'summarization-chain') ]] + +## Related resources + +Refer to [LangChain's documentation on summarization](https://js.langchain.com/docs/tutorials/summarization/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.code.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: LangChain Code node documentation +description: Learn how to use the LangChain Code node in n8n. Follow technical documentation to integrate LangChain Code node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# LangChain Code node + +Use the LangChain Code node to import LangChain. This means if there is functionality you need that n8n hasn't created a node for, you can still use it. By configuring the LangChain Code node connectors you can use it as a normal node, root node or sub-node. + +On this page, you'll find the node parameters, guidance on configuring the node, and links to more resources. + +/// note | Not available on Cloud +This node is only available on self-hosted n8n. +/// + +## Node parameters + +### Add Code + +Add your custom code. Choose either **Execute** or **Supply Data** mode. You can only use one mode. + +Unlike the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md), the LangChain Code node doesn't support Python. + +* **Execute**: use the LangChain Code node like n8n's own Code node. This takes input data from the workflow, processes it, and returns it as the node output. This mode requires a main input and output. You must create these connections in **Inputs** and **Outputs**. +* **Supply Data**: use the LangChain Code node as a sub-node, sending data to a root node. This uses an output other than main. + +By default, you can't load built-in or external modules in this node. Self-hosted users can [enable built-in and external modules](/hosting/configuration/configuration-methods.md). + +### Inputs + +Choose the input types. + +The main input is the normal connector found in all n8n workflows. If you have a main input and output set in the node, **Execute** code is required. + +### Outputs + +Choose the output types. + +The main output is the normal connector found in all n8n workflows. If you have a main input and output set in the node, **Execute** code is required. + +## Node inputs and outputs configuration + +By configuring the LangChain Code node connectors (inputs and outputs) you can use it as an app node, root node or sub-node. + +![Screenshot of a workflow with four LangChain nodes, configured as different node types](/_images/integrations/builtin/cluster-nodes/langchaincode/create-node-types.png) + +| Node type | Inputs | Outputs | Code mode | +| --------- | ------ | ------- | --------- | +| App node. Similar to the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md). | Main | Main | Execute | +| Root node | Main; at least one other type | Main | Execute | +| Sub-node | - | A type other than main. Must match the input type you want to connect to. | Supply Data | +| Sub-node with sub-nodes | A type other than main |A type other than main. Must match the input type you want to connect to. | Supply Data | + +## Built-in methods + +n8n provides these methods to make it easier to perform common tasks in the LangChain Code node. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/langchaincode/builtin-methods.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'langchain-code') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.information-extractor.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Information Extractor node documentation +description: Learn how to use the Information Extractor node in n8n. Follow technical documentation to integrate Information Extractor node into your workflows. +contentType: [integration, reference] +--- + +# Information Extractor node + +Use the Information Extractor node to extract structured information from incoming data. + +On this page, you'll find the node parameters for the Information Extractor node, +and links to more resources. + +## Node parameters + +* **Text** defines the input text to extract information from. This is usually an expression that references a field from the input items. For example, this could be `{{ $json.chatInput }}` if the input is a chat trigger, or `{{ $json.text }}` if a previous node is Extract from PDF. +* Use **Schema Type** to choose how you want to describe the desired output data format. You can choose between: + * **From Attribute Description**: This option allows you to define the schema by specifying the list of attributes and their descriptions. + * **Generate From JSON Example**: Input an example JSON object to automatically generate the schema. The node uses the object property types and names. It ignores the actual values. + * **Define Below**: Manually input the JSON schema. Read the JSON Schema [guides and examples](https://json-schema.org/learn/miscellaneous-examples){:target=_blank .external-link} for help creating a valid JSON schema. + +## Node options + +* **System Prompt Template**: Use this option to change the system prompt that's used for the information extraction. n8n automatically appends format specification instructions to the prompt. + + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.sentimentanalysis.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Sentiment Analysis node documentation +description: Learn how to use the Sentiment Analysis node in n8n. Follow technical documentation to integrate Sentiment Analysis node into your workflows. +contentType: [integration, reference] +--- + +# Sentiment Analysis node + +Use the Sentiment Analysis node to analyze the sentiment of incoming text data. + +The language model uses the [**Sentiment Categories**](#node-options) in the node options to determine each item's sentiment. + +## Node parameters + +* **Text to Analyze** defines the input text for sentiment analysis. This is an expression that references a field from the input items. For example, this could be +`{{ $json.chatInput }}` if the input is from a chat or message source. By default, it expects a `text` field. + +## Node options + +* **Sentiment Categories**: Define the categories that you want to classify your input as. + * By default, these are `Positive, Neutral, Negative`. You can customize these categories to fit your specific use case, such as `Very Positive, Positive, Neutral, Negative, Very Negative` for more granular analysis. +* **Include Detailed Results**: When turned on, this option includes sentiment strength and confidence scores in the output. Note that these scores are estimates generated by the language model and are rough indicators rather than precise measurements. +* **System Prompt Template**: Use this option to change the system prompt that's used for the sentiment analysis. It uses the `{categories}` placeholder for the categories. +* **Enable Auto-Fixing**: When enabled, the node automatically fixes model outputs to ensure they match the expected format. Do this by sending the schema parsing error to the LLM and asking it to fix it. + +## Usage Notes + +### Model Temperature Setting + +It's strongly advised to set the temperature of the connected language model to 0 or a value close to 0. This helps ensure that the results are as deterministic as possible, providing more consistent and reliable sentiment analysis across multiple runs. + +### Language Considerations + +The node's performance may vary depending on the language of the input text. + +For best results, ensure your chosen language model supports the input language. + +### Processing Large Volumes + +When analyzing large amounts of text, consider splitting the input into smaller chunks to optimize processing time and resource usage. + +### Iterative Refinement + +For complex sentiment analysis tasks, you may need to iteratively refine the system prompt and categories to achieve the desired results. + +## Example Usage + +### Basic Sentiment Analysis + +1. Connect a data source (for example, RSS Feed, HTTP Request) to the Sentiment Analysis node. +2. Set the "Text to Analyze" field to the relevant item property (for example, `{{ $json.content }}` for blog post content). +3. Keep the default sentiment categories. +4. Connect the node's outputs to separate paths for processing positive, neutral, and negative sentiments differently. + +### Custom Category Analysis + +1. Change the **Sentiment Categories** to `Excited, Happy, Neutral, Disappointed, Angry`. +2. Adjust your workflow to handle these five output categories. +3. Use this setup to analyze customer feedback with more nuanced emotional categories. + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.text-classifier.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Text Classifier node documentation +description: Learn how to use the Text Classifier node in n8n. Follow technical documentation to integrate Text Classifier node into your workflows. +contentType: [integration, reference] +--- + +# Text Classifier node + +Use the Text Classifier node to classify (categorize) incoming data. Using the categories provided in the parameters (see below), each item is passed to the model to determine its category. + +On this page, you'll find the node parameters for the Text Classifier node, and links to more resources. + +## Node parameters + +* **Input Prompt** defines the input to classify. This is usually an expression that references a field from the input items. For example, this could be `{{ $json.chatInput }}` if the input is a chat trigger. By default it references the `text` field. +* **Categories**: Add the categories that you want to classify your input as. Categories have a name and a description. Use the description to tell the model what the category means. This is important if the meaning isn't obvious. You can add as many categories as you like. + +## Node options + +* **Allow Multiple Classes To Be True**: You can configure the classifier to always output a single class per item (turned off), or allow the model to select multiple classes (turned on). +* **When No Clear Match**: Define what happens if the model can't find a good match for an item. There are two options: + - **Discard Item** (the default): If the node doesn't detect any of the categories, it drops the item. + - **Output on Extra, 'Other' Branch**: Creates a separate output branch called **Other**. When the node doesn't detect any of the categories, it outputs items in this branch. +* **System Prompt Template**: Use this option to change the system prompt that's used for the classification. It uses the `{categories}` placeholder for the categories. + +* **Enable Auto-Fixing**: When enabled, the node automatically fixes model outputs to ensure they match the expected format. Do this by sending the schema parsing error to the LLM and asking it to fix it. + + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreinmemory.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Simple Vector Store node documentation +description: Learn how to use the Simple Vector Store node in n8n. Follow technical documentation to integrate Simple Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Simple Vector Store node + +Use the Simple Vector Store node to store and retrieve [embeddings](/glossary.md#ai-embedding) in n8n's in-app memory. + +On this page, you'll find the node parameters for the Simple Vector Store node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +/// note | This node is different from AI memory nodes +The simple vector storage described here is different to the AI memory nodes such as [Simple Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md). + +This node creates a [vector database](/glossary.md#ai-vector-store) in the app memory. +/// + + +/// warning | For development use only +This node stores data in memory only and isn't recommended for production use. All data is lost when n8n restarts and may also be purged in low-memory conditions. +/// + +## Node usage patterns + +You can use the Simple Vector Store node in the following patterns. + +### Use as a regular node to insert and retrieve documents + +You can use the Simple Vector Store as a regular node to insert or get documents. This pattern places the Simple Vector Store in the regular connection flow without using an agent. + +You can see an example of in step 2 of [this template](https://n8n.io/workflows/2465-building-your-first-whatsapp-chatbot/). + +### Connect directly to an AI agent as a tool + +You can connect the Simple Vector Store node directly to the [tool](/glossary.md#ai-tool) connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Simple Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the Simple Vector Store node to fetch documents from the Simple Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) (the linked example uses Pinecone, but the pattern is the same) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Simple Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the Simple Vector Store node. Rather than connecting the Simple Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2465-building-your-first-whatsapp-chatbot/) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Simple Vector store. + +## Memory Management + +The Simple Vector Store implements memory management to prevent excessive memory usage: + +- Automatically cleans up old vector stores when memory pressure increases +- Removes inactive stores that haven't been accessed for a configurable amount of time +- Each workflow gets its own isolated storage space identified by the workflow ID and memory key + +### Configuration Options + +You can control memory usage with these environment variables: + + | Variable | Type | Default | Description | + |-------------------------------|--------|---------|-------------------------------------------------------------------------------------| + | `N8N_VECTOR_STORE_MAX_MEMORY` | Number | -1 | Maximum memory in MB allowed for all vector stores combined (-1 to disable limits). | + | `N8N_VECTOR_STORE_TTL_HOURS` | Number | -1 | Hours of inactivity after which a store gets removed (-1 to disable TTL). | + +On n8n Cloud, these values are preset to 100MB (about 8,000 documents, depending on document size and metadata) and 7 days respectively. For self-hosted instances, both values default to -1(no memory limits or time-based cleanup). + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + + +### Get Many parameters + + +* **Memory Key**: Enter the key to use to store the vector memory in the workflow data. n8n prefixes the key with the workflow ID to avoid collisions. +* **Prompt**: Enter the search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + + +### Insert Documents parameters + +* **Memory Key**: Enter the key to use to store the vector memory in the workflow data. n8n prefixes the key with the workflow ID to avoid collisions. +* **Clear Store**: Use this parameter to control whether to wipe the vector store for the given memory key for this workflow before inserting data (turned on). + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Memory Key**: Enter the key to use to store the vector memory in the workflow data. n8n prefixes the key with the workflow ID to avoid collisions. + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Memory Key**: Enter the key to use to store the vector memory in the workflow data. n8n prefixes the key with the workflow ID to avoid collisions. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Templates and examples + + +[[ templatesWidget(page.title, 'in-memory-vector-store') ]] + +## Related resources + +Refer to [LangChains's Memory Vector Store documentation](https://js.langchain.com/docs/integrations/vectorstores/memory/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremilvus.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Milvus Vector Store node documentation +description: Learn how to use the Milvus Vector Store node in n8n. Follow technical documentation to integrate Milvus Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Milvus Vector Store node + +Use the Milvus node to interact with your Milvus database as [vector store](/glossary.md#ai-vector-store). You can insert documents into a vector database, get documents from a vector database, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect directly to an [agent](/glossary.md#ai-agent) as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the Milvus node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/milvus.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node usage patterns + +You can use the Milvus Vector Store node in the following patterns. + +### Use as a regular node to insert and retrieve documents + +You can use the Milvus Vector Store as a regular node to insert, or get documents. This pattern places the Milvus Vector Store in the regular connection flow without using an agent. + +See this [example template](https://n8n.io/workflows/3573-create-a-rag-system-with-paul-essays-milvus-and-openai-for-cited-answers/) for how to build a system that stores documents in Milvus and retrieves them to support cited, chat-based answers. + + +### Connect directly to an AI agent as a tool + +You can connect the Milvus Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Milvus Vector Store node. See this [example template](https://n8n.io/workflows/3576-paul-graham-essay-search-and-chat-with-milvus-vector-database/) where data is embedded and indexed in Milvus, and the AI Agent uses the vector store as a knowledge tool for question-answering. + + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the Milvus Vector Store node to fetch documents from the Milvus Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +A typical node connection flow looks like this: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Milvus Vector Store. + +Check out this [workflow example](https://n8n.io/workflows/3574-create-a-paul-graham-essay-qanda-system-with-openai-and-milvus-vector-database/) to see how to ingest external data into Milvus and build a chat-based semantic Q&A system. + + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the Milvus Vector Store node. Rather than connecting the Milvus Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The connections flow would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Milvus Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + + +### Get Many parameters + + +* **Milvus Collection**: Select or enter the Milvus Collection to use. +* **Prompt**: Enter your search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Insert Documents parameters + +* **Milvus Collection**: Select or enter the Milvus Collection to use. +* **Clear Collection**: Specify whether to clear the collection before inserting new documents. + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Milvus collection**: Select or enter the Milvus Collection to use. + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Milvus Collection**: Select or enter the Milvus Collection to use. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Node options + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +### Clear Collection + +Available in **Insert Documents** mode. Deletes all data from the collection before inserting the new data. + +## Related resources + +Refer to [LangChain's Milvus documentation](https://js.langchain.com/docs/integrations/vectorstores/milvus/) for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoremongodbatlas.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MongoDB Atlas Vector Store node documentation +description: Learn how to use the MongoDB Atlas Vector Store node in n8n. Follow technical documentation to integrate MongoDB Atlas Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# MongoDB Atlas Vector Store node + +MongoDB Atlas Vector Search is a feature of MongoDB Atlas that enables users to store and query vector embeddings. Use this node to interact with Vector Search indexes in your MongoDB Atlas collections. You can insert documents, retrieve documents, and use the vector store in chains or as a tool for agents. + +On this page, you'll find the node parameters for the MongoDB Atlas Vector Store node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/mongodb.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Prerequisites + +Before using this node, create a [Vector Search index](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-type/) in your MongoDB Atlas collection. Follow these steps to create one: + +1. Log in to the [MongoDB Atlas dashboard](https://cloud.mongodb.com/). + +3. Select your organization and project. +4. Find "Search & Vector Search" section. +5. Select your cluster and click "Go to search". +7. Click "Create Search Index". +8. Choose "Vector Search" mode and use the visual or JSON editors. For example: + ```json + { + "fields": [ + { + "type": "vector", + "path": "", + "numDimensions": 1536, // any other value + "similarity": "" + } + ] + } + ``` + +9. Adjust the "dimensions" value according to your embedding model (For example, `1536` for OpenAI's `text-embedding-small-3`). +10. Name your index and create. + +Make sure to note the following values which are required when configuring the node: + +- Collection name +- Vector index name +- Field names for embeddings and metadata + +## Node usage patterns + +You can use the MongoDB Atlas Vector Store node in the following patterns: + +### Use as a regular node to insert and retrieve documents + +You can use the MongoDB Atlas Vector Store as a regular node to insert or get documents. This pattern places the MongoDB Atlas Vector Store in the regular connection flow without using an agent. + +You can see an example of this in scenario 1 of [this template](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/) (the template uses the Supabase Vector Store, but the pattern is the same). + +### Connect directly to an AI agent as a tool + +You can connect the MongoDB Atlas Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use the vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> MongoDB Atlas Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the MongoDB Atlas Vector Store node to fetch documents from the MongoDB Atlas Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) (the linked example uses Pinecone, but the pattern is the same) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> MongoDB Atlas Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the MongoDB Atlas Vector Store node. Rather than connecting the MongoDB Atlas Vector Store directly as a tool, this pattern uses a tool specifically designed to summarize data in the vector store. + +The [connections flow](https://n8n.io/workflows/2465-building-your-first-whatsapp-chatbot/) (the linked example uses the In-Memory Vector Store, but the pattern is the same) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> In-Memory Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + + +### Get Many parameters + + +- **Mongo Collection**: Enter the name of the MongoDB collection to use. +- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection. +- **Embedding Field**: Enter the field name in your documents that contains the vector embeddings. +- **Metadata Field**: Enter the field name in your documents that contains the text metadata. + +### Insert Documents parameters + +- **Mongo Collection**: Enter the name of the MongoDB collection to use. +- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection. +- **Embedding Field**: Enter the field name in your documents that contains the vector embeddings. +- **Metadata Field**: Enter the field name in your documents that contains the text metadata. + +### Retrieve Documents parameters (As Vector Store for Chain/Tool) + +- **Mongo Collection**: Enter the name of the MongoDB collection to use. +- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection. +- **Embedding Field**: Enter the field name in your documents that contains the vector embeddings. +- **Metadata Field**: Enter the field name in your documents that contains the text metadata. + +### Retrieve Documents (As Tool for AI Agent) parameters + +- **Name**: The name of the vector store. +- **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +- **Mongo Collection**: Enter the name of the MongoDB collection to use. +- **Vector Index Name**: Enter the name of the Vector Search index in your MongoDB Atlas collection. +- **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Node options + +### Options + +- **Metadata Filter**: Filters results based on metadata. + +## Templates and examples + + +[[ templatesWidget(page.title, 'mongodb-atlas-vector-store') ]] + +## Related resources + +Refer to: + +- [LangChain's MongoDB Atlas Vector Search documentation](https://js.langchain.com/docs/integrations/vectorstores/mongodb_atlas){:target=_blank .external-link} for more information about the service. +- [MongoDB Atlas Vector Search documentation](https://www.mongodb.com/docs/atlas/atlas-vector-search/){:target=_blank .external-link} for more information about MongoDB Atlas Vector Search. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_snippets/self-hosting/starter-kits/self-hosted-ai-starter-kit.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepgvector.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: PGVector Vector Store node documentation +description: Learn how to use the PGVector Vector Store node in n8n. Follow technical documentation to integrate PGVector Vector Store node into your workflows. +priority: medium +--- + +# PGVector Vector Store node + +PGVector is an extension of Postgresql. Use this node to interact with the PGVector tables in your Postgresql database. You can insert documents into a vector table, get documents from a vector table, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect directly to an [agent](/glossary.md#ai-agent) as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the PGVector node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/postgres.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node usage patterns + +You can use the PGVector Vector Store node in the following patterns. + +### Use as a regular node to insert and retrieve documents + +You can use the PGVector Vector Store as a regular node to insert or get documents. This pattern places the PGVector Vector Store in the regular connection flow without using an agent. + +You can see an example of this in scenario 1 of [this template](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/) (the template uses the Supabase Vector Store, but the pattern is the same). + +### Connect directly to an AI agent as a tool + +You can connect the PGVector Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> PGVector Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the PGVector Vector Store node to fetch documents from the PGVector Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) (the linked example uses Pinecone, but the pattern is the same) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> PGVector Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the PGVector Vector Store node. Rather than connecting the PGVector Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2465-building-your-first-whatsapp-chatbot/) (the linked example uses the Simple Vector Store, but the pattern is the same) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Simple Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + + +### Get Many parameters + + +* **Table name**: Enter the name of the table you want to query. +* **Prompt**: Enter your search query. +* **Limit**: Enter a number to set how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Insert Documents parameters + +* **Table name**: Enter the name of the table you want to query. + +### Retrieve Documents parameters (As Vector Store for Chain/Tool) + +* **Table name**: Enter the name of the table you want to query. + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Table Name**: Enter the PGVector table to use. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Node options + +### Collection + +A way to separate datasets in PGVector. This creates a separate table and column to keep track of which collection a vector belongs to. + +* **Use Collection**: Select whether to use a collection (turned on) or not (turned off). +* **Collection Name**: Enter the name of the collection you want to use. +* **Collection Table Name**: Enter the name of the table to store collection information in. + +### Column Names + +The following options specify the names of the columns to store the vectors and corresponding information in: + +* **ID Column Name** +* **Vector Column Name** +* **Content Column Name** +* **Metadata Column Name** + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'postgres-pgvector-store') ]] + +## Related resources + +Refer to [LangChain's PGVector documentation](https://js.langchain.com/docs/integrations/vectorstores/pgvector){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_snippets/self-hosting/starter-kits/self-hosted-ai-starter-kit.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Pinecone Vector Store node documentation +description: Learn how to use the Pinecone Vector Store node in n8n. Follow technical documentation to integrate Pinecone Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Pinecone Vector Store node + +Use the Pinecone node to interact with your Pinecone database as [vector store](/glossary.md#ai-vector-store). You can insert documents into a vector database, get documents from a vector database, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect directly to an [agent](/glossary.md#ai-agent) as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the Pinecone node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/pinecone.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node usage patterns + +You can use the Pinecone Vector Store node in the following patterns. + +### Use as a regular node to insert, update, and retrieve documents + +You can use the Pinecone Vector Store as a regular node to insert, update, or get documents. This pattern places the Pinecone Vector Store in the regular connection flow without using an agent. + +You can see an example of this in scenario 1 of [this template](https://n8n.io/workflows/2165-chat-with-pdf-docs-using-ai-quoting-sources/). + +### Connect directly to an AI agent as a tool + +You can connect the Pinecone Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Pinecone Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the Pinecone Vector Store node to fetch documents from the Pinecone Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Pinecone Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the Pinecone Vector Store node. Rather than connecting the Pinecone Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2705-chat-with-github-api-documentation-rag-powered-chatbot-with-pinecone-and-openai/) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Pinecone Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode-with-update.md" + + +### Get Many parameters + + +* **Pinecone Index**: Select or enter the Pinecone Index to use. +* **Prompt**: Enter your search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Insert Documents parameters + +* **Pinecone Index**: Select or enter the Pinecone Index to use. + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Pinecone Index**: Select or enter the Pinecone Index to use. + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Pinecone Index**: Select or enter the Pinecone Index to use. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Node options + +### Pinecone Namespace + +Another segregation option for how to store your data within the index. + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +### Clear Namespace + +Available in **Insert Documents** mode. Deletes all data from the namespace before inserting the new data. + +## Templates and examples + + +[[ templatesWidget(page.title, 'pinecone-vector-store') ]] + +## Related resources + +Refer to [LangChain's Pinecone documentation](https://js.langchain.com/docs/integrations/vectorstores/pinecone/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +### Find your Pinecone index and namespace + +Your Pinecone index and namespace are available in your Pinecone account. + +![Screenshot of a Pinecone account, with the Pinecone index labelled](/_images/integrations/builtin/cluster-nodes/vectorstorepinecone/pinecone-index-namespace.png) +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoreqdrant.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Qdrant Vector Store node documentation +description: Learn how to use the Qdrant Vector Store node in n8n. Follow technical documentation to integrate Qdrant Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Qdrant Vector Store node + +Use the Qdrant node to interact with your Qdrant collection as a [vector store](/glossary.md#ai-vector-store). You can insert documents into a vector database, get documents from a vector database, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain) or connect it directly to an [agent](/glossary.md#ai-agent) to use as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the Qdrant node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/qdrant.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node usage patterns + +You can use the Qdrant Vector Store node in the following patterns. + +### Use as a regular node to insert and retrieve documents + +You can use the Qdrant Vector Store as a regular node to insert or get documents. This pattern places the Qdrant Vector Store in the regular connection flow without using an agent. + +You can see an example of this in the first part of [this template](https://n8n.io/workflows/2440-building-rag-chatbot-for-movie-recommendations-with-qdrant-and-open-ai/). + +### Connect directly to an AI agent as a tool + +You can connect the Qdrant Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Qdrant Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the Qdrant Vector Store node to fetch documents from the Qdrant Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/2183-ai-crew-to-automate-fundamental-stock-analysis-qanda-workflow/) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Qdrant Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the Qdrant Vector Store node. Rather than connecting the Qdrant Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2464-scale-deal-flow-with-a-pitch-deck-ai-vision-chatbot-and-qdrant-vector-store/) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Qdrant Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + + +### Get Many parameters + + +* **Qdrant collection name**: Enter the name of the Qdrant collection to use. +* **Prompt**: Enter the search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +This Operation Mode includes one **Node option**, the [Metadata Filter](#metadata-filter). + +### Insert Documents parameters + +* **Qdrant collection name**: Enter the name of the Qdrant collection to use. + +This Operation Mode includes one **Node option**: + +* **Collection Config**: Enter JSON options for creating a Qdrant collection creation configuration. Refer to the Qdrant [Collections](https://qdrant.tech/documentation/concepts/collections/){:target=_blank .external-link} documentation for more information. + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Qdrant Collection**: Enter the name of the Qdrant collection to use. + +This Operation Mode includes one **Node option**, the [Metadata Filter](#metadata-filter). + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Qdrant Collection**: Enter the name of the Qdrant collection to use. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Node options + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'qdrant-vector-store') ]] + +## Related resources + +Refer to [LangChain's Qdrant documentation](https://js.langchain.com/docs/integrations/vectorstores/qdrant){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_snippets/self-hosting/starter-kits/self-hosted-ai-starter-kit.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Supabase Vector Store node documentation +description: Learn how to use the Supabase Vector Store node in n8n. Follow technical documentation to integrate Supabase Vector Store node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Supabase Vector Store node + +Use the Supabase Vector Store to interact with your Supabase database as [vector store](/glossary.md#ai-vector-store). You can insert documents into a vector database, get documents from a vector database, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect it directly to an [agent](/glossary.md#ai-agent) to use as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the Supabase node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/supabase.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +Supabase provides a [quickstart for setting up your vector store](https://supabase.com/docs/guides/ai/langchain?database-method=sql){:target=_blank .external-link}. If you use settings other than the defaults in the quickstart, this may affect parameter settings in n8n. Make sure you understand what you're doing. + +## Node usage patterns + +You can use the Supabase Vector Store node in the following patterns. + +### Use as a regular node to insert, update, and retrieve documents + +You can use the Supabase Vector Store as a regular node to insert, update, or get documents. This pattern places the Supabase Vector Store in the regular connection flow without using an agent. + +You can see an example of this in scenario 1 of [this template](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/). + +### Connect directly to an AI agent as a tool + +You can connect the Supabase Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Supabase Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the Supabase Vector Store node to fetch documents from the Supabase Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) (the example uses Pinecone, but the pattern in the same) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Supabase Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the Supabase Vector Store node. Rather than connecting the Supabase Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Supabase Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode-with-update.md" + + +### Get Many parameters + + +* **Table Name**: Enter the Supabase table to use. +* **Prompt**: Enter the search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Insert Documents parameters + +* **Table Name**: Enter the Supabase table to use. + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Table Name**: Enter the Supabase table to use. + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Table Name**: Enter the Supabase table to use. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Update Documents + +* **Table Name**: Enter the Supabase table to use. +* **ID**: The ID of an embedding entry. + +## Node options + +### Query Name + +The name of the matching function you set up in Supabase. If you follow the [Supabase quickstart](https://supabase.com/docs/guides/ai/langchain?database-method=sql){:target=_blank .external-link}, this will be `match_documents`. + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'supabase-vector-store') ]] + +## Related resources + +Refer to [LangChain's Supabase documentation](https://js.langchain.com/docs/integrations/vectorstores/supabase/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorezep.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zep Vector Store node documentation +description: Learn how to use the Zep Vector Store node in n8n. Follow technical documentation to integrate Zep Vector Store node into your workflows. +contentType: [integration, reference] +--- + +# Zep Vector Store node + +Use the Zep Vector Store to interact with Zep vector databases. You can insert documents into a vector database, get documents from a vector database, retrieve documents to provide them to a retriever connected to a [chain](/glossary.md#ai-chain), or connect it directly to an [agent](/glossary.md#ai-agent) to use as a [tool](/glossary.md#ai-tool). + +On this page, you'll find the node parameters for the Zep Vector Store node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/zep.md). +/// + +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Zep Vector Store integrations](https://n8n.io/integrations/zep-vector-store/){:target=_blank .external-link} page. +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node usage patterns + +You can use the Zep Vector Store node in the following patterns. + +### Use as a regular node to insert, update, and retrieve documents + +You can use the Zep Vector Store as a regular node to insert or get documents. This pattern places the Zep Vector Store in the regular connection flow without using an agent. + +You can see an example of this in scenario 1 of [this template](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/) (the example uses Supabase, but the pattern is the same). + +### Connect directly to an AI agent as a tool + +You can connect the Zep Vector Store node directly to the tool connector of an [AI agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) to use a vector store as a resource when answering queries. + +Here, the connection would be: AI agent (tools connector) -> Zep Vector Store node. + +### Use a retriever to fetch documents + +You can use the [Vector Store Retriever](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md) node with the Zep Vector Store node to fetch documents from the Zep Vector Store node. This is often used with the [Question and Answer Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainretrievalqa/index.md) node to fetch documents from the vector store that match the given chat input. + +An [example of the connection flow](https://n8n.io/workflows/1960-ask-questions-about-a-pdf-using-ai/) (the example uses Pinecone, but the pattern in the same) would be: Question and Answer Chain (Retriever connector) -> Vector Store Retriever (Vector Store connector) -> Zep Vector Store. + +### Use the Vector Store Question Answer Tool to answer questions + +Another pattern uses the [Vector Store Question Answer Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md) to summarize results and answer questions from the Zep Vector Store node. Rather than connecting the Zep Vector Store directly as a tool, this pattern uses a tool specifically designed to summarizes data in the vector store. + +The [connections flow](https://n8n.io/workflows/2621-ai-agent-to-chat-with-files-in-supabase-storage/) (this example uses Supabase, but the pattern is the same) in this case would look like this: AI agent (tools connector) -> Vector Store Question Answer Tool (Vector Store connector) -> Zep Vector store. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/cluster-nodes/vector-store-mode.md" + +### Insert Documents parameters + +* **Collection Name**: Enter the collection name to store the data in. + + +### Get Many parameters + + +* **Collection Name**: Enter the collection name to retrieve the data from. +* **Prompt**: Enter the search query. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +### Retrieve Documents (As Vector Store for Chain/Tool) parameters + +* **Collection Name**: Enter the collection name to retrieve the data from. + +### Retrieve Documents (As Tool for AI Agent) parameters + +* **Name**: The name of the vector store. +* **Description**: Explain to the LLM what this tool does. A good, specific description allows LLMs to produce expected results more often. +* **Collection Name**: Enter the collection name to retrieve the data from. +* **Limit**: Enter how many results to retrieve from the vector store. For example, set this to `10` to get the ten best results. + +## Node options + +### Embedding Dimensions + +Must be the same when embedding the data and when querying it. + +This sets the size of the array of floats used to represent the semantic meaning of a text document. + +Read more about Zep embeddings in [Zep's embeddings documentation](https://docs.getzep.com/deployment/embeddings/){:target=_blank .external-link}. + +### Is Auto Embedded + +Available in the **Insert Documents** Operation Mode, enabled by default. + +Disable this to configure your embeddings in Zep instead of in n8n. + +### Metadata Filter + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-root-nodes/vector-store-metadata-filter.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'zep-vector-store') ]] + +## Related resources + +Refer to [LangChain's Zep documentation](https://js.langchain.com/docs/integrations/vectorstores/zep/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +title: Sub-nodes +description: Understand sub-nodes in n8n, and browse the sub-nodes library. +--- + +# Sub nodes + +Sub nodes attach to root nodes within a group of cluster nodes. They configure the overall functionality of the cluster. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/cluster-nodes-summary.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentdefaultdataloader.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Default Data Loader node documentation +description: Learn how to use the Default Data Loader node in n8n. Follow technical documentation to integrate Default Data Loader node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Default Data Loader node + +Use the Default Data Loader node to load binary data files or JSON data for [vector stores](/glossary.md#ai-vector-store) or summarization. + +On this page, you'll find a list of parameters the Default Data Loader node supports, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Type of Data**: Select **Binary** or **JSON**. +* **Data Format**: Displays when you set **Type of Data** to **Binary**. Select the file MIME type for your binary data. Set to **Automatically Detect by MIME Type** if you want n8n to set the data format for you. If you set a specific data format and the incoming file MIME type doesn't match it, the node errors. If you use **Automatically Detect by MIME Type**, the node falls back to text format if it can't match the file MIME type to a supported data format. +* **Mode**: Choose from: + * **Load All Input Data**: Use all the node's input data. + * **Load Specific Data**: Use [expressions](/code/expressions.md) to define the data you want to load. You can add text as well as expressions. This means you can create a custom document from a mix of text and expressions. + +## Node options + +* **Metadata**: Set the metadata that should accompany the document in the vector store. This is what you match to using the **Metadata Filter** option when retrieving data using the vector store nodes. + +## Templates and examples + + +[[ templatesWidget(page.title, 'default-data-loader') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-doc-loaders-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.documentgithubloader.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: GitHub Document Loader node documentation +description: Learn how to use the GitHub Document Loader node in n8n. Follow technical documentation to integrate GitHub Document Loader node into your workflows. +contentType: [integration, reference] +--- + +# GitHub Document Loader node + +Use the GitHub Document Loader node to load data from a GitHub repository for [vector stores](/glossary.md#ai-vector-store) or summarization. + +On this page, you'll find the node parameters for the GitHub Document Loader node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/github.md). This node doesn't support OAuth for authentication. +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Repository Link**: Enter the URL of your GitHub repository. +* **Branch**: Enter the branch name to use. + +## Node options + +* **Recursive**: Select whether to include sub-folders and files (turned on) or not (turned off). +* **Ignore Paths**: Enter directories to ignore. + +## Templates and examples + + +[[ templatesWidget(page.title, 'github-document-loader') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-doc-loaders-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsawsbedrock.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings AWS Bedrock node documentation +description: Learn how to use the Embeddings AWS Bedrock node in n8n. Follow technical documentation to integrate Embeddings AWS Bedrock node into your workflows. +contentType: [integration, reference] +--- + +# Embeddings AWS Bedrock node + +Use the Embeddings AWS Bedrock node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings AWS Bedrock node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/aws.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. + +Learn more about available models in the [Amazon Bedrock documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-bedrock.html){:target=_blank .external-link}. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-aws-bedrock') ]] + +## Related resources + +Refer to [LangChains's AWS Bedrock embeddings documentation](https://js.langchain.com/docs/integrations/platforms/aws/#text-embedding-models){:target=_blank .external-link} and the [AWS Bedrock documentation](https://docs.aws.amazon.com/bedrock/){:target=_blank .external-link} for more information about AWS Bedrock. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsazureopenai.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Azure OpenAI node documentation +description: Learn how to use the Embeddings Azure OpenAI node in n8n. Follow technical documentation to integrate Embeddings Azure OpenAI node into your workflows. +contentType: [integration, reference] +--- + +# Embeddings Azure OpenAI node + +Use the Embeddings Azure OpenAI node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Azure OpenAI node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/azureopenai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + + +## Node options + +* **Model (Deployment) Name**: Select the model (deployment) to use for generating embeddings. +* **Batch Size**: Enter the maximum number of documents to send in each request. +* **Strip New Lines**: Select whether to remove new line characters from input text (turned on) or not (turned off). n8n enables this by default. +* **Timeout**: Enter the maximum amount of time a request can take in seconds. Set to `-1` for no timeout. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-azure-openai') ]] + +## Related resources + +Refer to [LangChains's OpenAI embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/azure_openai/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingscohere.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Cohere node documentation +description: Learn how to use the Embeddings Cohere node in n8n. Follow technical documentation to integrate Embeddings Cohere node into your workflows. +contentType: [integration, reference] +--- + +# Embeddings Cohere node + +Use the Embeddings Cohere node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Cohere node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/cohere.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. Choose from: + * **Embed-English-v2.0(4096 Dimensions)** + * **Embed-English-Light-v2.0(1024 Dimensions)** + * **Embed-Multilingual-v2.0(768 Dimensions)** + +Learn more about available models in [Cohere's models documentation](https://docs.cohere.com/docs/models){:target=_blank .external-link}. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-cohere') ]] + +## Related resources + +Refer to [Langchain's Cohere embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/cohere/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsgooglegemini.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Google Gemini node documentation +description: Learn how to use the Embeddings Google Gemini node in n8n. Follow technical documentation to integrate Embeddings Google Gemini node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Embeddings Google Gemini node + +Use the Embeddings Google Gemini node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Google Gemini node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/googleai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. + +Learn more about available models in [Google Gemini's models documentation](https://ai.google.dev/models/gemini){:target=_blank .external-link}. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-google-gemini') ]] + +## Related resources + +Refer to [Langchain's Google Generative AI embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/google_generativeai){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsgooglepalm.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Google PaLM node documentation +description: Learn how to use the Embeddings Google PaLM node in n8n. Follow technical documentation to integrate Embeddings Google PaLM node into your workflows. +contentType: [integration, reference] +--- + +# Embeddings Google PaLM node + +Use the Embeddings Google PaLM node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Google PaLM node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/googleai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. + +n8n dynamically loads models from the Google PaLM API and you'll only see the models available to your account. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-google-palm') ]] + +## Related resources + +Refer to [Langchain's Google PaLM embeddings documentation](https://js.langchain.com/v0.2/docs/integrations/text_embedding/google_palm/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsgooglevertex.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Google Vertex node documentation +description: Learn how to use the Embeddings Google Vertex node in n8n. Follow technical documentation to integrate Embeddings Google Gemini node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Embeddings Google Vertex node + +Use the Embeddings Google Vertex node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Google Vertex node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/google/service-account.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +- **Model**: Select the model to use to generate the embedding. + +Learn more about available embedding models in [Google VertexAI embeddings API documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/text-embeddings-api). + +## Templates and examples + + + +[[templatesWidget(page.title, 'embeddings-google-vertex')]] + +## Related resources + +Refer to [LangChain's Google Generative AI embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/google_generativeai) for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingshuggingfaceinference.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings HuggingFace Inference node documentation +description: Learn how to use the Embeddings HuggingFace Inference node in n8n. Follow technical documentation to integrate Embeddings HuggingFace Inference node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Embeddings HuggingFace Inference node + +Use the Embeddings HuggingFace Inference node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings HuggingFace Inference, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/huggingface.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. + +Refer to the [Hugging Face models documentation](https://huggingface.co/models?other=embeddings){:target=_blank .external-link} for available models. + +## Node options + +* **Custom Inference Endpoint**: Enter the URL of your deployed model, hosted by HuggingFace. If you set this, n8n ignores the **Model Name**. + +Refer to [HuggingFace's guide to inference](https://huggingface.co/inference-endpoints){:target=_blank .external-link} for more information. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-hugging-face-inference') ]] + +## Related resources + +Refer to [Langchain's HuggingFace Inference embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/hugging_face_inference/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsmistralcloud.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Mistral Cloud node documentation +description: Learn how to use the Embeddings Mistral Cloud node in n8n. Follow technical documentation to integrate Embeddings Mistral Cloud node into your workflows. +contentType: [integration, reference] +--- + +# Embeddings Mistral Cloud node + +Use the Embeddings Mistral Cloud node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Mistral Cloud node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/mistral.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. + +Learn more about available models in [Mistral's models documentation](https://docs.mistral.ai/platform/pricing/){:target=_blank .external-link}. + +## Node options + +* **Batch Size**: Enter the maximum number of documents to send in each request. +* **Strip New Lines**: Select whether to remove new line characters from input text (turned on) or not (turned off). n8n enables this by default. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-mistral-cloud') ]] + +## Related resources + +Refer to [Langchain's Mistral embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/mistralai){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsollama.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings Ollama node documentation +description: Learn how to use the Embeddings Ollama node in n8n. Follow technical documentation to integrate Embeddings Ollama node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Embeddings Ollama node + +Use the Embeddings Ollama node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings Ollama node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/ollama.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the embedding. Choose from: + * [all-minilm](https://ollama.com/library/all-minilm) (384 Dimensions) + * [nomic-embed-text](https://ollama.com/library/nomic-embed-text) (768 Dimensions) + +Learn more about available models in [Ollama's models documentation](https://ollama.ai/library){:target=_blank .external-link}. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-ollama') ]] + +## Related resources + +Refer to [Langchain's Ollama embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/ollama/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.embeddingsopenai.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Embeddings OpenAI node documentation +description: Learn how to use the Embeddings OpenAI node in n8n. Follow technical documentation to integrate Embeddings OpenAI node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Embeddings OpenAI node + +Use the Embeddings OpenAI node to generate [embeddings](/glossary.md#ai-embedding) for a given text. + +On this page, you'll find the node parameters for the Embeddings OpenAI node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/openai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + + +## Node options + +* **Model**: Select the model to use for generating embeddings. +* **Base URL**: Enter the URL to send the request to. Use this if you are using a self-hosted OpenAI-like model. +* **Batch Size**: Enter the maximum number of documents to send in each request. +* **Strip New Lines**: Select whether to remove new line characters from input text (turned on) or not (turned off). n8n enables this by default. +* **Timeout**: Enter the maximum amount of time a request can take in seconds. Set to `-1` for no timeout. + +## Templates and examples + + +[[ templatesWidget(page.title, 'embeddings-openai') ]] + +## Related resources + +Refer to [LangChains's OpenAI embeddings documentation](https://js.langchain.com/docs/integrations/text_embedding/openai/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatanthropic.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Anthropic Chat Model node documentation +description: Learn how to use the Anthropic Chat Model node in n8n. Follow technical documentation to integrate Anthropic Chat Model node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Anthropic Chat Model node + +Use the Anthropic Chat Model node to use Anthropic's Claude family of chat models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the Anthropic Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/anthropic.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model that generates the completion. Choose from: + * **Claude** + * **Claude Instant** + +Learn more in the [Anthropic model documentation](https://docs.anthropic.com/claude/reference/selecting-a-model){:target=_blank .external-link}. + +## Node options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Top K**: Enter the number of token choices the model uses to generate the next token. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'anthropic-chat-model') ]] + +## Related resources + +Refer to [LangChains's Anthropic documentation](https://js.langchain.com/docs/integrations/chat/anthropic/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatawsbedrock.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AWS Bedrock Chat Model node documentation +description: Learn how to use the AWS Bedrock Chat Model node in n8n. Follow technical documentation to integrate AWS Bedrock Chat Model node into your workflows. +contentType: [integration, reference] +--- + +# AWS Bedrock Chat Model node + +The AWS Bedrock Chat Model node allows you use LLM models utilising AWS Bedrock platform. + +On this page, you'll find the node parameters for the AWS Bedrock Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/aws.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model that generates the completion. + +Learn more about available models in the [Amazon Bedrock model documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html){:target=_blank .external-link}. + +## Node options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. + +## Templates and examples + + +[[ templatesWidget(page.title, 'aws-bedrock-chat-model') ]] + +## Related resources + +Refer to [LangChains's AWS Bedrock Chat Model documentation](https://js.langchain.com/docs/integrations/chat/bedrock/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatazureopenai.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Azure OpenAI Chat Model node documentation +description: Learn how to use the Azure OpenAI Chat Model node in n8n. Follow technical documentation to integrate Azure OpenAI Chat Model node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Azure OpenAI Chat Model node + +Use the Azure OpenAI Chat Model node to use OpenAI's chat models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the Azure OpenAI Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/azureopenai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the completion. + +## Node options + +* **Frequency Penalty**: Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself. +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Response Format**: Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON. +* **Presence Penalty**: Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Timeout**: Enter the maximum request time in milliseconds. +* **Max Retries**: Enter the maximum number of times to retry a request. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'azure-openai-chat-model') ]] + +## Related resources + +Refer to [LangChains's Azure OpenAI documentation](https://js.langchain.com/docs/integrations/chat/azure){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatdeepseek.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: DeepSeek Chat Model node documentation +description: Learn how to use the DeepSeek Chat Model node in n8n. Follow technical documentation to integrate DeepSeek Chat Model node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# DeepSeek Chat Model node + +Use the DeepSeek Chat Model node to use DeepSeek's chat models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the DeepSeek Chat Model node and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/deepseek.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Model + +Select the model to use to generate the completion. + +n8n dynamically loads models from DeepSeek and you'll only see the models available to your account. + +## Node options + +Use these options to further refine the node's behavior. + +### Base URL + +Enter a URL here to override the default URL for the API. + +### Frequency Penalty + +Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself. + +### Maximum Number of Tokens + +Enter the maximum number of tokens used, which sets the completion length. + +### Response Format + +Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON. + +### Presence Penalty + +Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics. + +### Sampling Temperature + +Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. + +### Timeout + +Enter the maximum request time in milliseconds. + +### Max Retries + +Enter the maximum number of times to retry a request. + +### Top P + +Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'deepseek-chat-model') ]] + +## Related resources + +As DeepSeek is API-compatible with OpenAI, you can refer to [LangChains's OpenAI documentation](https://js.langchain.com/docs/integrations/chat/openai/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatgooglegemini.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Gemini Chat Model node documentation +description: Learn how to use the Google Gemini Chat Model node in n8n. Follow technical documentation to integrate Google Gemini Chat Model node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Google Gemini Chat Model node + +Use the Google Gemini Chat Model node to use Google's Gemini chat models with conversational agents. + +On this page, you'll find the node parameters for the Google Gemini Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/googleai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the completion. + +n8n dynamically loads models from the Google Gemini API and you'll only see the models available to your account. + +## Node options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Top K**: Enter the number of token choices the model uses to generate the next token. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. +* **Safety Settings**: Gemini supports adjustable safety settings. Refer to Google's [Gemini API safety settings](https://ai.google.dev/docs/safety_setting_gemini){:target=_blank .external-link} for information on the available filters and levels. + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-gemini-chat-model') ]] + +## Related resources + +Refer to [LangChain's Google Gemini documentation](https://js.langchain.com/docs/integrations/chat/google_generativeai){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatgooglevertex.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Google Vertex Chat Model node documentation +description: Learn how to use the Google Vertex Chat Model node in n8n. Follow technical documentation to integrate Google Vertex Chat Model node into your workflows. +contentType: [integration, reference] +--- + +# Google Vertex Chat Model node + +Use the Google Vertex AI Chat Model node to use Google's Vertex AI chat models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the Google Vertex AI Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/google/service-account.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Project ID**: Select the project ID from your Google Cloud account to use. n8n dynamically loads projects from the Google Cloud account, but you can also enter it manually. +* **Model Name**: Select the name of the model to use to generate the completion, for example `gemini-1.5-flash-001`, `gemini-1.5-pro-001`, etc. Refer to [Google models](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models){:target=_blank .external-link} for a list of available models. + +## Node options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Top K**: Enter the number of token choices the model uses to generate the next token. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. +* **Safety Settings**: Gemini supports adjustable safety settings. Refer to Google's [Gemini API safety settings](https://ai.google.dev/docs/safety_setting_gemini){:target=_blank .external-link} for information on the available filters and levels. + +## Templates and examples + + +[[ templatesWidget(page.title, 'google-vertex-chat-model') ]] + +## Related resources + + +Refer to [LangChain's Google Vertex AI documentation](https://js.langchain.com/docs/integrations/chat/google_vertex_ai/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatgroq.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Groq Chat Model node documentation +description: Learn how to use the Groq Chat Model node in n8n. Follow technical documentation to integrate Groq Chat Model node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Groq Chat Model node + +Use the Groq Chat Model node to access Groq's large language models for conversational AI and text generation tasks. + +On this page, you'll find the node parameters for the Groq Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/groq.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model which will generate the completion. n8n dynamically loads available models from the Groq API. Learn more in the [Groq model documentation](https://console.groq.com/docs/models){:target=_blank .external-link}. + +## Node options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. + +## Templates and examples + + +[[ templatesWidget(page.title, 'groq-chat-model') ]] + +## Related resources + +Refer to [Groq's API documentation](https://console.groq.com/docs/quickstart){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatmistralcloud.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Mistral Cloud Chat Model node documentation +description: Learn how to use the Mistral Cloud Chat Model node in n8n. Follow technical documentation to integrate Mistral Cloud Chat Model node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Mistral Cloud Chat Model node + +Use the Mistral Cloud Chat Model node to combine Mistral Cloud's chat models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the Mistral Cloud Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/mistral.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the completion. n8n dynamically loads models from Mistral Cloud and you'll only see the models available to your account. + +## Node options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Timeout**: Enter the maximum request time in milliseconds. +* **Max Retries**: Enter the maximum number of times to retry a request. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. +* **Enable Safe Mode**: Enable safe mode by injecting a safety prompt at the beginning of the completion. This helps prevent the model from generating offensive content. +* **Random Seed**: Enter a seed to use for random sampling. If set, different calls will generate deterministic results. + +## Templates and examples + + +[[ templatesWidget(page.title, 'mistral-cloud-chat-model') ]] + +## Related resources + +Refer to [LangChains's Mistral documentation](https://js.langchain.com/docs/integrations/chat/mistral){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatollama/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Ollama Chat Model node common issues +description: Documentation for common issues and questions in the Ollama Chat Model node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Ollama Chat Model node common issues + +Here are some common errors and issues with the [Ollama Chat Model node](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatollama/index.md) and steps to resolve or troubleshoot them. + +## Processing parameters + +The Ollama Chat Model node is a [sub-node](/glossary.md#sub-node-n8n). Sub-nodes behave differently than other nodes when processing multiple items using expressions. + +Most nodes, including [root nodes](/glossary.md#root-node-n8n), take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five name values, the expression `{{ $json.name }}` resolves to each name in turn. + +In sub-nodes, the expression always resolves to the first item. For example, given an input of five name values, the expression `{{ $json.name }}` always resolves to the first name. + +## Can't connect to a remote Ollama instance + +The Ollama Chat Model node is only designed to connect to a locally hosted Ollama instance. It doesn't include the authentication features you'd need to connect to a remotely hosted Ollama instance. + +To use the Ollama Chat Model, follow the [Ollama credentials instructions](/integrations/builtin/credentials/ollama.md) to set up Ollama locally and configure the instance URL in n8n. + +## Can't connect to a local Ollama instance when using Docker + +The Ollama Chat Model node connects to a locally hosted Ollama instance using the base URL defined by [Ollama credentials](/integrations/builtin/credentials/ollama.md). When you run either n8n or Ollama in Docker, you need to configure the network so that n8n can connect to Ollama. + +Ollama typically listens for connections on `localhost`, the local network address. In Docker, by default, each container has its own `localhost` which is only accessible from within the container. If either n8n or Ollama are running in containers, they won't be able to connect over `localhost`. + +The solution depends on how you're hosting the two components. + +### If only Ollama is in Docker + +If only Ollama is running in Docker, configure Ollama to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official images are already configured this way). + +When running the container, [publish the ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/) with the `-p` flag. By default, Ollama runs on port 11434, so your Docker command should look like this: + +```shell +docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama +``` + +When configuring [Ollama credentials](/integrations/builtin/credentials/ollama.md), the `localhost` address should work without a problem (set the **base URL** to `http://localhost:11434`). + +### If only n8n is in Docker + +If only n8n is running in Docker, configure Ollama to listen on all interfaces by binding to `0.0.0.0` on the host. + +If you are running n8n in Docker on **Linux**, use the `--add-host` flag to map `host.docker.internal` to `host-gateway` when you start the container. For example: + +```shell +docker run -it --rm --add-host host.docker.internal:host-gateway --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n +``` + +If you are using Docker Desktop, this is automatically configured for you. + +When configuring [Ollama credentials](/integrations/builtin/credentials/ollama.md), use `host.docker.internal` as the host address instead of `localhost`. For example, to bind to the default port 11434, you could set the base URL to `http://host.docker.internal:11434`. + +### If Ollama and n8n are running in separate Docker containers + +If both n8n and Ollama are running in Docker in separate containers, you can use Docker networking to connect them. + +Configure Ollama to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official images are already configured this way). + +When configuring [Ollama credentials](/integrations/builtin/credentials/ollama.md), use the Ollama container's name as the host address instead of `localhost`. For example, if you call the Ollama container `my-ollama` and it listens on the default port 11434, you would set the base URL to `http://my-ollama:11434`. + +### If Ollama and n8n are running in the same Docker container + +If Ollama and n8n are running in the same Docker container, the `localhost` address doesn't need any special configuration. You can configure Ollama to listen on localhost and configure the base URL in the [Ollama credentials in n8n](/integrations/builtin/credentials/ollama.md) to use localhost: `http://localhost:11434`. + + +## Error: connect ECONNREFUSED ::1:11434 + + +This error occurs when your computer has IPv6 enabled, but Ollama is listening to an IPv4 address. + +To fix this, change the base URL in your [Ollama credentials](/integrations/builtin/credentials/ollama.md) to connect to `127.0.0.1`, the IPv4-specific local address, instead of the `localhost` alias that can resolve to either IPv4 or IPv6: `http://127.0.0.1:11434`. + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatollama/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Ollama Chat Model node documentation +description: Learn how to use the Ollama Chat Model node in n8n. Follow technical documentation to integrate Ollama Chat Model node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Ollama Chat Model node + +The Ollama Chat Model node allows you use local Llama 2 models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the Ollama Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/ollama.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model that generates the completion. Choose from: + * **Llama2** + * **Llama2 13B** + * **Llama2 70B** + * **Llama2 Uncensored** + +Refer to the Ollama [Models Library documentation](https://ollama.com/library){:target=_blank .external-link} for more information about available models. + +## Node options + +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Top K**: Enter the number of token choices the model uses to generate the next token. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'ollama-chat-model') ]] + +## Related resources + +Refer to [LangChains's Ollama Chat Model documentation](https://js.langchain.com/docs/integrations/chat/ollama/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatollama/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + +--8<-- "_snippets/self-hosting/starter-kits/self-hosted-ai-starter-kit.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Chat Model node common issues +description: Documentation for common issues and questions in the OpenAI Chat Model node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# OpenAI Chat Model node common issues + +Here are some common errors and issues with the [OpenAI Chat Model node](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md) and steps to resolve or troubleshoot them. + +## Processing parameters + +The OpenAI Chat Model node is a [sub-node](/glossary.md#sub-node-n8n). Sub-nodes behave differently than other nodes when processing multiple items using expressions. + +Most nodes, including [root nodes](/glossary.md#root-node-n8n), take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five name values, the expression `{{ $json.name }}` resolves to each name in turn. + +In sub-nodes, the expression always resolves to the first item. For example, given an input of five name values, the expression `{{ $json.name }}` always resolves to the first name. + +--8<-- "_snippets/integrations/openai-api-issues.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenAI Chat Model node documentation +description: Learn how to use the OpenAI Chat Model node in n8n. Follow technical documentation to integrate OpenAI Chat Model node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# OpenAI Chat Model node + +Use the OpenAI Chat Model node to use OpenAI's chat models with conversational [agents](/glossary.md#ai-agent). + +On this page, you'll find the node parameters for the OpenAI Chat Model node and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/openai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Model + +Select the model to use to generate the completion. + +n8n dynamically loads models from OpenAI and you'll only see the models available to your account. + +## Node options + +Use these options to further refine the node's behavior. + +### Base URL + +Enter a URL here to override the default URL for the API. + +### Frequency Penalty + +Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself. + +### Maximum Number of Tokens + +Enter the maximum number of tokens used, which sets the completion length. + +### Response Format + +Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON. + +### Presence Penalty + +Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics. + +### Sampling Temperature + +Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. + +### Timeout + +Enter the maximum request time in milliseconds. + +### Max Retries + +Enter the maximum number of times to retry a request. + +### Top P + +Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'openai-chat-model') ]] + +## Related resources + +Refer to [LangChains's OpenAI documentation](https://js.langchain.com/docs/integrations/chat/openai/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenai/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatopenrouter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: OpenRouter Chat Model node documentation +description: Learn how to use the OpenRouter Chat Model node in n8n. Follow technical documentation to integrate OpenRouter Chat Model node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# OpenRouter Chat Model node + +Use the OpenRouter Chat Model node to use OpenRouter's chat models with conversational agents. + +On this page, you'll find the node parameters for the OpenRouter Chat Model node and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/openrouter.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Model + +Select the model to use to generate the completion. + +n8n dynamically loads models from OpenRouter and you'll only see the models available to your account. + +## Node options + +Use these options to further refine the node's behavior. + +### Base URL + +Enter a URL here to override the default URL for the API. + +### Frequency Penalty + +Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself. + +### Maximum Number of Tokens + +Enter the maximum number of tokens used, which sets the completion length. + +### Response Format + +Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON. + +### Presence Penalty + +Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics. + +### Sampling Temperature + +Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. + +### Timeout + +Enter the maximum request time in milliseconds. + +### Max Retries + +Enter the maximum number of times to retry a request. + +### Top P + +Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'openrouter-chat-model') ]] + +## Related resources + +As OpenRouter is API-compatible with OpenAI, you can refer to [LangChains's OpenAI documentation](https://js.langchain.com/docs/integrations/chat/openai/) for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmchatxaigrok.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: xAI Grok Chat Model node documentation +description: Learn how to use the xAI Grok Chat Model node in n8n. Follow technical documentation to integrate xAI Grok Chat Model node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# xAI Grok Chat Model node + +Use the xAI Grok Chat Model node to access xAI Grok's large language models for conversational AI and text generation tasks. + +On this page, you'll find the node parameters for the xAI Grok Chat Model node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/xai.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model which will generate the completion. n8n dynamically loads available models from the xAI Grok API. Learn more in the [xAI Grok model documentation](https://docs.x.ai/docs/models). + +## Node options + +* **Frequency Penalty**: Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself. +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. Most models have a context length of 2048 tokens with the newest models supporting up to 32,768 tokens. +* **Response Format**: Choose **Text** or **JSON**. **JSON** ensures the model returns valid JSON. +* **Presence Penalty**: Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Timeout**: Enter the maximum request time in milliseconds. +* **Max Retries**: Enter the maximum number of times to retry a request. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'xai-grok-chat-model') ]] + +## Related resources + +Refer to [xAI Grok's API documentation](https://docs.x.ai/docs/api-reference) for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmcohere.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Cohere Model node documentation +description: Learn how to use the Cohere Model node in n8n. Follow technical documentation to integrate Cohere Model node into your workflows. +contentType: [integration, reference] +--- + +# Cohere Model node + +Use the Cohere Model node to use Cohere's models. + +On this page, you'll find the node parameters for the Cohere Model node, and links to more resources. + +This node lacks tools support, so it won't work with the [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) node. Instead, connect it with the [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md) node. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/cohere.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node Options + +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. + +## Templates and examples + + +[[ templatesWidget(page.title, 'cohere-model') ]] + +## Related resources + +Refer to [LangChains's Cohere documentation](https://js.langchain.com/docs/integrations/llms/cohere/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmollama/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Ollama Model node common issues +description: Documentation for common issues and questions in the Ollama Model node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Ollama Model node common issues + +Here are some common errors and issues with the [Ollama Model node](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmollama/index.md) and steps to resolve or troubleshoot them. + +## Processing parameters + +The Ollama Model node is a [sub-node](/glossary.md#sub-node-n8n). Sub-nodes behave differently than other nodes when processing multiple items using expressions. + +Most nodes, including [root nodes](/glossary.md#root-node-n8n), take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five name values, the expression `{{ $json.name }}` resolves to each name in turn. + +In sub-nodes, the expression always resolves to the first item. For example, given an input of five name values, the expression `{{ $json.name }}` always resolves to the first name. + +## Can't connect to a remote Ollama instance + +The Ollama Model node is only designed to connect to a locally hosted Ollama instance. It doesn't include the authentication features you'd need to connect to a remotely hosted Ollama instance. + +To use the Ollama Model, follow the [Ollama credentials instructions](/integrations/builtin/credentials/ollama.md) to set up Ollama locally and configure the instance URL in n8n. + +## Can't connect to a local Ollama instance when using Docker + +The Ollama Model node connects to a locally hosted Ollama instance using the base URL defined by [Ollama credentials](/integrations/builtin/credentials/ollama.md). When you run either n8n or Ollama in Docker, you need to configure the network so that n8n can connect to Ollama. + +Ollama typically listens for connections on `localhost`, the local network address. In Docker, by default, each container has its own `localhost` which is only accessible from within the container. If either n8n or Ollama are running in containers, they won't be able to connect over `localhost`. + +The solution depends on how you're hosting the two components. + +### If only Ollama is in Docker + +If only Ollama is running in Docker, configure Ollama to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official images are already configured this way). + +When running the container, [publish the ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/) with the `-p` flag. By default, Ollama runs on port 11434, so your Docker command should look like this: + +```shell +docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama +``` + +When configuring [Ollama credentials](/integrations/builtin/credentials/ollama.md), the `localhost` address should work without a problem (set the **base URL** to `http://localhost:11434`). + +### If only n8n is in Docker + +If only n8n is running in Docker, configure Ollama to listen on all interfaces by binding to `0.0.0.0` on the host. + +If you are running n8n in Docker on **Linux**, use the `--add-host` flag to map `host.docker.internal` to `host-gateway` when you start the container. For example: + +```shell +docker run -it --rm --add-host host.docker.internal:host-gateway --name n8n -p 5678:5678 -v n8n_data:/home/node/.n8n docker.n8n.io/n8nio/n8n +``` + +If you are using Docker Desktop, this is automatically configured for you. + +When configuring [Ollama credentials](/integrations/builtin/credentials/ollama.md), use `host.docker.internal` as the host address instead of `localhost`. For example, to bind to the default port 11434, you could set the base URL to `http://host.docker.internal:11434`. + +### If Ollama and n8n are running in separate Docker containers + +If both n8n and Ollama are running in Docker in separate containers, you can use Docker networking to connect them. + +Configure Ollama to listen on all interfaces by binding to `0.0.0.0` inside of the container (the official images are already configured this way). + +When configuring [Ollama credentials](/integrations/builtin/credentials/ollama.md), use the Ollama container's name as the host address instead of `localhost`. For example, if you call the Ollama container `my-ollama` and it listens on the default port 11434, you would set the base URL to `http://my-ollama:11434`. + +### If Ollama and n8n are running in the same Docker container + +If Ollama and n8n are running in the same Docker container, the `localhost` address doesn't need any special configuration. You can configure Ollama to listen on localhost and configure the base URL in the [Ollama credentials in n8n](/integrations/builtin/credentials/ollama.md) to use localhost: `http://localhost:11434`. + + +## Error: connect ECONNREFUSED ::1:11434 + + +This error occurs when your computer has IPv6 enabled, but Ollama is listening to an IPv4 address. + +To fix this, change the base URL in your [Ollama credentials](/integrations/builtin/credentials/ollama.md) to connect to `127.0.0.1`, the IPv4-specific local address, instead of the `localhost` alias that can resolve to either IPv4 or IPv6: `http://127.0.0.1:11434`. + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmollama/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Ollama Model node documentation +description: Learn how to use the Ollama Model node in n8n. Follow technical documentation to integrate Ollama Model node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Ollama Model node + +The Ollama Model node allows you use local Llama 2 models. + +On this page, you'll find the node parameters for the Ollama Model node, and links to more resources. + +This node lacks tools support, so it won't work with the [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) node. Instead, connect it with the [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md) node. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/ollama.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model that generates the completion. Choose from: + * **Llama2** + * **Llama2 13B** + * **Llama2 70B** + * **Llama2 Uncensored** + +Refer to the Ollama [Models Library documentation](https://ollama.com/library){:target=_blank .external-link} for more information about available models. + +## Node options + +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Top K**: Enter the number of token choices the model uses to generate the next token. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'ollama-model') ]] + +## Related resources + +Refer to [LangChains's Ollama documentation](https://js.langchain.com/docs/integrations/llms/ollama/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmollama/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + +--8<-- "_snippets/self-hosting/starter-kits/self-hosted-ai-starter-kit.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.lmopenhuggingfaceinference.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Hugging Face Inference Model node documentation +description: Learn how to use the Hugging Face Inference Model node in n8n. Follow technical documentation to integrate Hugging Face Inference Model node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Hugging Face Inference Model node + +Use the Hugging Face Inference Model node to use Hugging Face's models. + +On this page, you'll find the node parameters for the Hugging Face Inference Model node, and links to more resources. + +This node lacks tools support, so it won't work with the [AI Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md) node. Instead, connect it with the [Basic LLM Chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md) node. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/huggingface.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Model**: Select the model to use to generate the completion. + +## Node options + +* **Custom Inference Endpoint**: Enter a custom inference endpoint URL. +* **Frequency Penalty**: Use this option to control the chances of the model repeating itself. Higher values reduce the chance of the model repeating itself. +* **Maximum Number of Tokens**: Enter the maximum number of tokens used, which sets the completion length. +* **Presence Penalty**: Use this option to control the chances of the model talking about new topics. Higher values increase the chance of the model talking about new topics. +* **Sampling Temperature**: Use this option to control the randomness of the sampling process. A higher temperature creates more diverse sampling, but increases the risk of hallucinations. +* **Top K**: Enter the number of token choices the model uses to generate the next token. +* **Top P**: Use this option to set the probability the completion should use. Use a lower value to ignore less probable options. + +## Templates and examples + + +[[ templatesWidget(page.title, 'hugging-face-inference-model') ]] + +## Related resources + +Refer to [LangChains's Hugging Face Inference Model documentation](https://js.langchain.com/docs/integrations/llms/huggingface_inference/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Simple Memory node common issues +description: Documentation for common issues and questions in the Simple Memory node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Simple Memory node common issues + +Here are some common errors and issues with the [Simple Memory node](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md) and steps to resolve or troubleshoot them. + +## Single memory instance + +If you add more than one Simple Memory node to your workflow, all nodes access the same memory instance by default. Be careful when doing destructive actions that override existing memory contents, such as the override all messages operation in the [Chat Memory Manager](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymanager.md) node. If you want more than one memory instance in your workflow, set different session IDs in different memory nodes. + +## Managing the Session ID + +In most cases, the `sessionId` is automatically retrieved from the **On Chat Message** trigger. But you may run into an error with the phrase `No sessionId`. + +If you have this error, first check the output of your Chat trigger to ensure it includes a `sessionId`. + +If you're not using the **On Chat Message** trigger, you'll need to manage sessions manually. + +For testing purposes, you can use a static key like `my_test_session`. If you use this approach, be sure to set up proper session management before activating the workflow to avoid potential issues in a live environment. + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Simple Memory node documentation +description: Learn how to use the Simple Memory node in n8n. Follow technical documentation to integrate Simple Memory node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Simple Memory node + +Use the Simple Memory node to [persist](/glossary.md#ai-memory) chat history in your workflow. + +On this page, you'll find a list of operations the Simple Memory node supports, and links to more resources. + +/// warning | Don't use this node if running n8n in queue mode +If your n8n instance uses [queue mode](/hosting/scaling/queue-mode.md), this node doesn't work in an active production workflow. This is because n8n can't guarantee that every call to Simple Memory will go to the same worker. +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +Configure these parameters to configure the node: + +* **Session Key**: Enter the key to use to store the memory in the workflow data. +* **Context Window Length**: Enter the number of previous interactions to consider for context. + +## Templates and examples + + +[[ templatesWidget(page.title, 'window-buffer-memory') ]] + +## Related resources + +Refer to [LangChain's Buffer Window Memory documentation](https://v03.api.js.langchain.com/classes/langchain.memory.BufferWindowMemory.html){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorybufferwindow/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymanager.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Chat Memory Manager node documentation +description: Learn how to use the Chat Memory Manager node in n8n. Follow technical documentation to integrate Chat Memory Manager node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Chat Memory Manager node + +The Chat Memory Manager node manages chat message [memories](/glossary.md#ai-memory) within your workflows. Use this node to load, insert, and delete chat messages in an in-memory [vector store](/glossary.md#ai-vector-store). + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/chat-memory-manager-purpose.md" + +On this page, you'll find a list of operations that the Chat Memory Manager node supports, along with links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Operation Mode**: Choose between **Get Many Messages**, **Insert Messages**, and **Delete Messages** operations. +* **Insert Mode**: Available in **Insert Messages** mode. Choose from: + * **Insert Messages**: Insert messages alongside existing messages. + * **Override All Messages**: Replace current memory. +* **Delete Mode**: available in **Delete Messages** mode. Choose from: + * **Last N**: Delete the last N messages. + * **All Messages**: Delete messages from memory. +* **Chat Messages**: available in **Insert Messages** mode. Define the chat messages to insert into the memory, including: + * **Type Name or ID**: Set the message type. Select one of: + * **AI**: Use this for messages from the AI. + * **System**: Add a message containing instructions for the AI. + * **User**: Use this for messages from the user. This message type is sometimes called the 'human' message in other AI tools and guides. + * **Message**: Enter the message contents. + * **Hide Message in Chat**: Select whether n8n should display the message to the user in the chat UI (turned off) or not (turned on). +* **Messages Count**: Available in **Delete Messages** mode when you select **Last N**. Enter the number of latest messages to delete. +* **Simplify Output**: Available in **Get Many Messages** mode. Turn on to simplify the output to include only the sender (AI, user, or system) and the text. + +## Templates and examples + + +[[ templatesWidget(page.title, 'chat-memory-manager') ]] + +## Related resources + +Refer to [LangChain's Memory documentation](https://langchain-ai.github.io/langgraphjs/concepts/memory/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymongochat.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MongoDB Chat Memory node documentation +description: Learn how to use the MongoDB Chat Memory node in n8n. Follow technical documentation to integrate MongoDB Chat Memory node into your workflows. +contentType: [integration, reference] +--- + +# MongoDB Chat Memory node + +Use the MongoDB Chat Memory node to use MongoDB as a [memory](/glossary.md#ai-memory) server for storing chat history. + +On this page, you'll find a list of operations the MongoDB Chat Memory node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/mongodb.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Session Key**: Enter the key to use to store the memory in the workflow data. +* **Collection Name**: Enter the name of the collection to store the chat history in. The system will create the collection if it doesn't exist. +* **Database Name**: Enter the name of the database to store the chat history in. If not provided, the database from credentials will be used. +* **Context Window Length**: Enter the number of previous interactions to consider for context. + +## Related resources + +Refer to [LangChain's MongoDB Chat Message History documentation](https://js.langchain.com/docs/integrations/memory/mongodb){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Single memory instance + +[[% include "_includes/integrations/cluster-nodes/memory-shared.html" %]] + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorymotorhead.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Motorhead node documentation +description: Learn how to use the Motorhead node in n8n. Follow technical documentation to integrate Motorhead node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Motorhead node + +Use the Motorhead node to use Motorhead as a [memory](/glossary.md#ai-memory) server. + +On this page, you'll find a list of operations the Motorhead node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/motorhead.md). +/// + +## Node parameters + +* **Session ID**: Enter the ID to use to store the memory in the workflow data. + +## Node reference + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'motorhead') ]] + +## Related resources + +Refer to [LangChain's Motorhead documentation](https://js.langchain.com/docs/integrations/memory/motorhead_memory){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Single memory instance + +[[% include "_includes/integrations/cluster-nodes/memory-shared.html" %]] + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memorypostgreschat.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Postgres Chat Memory node documentation +description: Learn how to use the Postgres Chat Memory node in n8n. Follow technical documentation to integrate Postgres Chat Memory node into your workflows. +contentType: [integration, reference] +--- + +# Postgres Chat Memory node + +Use the Postgres Chat Memory node to use Postgres as a [memory](/glossary.md#ai-memory) server for storing chat history. + +On this page, you'll find a list of operations the Postgres Chat Memory node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/postgres.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Session Key**: Enter the key to use to store the memory in the workflow data. +* **Table Name**: Enter the name of the table to store the chat history in. The system will create the table if doesn't exist. +* **Context Window Length**: Enter the number of previous interactions to consider for context. + +## Related resources + +Refer to [LangChain's Postgres Chat Message History documentation](https://js.langchain.com/docs/integrations/memory/postgres){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Single memory instance + +[[% include "_includes/integrations/cluster-nodes/memory-shared.html" %]] + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryredischat.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Redis Chat Memory node documentation +description: Learn how to use the Redis Chat Memory node in n8n. Follow technical documentation to integrate Redis Chat Memory node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Redis Chat Memory node + +Use the Redis Chat Memory node to use Redis as a [memory](/glossary.md#ai-memory) server. + +On this page, you'll find a list of operations the Redis Chat Memory node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/redis.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Session Key**: Enter the key to use to store the memory in the workflow data. +* **Session Time To Live**: Use this parameter to make the session expire after a given number of seconds. +* **Context Window Length**: Enter the number of previous interactions to consider for context. + +## Templates and examples + + +[[ templatesWidget(page.title, 'redis-chat-memory') ]] + +## Related resources + +Refer to [LangChain's Redis Chat Memory documentation](https://js.langchain.com/docs/integrations/memory/redis){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Single memory instance + +[[% include "_includes/integrations/cluster-nodes/memory-shared.html" %]] + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryxata.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Xata node documentation +description: Learn how to use the Xata node in n8n. Follow technical documentation to integrate Xata node into your workflows. +contentType: [integration, reference] +--- + +# Xata node + +Use the Xata node to use Xata as a [memory](/glossary.md#ai-memory) server. +On this page, you'll find a list of operations the Xata node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/xata.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +- **Session ID**: Enter the ID to use to store the memory in the workflow data. +- **Context Window Length**: Enter the number of previous interactions to consider for context. + +## Templates and examples + + +[[ templatesWidget(page.title, 'xata') ]] + +## Related resources + +Refer to [LangChain's Xata documentation](https://js.langchain.com/docs/integrations/memory/xata){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Single memory instance + +[[% include "_includes/integrations/cluster-nodes/memory-shared.html" %]] + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryzep.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Zep node documentation +description: Learn how to use the Zep node in n8n. Follow technical documentation to integrate Zep node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Zep node + +Use the Zep node to use Zep as a [memory](/glossary.md#ai-memory) server. + +On this page, you'll find a list of operations the Zep node supports, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/zep.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Session ID**: Enter the ID to use to store the memory in the workflow data. + +## Templates and examples + + +[[ templatesWidget(page.title, 'zep') ]] + +## Related resources + +Refer to [LangChain's Zep documentation](https://js.langchain.com/docs/integrations/memory/zep_memory){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Single memory instance + +[[% include "_includes/integrations/cluster-nodes/memory-shared.html" %]] + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserautofixing.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Auto-fixing Output Parser node documentation +description: Learn how to use the Auto-fixing Output Parser node in n8n. Follow technical documentation to integrate Auto-fixing Output Parser node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Auto-fixing Output Parser node + +The Auto-fixing Output Parser node wraps another output parser. If the first one fails, it calls out to another LLM to fix any errors. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'auto-fixing-output-parser') ]] + +## Related resources + +Refer to [LangChain's output parser documentation](https://js.langchain.com/docs/concepts/output_parsers/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparseritemlist.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Item List Output Parser node documentation +description: Learn how to use the Item List Output Parser node in n8n. Follow technical documentation to integrate Item List Output Parser node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Item List Output Parser node + +Use the Item List Output Parser node to return a list of items with a specific length and separator. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node options + +* **Number of Items**: Enter the maximum items to return. Set to `-1` for unlimited items. +* **Separator**: Select the separator used to split the results into separate items. Defaults to a new line. + +## Templates and examples + + +[[ templatesWidget(page.title, 'item-list-output-parser') ]] + +## Related resources + +Refer to [LangChain's output parser documentation](https://js.langchain.com/docs/concepts/output_parsers){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Structured Output Parser node common issues +description: Documentation for common issues and questions in the Structured Output Parser node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Structured Output Parser node common issues + +Here are some common errors and issues with the [Structured Output Parser node](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/index.md) and steps to resolve or troubleshoot them. + +## Processing parameters + +The Structured Output Parser node is a [sub-node](/glossary.md#sub-node-n8n). Sub-nodes behave differently than other nodes when processing multiple items using expressions. + +Most nodes, including [root nodes](/glossary.md#root-node-n8n), take any number of items as input, process these items, and output the results. You can use expressions to refer to input items, and the node resolves the expression for each item in turn. For example, given an input of five name values, the expression `{{ $json.name }}` resolves to each name in turn. + +In sub-nodes, the expression always resolves to the first item. For example, given an input of five name values, the expression `{{ $json.name }}` always resolves to the first name. + +## Adding the structured output parser node to AI nodes + +You can attach output parser nodes to select [AI root nodes](/integrations/builtin/cluster-nodes/root-nodes/index.md). + +To add the Structured Output Parser to a node, enable the **Require Specific Output Format** option in the AI root node you wish to format. Once the option is enabled, a new **output parser** attachment point is displayed. Click the **output parser** attachment point to add the Structured Output Parser node to the node. + +## Using the structured output parser to format intermediary steps + +The Structured Output Parser node structures the final output from AI agents. It's not intended to structure intermediary output to pass to other AI tools or stages. + +To request a specific format for intermediary output, include the response structure in the **System Message** for the **AI Agent**. The message can include either a schema or example response for the agent to use as a template for its results. + +## Structuring output from agents + +Structured output parsing is often not reliable when working with [agents](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent/index.md). + +If your workflow uses agents, n8n recommends using a separate [LLM-chain](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.chainllm.md) to receive the data from the agent and parse it. This leads to better, more consistent results than parsing directly in the agent workflow. + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Structured Output Parser node documentation +description: Learn how to use the Structured Output Parser node in n8n. Follow technical documentation to integrate Structured Output Parser node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Structured Output Parser node + +Use the Structured Output Parser node to return fields based on a JSON Schema. + +On this page, you'll find the node parameters for the Structured Output Parser node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Schema Type**: Define the output structure and validation. You have two options to provide the schema: + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/schema-type-structuring.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'structured-output-parser') ]] + +## Related resources + +Refer to [LangChain's output parser documentation](https://js.langchain.com/docs/concepts/output_parsers){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common issues](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/common-issues.md). + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievercontextualcompression.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Contextual Compression Retriever node documentation +description: Learn how to use the Contextual Compression Retriever node in n8n. Follow technical documentation to integrate Contextual Compression Retriever node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Contextual Compression Retriever node + +The Contextual Compression Retriever node improves the answers returned from [vector store](/glossary.md#ai-vector-store) document similarity searches by taking into account the context from the query. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'contextual-compression-retriever') ]] + +## Related resources + +Refer to [LangChain's contextual compression retriever documentation](https://js.langchain.com/docs/how_to/contextual_compression/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievermultiquery.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MultiQuery Retriever node documentation +description: Learn how to use the MultiQuery Retriever node in n8n. Follow technical documentation to integrate MultiQuery Retriever node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# MultiQuery Retriever node + +The MultiQuery Retriever node automates the process of prompt tuning by using an LLM to generate multiple queries from different perspectives for a given user input query. + +On this page, you'll find the node parameters for the MultiQuery Retriever node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node options + +* **Query Count**: Enter how many different versions of the query to generate. + +## Templates and examples + + +[[ templatesWidget(page.title, 'multiquery-retriever') ]] + +## Related resources + +Refer to [LangChain's retriever conceptual documentation](https://js.langchain.com/docs/concepts/retrievers){:target=_blank .external-link} and [LangChain's multiquery retriever API documentation](https://v03.api.js.langchain.com/classes/langchain.retrievers_multi_query.MultiQueryRetriever.html){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrievervectorstore.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Vector Store Retriever node documentation +description: Learn how to use the Vector Store Retriever node in n8n. Follow technical documentation to integrate Vector Store Retriever node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Vector Store Retriever node + +Use the Vector Store Retriever node to retrieve documents from a [vector store](/glossary.md#ai-vector-store). + +On this page, you'll find the node parameters for the Vector Store Retriever node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Limit**: Enter the maximum number of results to return. + +## Templates and examples + + +[[ templatesWidget(page.title, 'vector-store-retriever') ]] + +## Related resources + +Refer to [LangChain's vector store retriever documentation](https://js.langchain.com/docs/how_to/vectorstore_retriever/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.retrieverworkflow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Workflow Retriever node documentation +description: Learn how to use the Workflow Retriever node in n8n. Follow technical documentation to integrate Workflow Retriever node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Workflow Retriever node + +Use the Workflow Retriever node to retrieve data from an n8n workflow for use in a Retrieval QA Chain or another Retriever node. + +On this page, you'll find the node parameters for the Workflow Retriever node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Source + +Tell n8n which workflow to call. You can choose either: + +* **Database** and enter a workflow ID. +* **Parameter** and copy in a complete [workflow JSON](/workflows/export-import.md). + +### Workflow values + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-sub-nodes/workflow-values.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'workflow-retriever') ]] + +## Related resources + +Refer to [LangChain's general retriever documentation](https://js.langchain.com/docs/concepts/retrievers/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.textsplittercharactertextsplitter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Character Text Splitter node documentation +description: Learn how to use the Character Text Splitter node in n8n. Follow technical documentation to integrate Character Text Splitter node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Character Text Splitter node + +Use the Character Text Splitter node to split document data based on characters. + +On this page, you'll find the node parameters for the Character Text Splitter node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Separator**: Select the separator used to split the document into separate items. +* **Chunk Size**: Enter the number of characters in each chunk. +* **Chunk Overlap**: Enter how much overlap to have between chunks. + +## Templates and examples + + +[[ templatesWidget(page.title, 'character-text-splitter') ]] + +## Related resources + +Refer to [LangChain's text splitter documentation](https://js.langchain.com/docs/concepts/text_splitters){:target=_blank .external-link} and [LangChain's API documentation for character text splitting](https://v03.api.js.langchain.com/classes/langchain.text_splitter.CharacterTextSplitter.html){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.textsplitterrecursivecharactertextsplitter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Recursive Character Text Splitter node documentation +description: Learn how to use the Recursive Character Text Splitter node in n8n. Follow technical documentation to integrate Recursive Character Text Splitter node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Recursive Character Text Splitter node + +The Recursive Character Text Splitter node splits document data recursively to keep all paragraphs, sentences then words together as long as possible. + +On this page, you'll find the node parameters for the Recursive Character Text Splitter node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Chunk Size**: Enter the number of characters in each chunk. +* **Chunk Overlap**: Enter how much overlap to have between chunks. + +## Templates and examples + + +[[ templatesWidget(page.title, 'recursive-character-text-splitter') ]] + +## Related resources + +Refer to [LangChain's text splitter documentation](https://js.langchain.com/docs/concepts/text_splitters){:target=_blank .external-link} and [LangChain's recursively split by character documentation](https://v03.api.js.langchain.com/classes/langchain.text_splitter.RecursiveCharacterTextSplitter.html){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.textsplittertokensplitter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Token Splitter node documentation +description: Learn how to use the Token Splitter node in n8n. Follow technical documentation to integrate Token Splitter node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Token Splitter node + +The Token Splitter node splits a raw text string by first converting the text into BPE tokens, then splits these tokens into chunks and converts the tokens within a single chunk back into text. + +On this page, you'll find the node parameters for the Token Splitter node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +* **Chunk Size**: Enter the number of characters in each chunk. +* **Chunk Overlap**: Enter how much overlap to have between chunks. + +## Templates and examples + + +[[ templatesWidget(page.title, 'token-splitter') ]] + +## Related resources + +Refer to [LangChain's token documentation](https://js.langchain.com/docs/concepts/tokens/){:target=_blank .external-link} and [LangChain's text splitter documentation](https://js.langchain.com/docs/concepts/text_splitters/){:target=_blank .external-link} for more information about the service. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcalculator.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Calculator node documentation +description: Learn how to use the Calculator node in n8n. Follow technical documentation to integrate Calculator node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Calculator node + +The Calculator node is a [tool](/glossary.md#ai-tool) that allows an [agent](/glossary.md#ai-agent) to run mathematical calculations. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'calculator') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Custom Code Tool node documentation +description: Learn how to use the Custom Code Tool node in n8n. Follow technical documentation to integrate Custom Code Tool node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Custom Code Tool node + +Use the Custom Code Tool node to write code that an [agent](/glossary.md#ai-agent) can run. + +On this page, you'll find the node parameters for the Custom Code Tool node and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Description + +Give your custom code a description. This tells the agent when to use this tool. For example: + +> Call this tool to get a random color. The input should be a string with comma separated names of colors to exclude. + +### Language + +You can use JavaScript or Python. + +### JavaScript / Python box + +Write the code here. + +You can access the tool input using `query`. For example, to take the input string and lowercase it: + +```js +let myString = query; +return myString.toLowerCase(); +``` + +## Templates and examples + + +[[ templatesWidget(page.title, 'code-tool') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolhttprequest.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: HTTP Request Tool node documentation +description: Learn how to use the HTTP Request Tool node in n8n. Follow technical documentation to integrate HTTP Request Tool node into your workflows. +search: + exclude: true +contentType: [integration, reference] +--- + +# HTTP Request Tool node + +/// warning | Legacy tool version +New instances of the HTTP Request tool node that you add to workflows use the standard [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node as a tool. This page is describes the legacy, standalone HTTP Request tool node. + +You can identify which tool version is in your workflow by checking if the node has an **Add option** property when you open the node on the canvas. If that button is present, you're using the new version, not the one described on this page. +/// + +The HTTP Request tool works just like the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node, but it's designed to be used with an [AI agent](/glossary.md#ai-agent) as a tool to collect information from a website or API. + +On this page, you'll find a list of operations the HTTP Request node supports and links to more resources. + +/// note | Credentials +Refer to [HTTP Request credentials](/integrations/builtin/credentials/httprequest.md) for guidance on setting up authentication. +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'http-request-tool') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolmcp.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: MCP Client Tool node documentation +description: Learn how to use the MCP Client Tool node in n8n. Follow technical documentation to integrate MCP Client Tool node into your workflows. +contentType: [integration, reference] +--- + +# MCP Client Tool node + +The MCP Client Tool node is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) client, allowing you to use the tools exposed by an external MCP server. You can connect the MCP Client Tool node to your models to call external tools with n8n agents. + +/// note | Credentials +The MCP Client Tool node supports both [Bearer](/integrations/builtin/credentials/httprequest.md#using-bearer-auth) and generic [header](/integrations/builtin/credentials/httprequest.md#using-header-auth) authentication methods. +/// + +## Node parameters + +Configure the node with the following parameters. + +* **SSE Endpoint**: The SSE endpoint for the MCP server you want to connect to. +* **Authentication**: The authentication method for authentication to your MCP server. The MCP tool supports [bearer](/integrations/builtin/credentials/httprequest.md#using-bearer-auth) and generic [header](/integrations/builtin/credentials/httprequest.md#using-header-auth) authentication. Select **None** to attempt to connect without authentication. +* **Tools to Include**: Choose which tools you want to expose to the AI Agent: + * **All**: Expose all the tools given by the MCP server. + * **Selected**: Activates a **Tools to Include** parameter where you can select the tools you want to expose to the AI Agent. + * **All Except**: Activates a **Tools to Exclude** parameter where you can select the tools you want to avoid sharing with the AI Agent. The AI Agent will have access to all MCP server's tools that aren't selected. + +## Templates and examples + + +[[ templatesWidget(page.title, 'mcp-client-tool') ]] + +## Related resources + +n8n also has an [MCP Server Trigger](/integrations/builtin/core-nodes/n8n-nodes-langchain.mcptrigger.md) node that allows you to expose n8n tools to external AI Agents. + +Refer to the [MCP documentation](https://modelcontextprotocol.io/introduction) and [MCP specification](https://modelcontextprotocol.io/specification/) for more details about the protocol, servers, and clients. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearxng.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SearXNG Tool node documentation +description: Learn how to use the SearXNG Tool node in n8n. Follow technical documentation to integrate SearXNG Tool node into your workflows. +contentType: [integration, reference] +--- + +# SearXNG Tool node + +The SearXNG Tool node allows you to integrate search capabilities into your workflows using SearXNG. SearXNG aggregates results from multiple search engines without tracking you. + +On this page, you'll find the node options for the SearXNG Tool node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/searxng.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node Options + +* **Number of Results**: The number of results to retrieve. The default is 10. +* **Page Number**: The page number of the search results to retrieve. The default is 1. +* **Language**: A two-letter [language code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) to filter search results by language. For example: `en` for English, `fr` for French. The default is `en`. +* **Safe Search**: Enables or disables filtering explicit content in the search results. Can be None, Moderate, or Strict. The default is None. + +## Running a SearXNG instance + +This node requires running the SearXNG service on the same network as your n8n instance. Ensure your n8n instance has network access to the SearXNG service. + +This node requires results in JSON format, which isn't enabled in the default SearXNG configuration. To enable JSON output, add `json` to the `search.formats` section of your SearXNG instance's `settings.yml` file: + +```yaml +search: + # options available for formats: [html, csv, json, rss] + formats: + - html + - json +``` + +If the `formats` section isn't there, add it. The exact location of the `settings.yml` file depends on how you installed SearXNG. You can find more by visiting the [SearXNG configuration documentation](https://docs.searxng.org/admin/installation-searxng.html#configuration). + +The quality and availability of search results depend on the configuration and health of the SearXNG instance you use. + +## Templates and examples + + +[[ templatesWidget(page.title, 'searxng') ]] + +## Related resources + +Refer to [SearXNG's documentation](https://docs.searxng.org/) for more information about the service. You can also view [LangChain's documentation on their SearXNG integration](https://python.langchain.com/docs/integrations/tools/searx_search/). + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolserpapi.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: SerpApi (Google Search) node documentation +description: Learn how to use the SerpApi (Google Search) node in n8n. Follow technical documentation to integrate SerpApi (Google Search) node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# SerpApi (Google Search) node + +The SerpAPI node allows an [agent](/glossary.md#ai-agent) in your workflow to call Google's Search API. + +On this page, you'll find the node parameters for the SerpAPI node, and links to more resources. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/serp.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node options + +* **Country**: Enter the country code you'd like to use. Refer to [Google GL Parameter: Supported Google Countries](https://serpapi.com/google-countries){:target=_blank .external-link} for supported countries and country codes. +* **Device**: Select the device to use to get the search results. +* **Explicit Array**: Choose whether to force SerpApi to fetch the Google results even if a cached version is already present (turned on) or not (turned off). +* **Google Domain**: Enter the Google Domain to use. Refer to [Supported Google Domains](https://serpapi.com/google-domains) for supported domains. +* **Language**: Enter the language code you'd like to use. Refer to [Google HL Parameter: Supported Google Languages](https://serpapi.com/google-languages){:target=_blank .external-link} for supported languages and language codes. + +## Templates and examples + + +[[ templatesWidget(page.title, 'serpapi') ]] + +## Related resources + +Refer to [Serp's documentation](https://serpapi.com/search-api){:target=_blank .external-link} for more information about the service. You can also view [LangChain's documentation on their Serp integration](https://js.langchain.com/docs/integrations/tools/serpapi/){:target=_blank .external-link}. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolthink.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Think Tool node documentation +description: Learn how to use the Think Tool node in n8n. Follow technical documentation to integrate the Tool Think node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Think Tool node + +The Think Tool node is a [tool](/glossary.md#ai-tool) that invites an [agent](/glossary.md#ai-agent) to do some thinking before answering. Essentially, it allows the agent to reflect on the question by talking to itself before providing an answer. In particular, this is useful for complex queries that require a thoughtful response. + + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'think-tool') ]] + +### Prompting example + +As an example, say you ask the agent: + + +> *Jack is looking at Anne. Anne is looking at George. Jack is married, George is not, and we don't know if Anne is married. Is a married person looking at an unmarried person?* + + +The agent will do its thinking with the tool: + + +> *We have the following information: 1. Jack is looking at Anne. 2. Anne is looking at George. 3. Jack is married. 4. George is not married. 5. We don't know if Anne is married or not.* + +> *We need to determine if a married person is looking at an unmarried person. Let's consider both cases for Anne:* + +> *Case 1: Anne is married.* + +> - *If Anne is married, then she (married) is looking at George (unmarried). In this case, a married person (Anne) is looking at an unmarried person (George).* + +> *Case 2: Anne is unmarried.* + +> - *If Anne is unmarried, then Jack (married) is looking at Anne (unmarried). In this case, a married person (Jack) is looking at an unmarried person (Anne).* + +> *In both scenarios, we find that a married person is looking at an unmarried person. Therefore, the answer to the question is yes.* + + +and then afterward provide the answer: + + +> *Yes, a married person is looking at an unmarried person. In both possible scenarios regarding Anne's marital status, we find that a married individual (either Jack or Anne) is looking at an unmarried individual (either George or Anne).* + + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Vector Store Question Answer Tool node documentation +description: Learn how to use the Vector Store Question Answer Tool node in n8n. Follow technical documentation to integrate Vector Store Question Answer Tool node into your workflows. +contentType: [integration, reference] +--- + +# Vector Store Question Answer Tool node + +The Vector Store Question Answer node is a [tool](/glossary.md#ai-tool) that allows an [agent](/glossary.md#ai-agent) to summarize results and answer questions based on chunks from a [vector store](/glossary.md#ai-vector-store). + +On this page, you'll find the node parameters for the Vector Store Question Answer node, and links to more resources. + +/// note | Examples and templates +For usage examples and templates to help you get started, refer to n8n's [Vector Store Question Answer Tool integrations](https://n8n.io/integrations/vector-store-tool/){:target=_blank .external-link} page. +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Description of Data + +Enter a description of the data in the vector store. + +### Limit + +The maximum number of results to return. + +## How n8n populates the tool description + +n8n uses the node name (select the name to edit) and **Description of Data** parameter to populate the tool description for AI agents using the following format: + +> Useful for when you need to answer questions about [node name]. Whenever you need information about [Description of Data], you should ALWAYS use this. Input should be a fully formed question. + +Spaces in the node name are converted to underscores in the tool description. + +/// warning | Avoid special characters in node names +Using special characters in the node name will cause errors when the agent runs: + +![model errors from special characters](/_images/integrations/builtin/cluster-nodes/toolvectorstore/name-characters-error.png) + +Use only alphanumeric characters, spaces, dashes, and underscores in node names. +/// + +## Related resources + +View [example workflows and related content](https://n8n.io/integrations/vector-store-tool/){:target=_blank .external-link} on n8n's website. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwikipedia.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Wikipedia node documentation +description: Learn how to use the Wikipedia node in n8n. Follow technical documentation to integrate Wikipedia node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Wikipedia node + +The Wikipedia node is a [tool](/glossary.md#ai-tool) that allows an [agent](/glossary.md#ai-agent) to search and return information from Wikipedia. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'wikipedia') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolwolframalpha.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Wolfram|Alpha tool node documentation +description: Learn how to use the Wolfram|Alpha tool node in n8n. Follow technical documentation to integrate Wolfram|Alpha tool node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Wolfram|Alpha tool node + +Use the Wolfram|Alpha tool node to connect your [agents](/glossary.md#ai-agent) and [chains](/glossary.md#ai-chain) to Wolfram|Alpha's computational intelligence engine. + +/// note | Credentials +You can find authentication information for this node [here](/integrations/builtin/credentials/wolframalpha.md). +/// + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'wolframoralpha') ]] + +## Related resources + +Refer to [Wolfram|Alpha's documentation](https://products.wolframalpha.com/api){:target=_blank .external-link} for more information about the service. You can also view [LangChain's documentation on their WolframAlpha Tool](https://js.langchain.com/docs/integrations/tools/wolframalpha/){:target=_blank .external-link}. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Call n8n Workflow Tool node documentation +description: Learn how to use the Call n8n Workflow Tool node in n8n. Follow technical documentation to integrate Call n8n Workflow Tool node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Call n8n Workflow Tool node + +The Call n8n Workflow Tool node is a [tool](/glossary.md#ai-tool) that allows an [agent](/glossary.md#ai-agent) to run another n8n workflow and fetch its output data. + +On this page, you'll find the node parameters for the Call n8n Workflow Tool node, and links to more resources. + +--8<-- "_snippets/integrations/builtin/cluster-nodes/sub-node-expression-resolution.md" + +## Node parameters + +### Description + +Enter a custom code a description. This tells the agent when to use this tool. For example: + +> Call this tool to get a random color. The input should be a string with comma separated names of colors to exclude. + +### Source + +Tell n8n which workflow to call. You can choose either: + +* **Database** to select the workflow from a list or enter a workflow ID. +* **Define Below** and copy in a complete [workflow JSON](/workflows/export-import.md). + +### Workflow Inputs + +When using **Database** as workflow source, once you choose a sub-workflow (and define the **Workflow Input Schema** in the sub-workflow), you can define the **Workflow Inputs**. + +Select the **Refresh** button to pull in the input fields from the sub-workflow. + +You can define the workflow input values using any combination of the following options: + +* providing fixed values +* using expressions to reference data from the current workflow +* [letting the AI model specify the parameter](/advanced-ai/examples/using-the-fromai-function.md) by selecting the button AI button on the right side of the field +* using the [`$fromAI()` function](/advanced-ai/examples/using-the-fromai-function.md#use-the-fromai-function) in expressions to control the way the model fills in data and to mix AI generated input with other custom input + +To reference data from the current workflow, drag fields from the input panel to the field with the Expressions mode selected. + +To get started with the `$fromAI()` function, select the "Let the model define this parameter" button on the right side of the field and then use the **X** on the box to revert to user-defined values. The field will change to an expression field pre-populated with the `$fromAI()` expression. From here, you can customize the expression to add other static or dynamic content, or tweak the `$fromAI()` function parameters. + +## Templates and examples + + +[[ templatesWidget(page.title, 'workflow-tool') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/cluster-nodes/tools-link.md" + +--8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" +--8<-- "_glossary/ai-glossary.md" + + +# integrations/builtin/core-nodes/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Core nodes library + +This section provides information about n8n's core [nodes](/glossary.md#node-n8n). + + + + + + +# integrations/builtin/core-nodes/n8n-nodes-base.activationtrigger.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Activation Trigger node documentation +description: Learn how to use the Activation Trigger node in n8n. Follow technical documentation to integrate Activation Trigger node into your workflows. +contentType: [integration, reference] +--- + +# Activation Trigger node + +The Activation Trigger node gets triggered when an event gets fired by n8n or a workflow. + +/// warning +n8n has deprecated the Activation Trigger node and replaced it with two new nodes: the [n8n Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.n8ntrigger.md) and the [Workflow Trigger node](/integrations/builtin/core-nodes/n8n-nodes-base.workflowtrigger.md). For more details, check out the entry in the [breaking changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md#01170) page. +/// + +/// note | Keep in mind +If you want to use the Activation Trigger node for a workflow, add the node to the workflow. You don't have to create a separate workflow. +/// + +The Activation Trigger node gets triggered for the workflow that it gets added to. You can use the Activation Trigger node to trigger a workflow to notify the state of the workflow. + +## Node parameters + +- Events + - **Activation**: Run when the workflow gets activated + - **Start**: Run when n8n starts or restarts + - **Update**: Run when the workflow gets saved while it's active + +## Templates and examples + + +[[ templatesWidget(page.title, 'activation-trigger') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.aggregate.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Aggregate +description: Documentation for the Aggregate node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Aggregate + +Use the Aggregate node to take separate items, or portions of them, and group them together into individual items. + +## Node parameters + +To begin using the node, select the **Aggregate** you'd like to use: + +* [**Individual Fields**](#individual-fields): Aggregate individual fields separately. +* [**All Item Data**](#all-item-data): Aggregate all item data into a single list. + +### Individual Fields + +* **Input Field Name**: Enter the name of the field in the input data to aggregate together. +* **Rename Field**: This toggle controls whether to give the field a different name in the aggregated output data. Turn this on to add a different field name. If you're aggregating multiple fields, you must provide new output field names. You can't leave multiple fields undefined. + * **Output Field Name**: This field is displayed when you turn on **Rename Field**. Enter the field name for the aggregated output data. + +Refer to [Node options](#node-options) for more configuration options. + +### All Item Data + +* **Put Output in Field**: Enter the name of the field to output the data in. +* **Include**: Select which fields to include in the output. Choose from: + * **All fields**: The output includes data from all fields with no further parameters. + * **Specified Fields**: If you select this option, enter a comma-separated list of fields the output should include data from in the **Fields To Include** parameter. The output will include only the fields in this list. + * **All Fields Except**: If you select this option, enter a comma-separated list of fields the output should exclude data from in the **Fields To Exclude** parameter. The output will include all fields not in this list. + +Refer to [Node options](#node-options) for more configuration options. + +## Node options + +You can further configure this node using these **Options**: + +* **Disable Dot Notation**: The node displays this toggle when you select the **Individual Fields** Aggregate. It controls whether to disallow referencing child fields using `parent.child` in the field name (turned on), or allow it (turned off, default). +* **Merge Lists**: The node displays this toggle when you select the **Individual Fields** Aggregate. Turn it on if the field to aggregate is a list and you want to output a single flat list rather than a list of lists. +* **Include Binaries**: The node displays this toggle for both Aggregate types. Turn it on if you want to include binary data from the input in the new output. +* **Keep Missing And Null Values**: The node displays this toggle when you select the **Individual Fields** Aggregate. Turn it on to add a null (empty) entry in the output list when there is a null or missing value in the input. If turned off, the output ignores null or empty values. + +## Templates and examples + + +[[ templatesWidget(page.title, 'aggregate') ]] + +## Related resources + +--8<-- "_snippets/integrations/builtin/core-nodes/data-transformation-actions/data-section-link.md" + + +# integrations/builtin/core-nodes/n8n-nodes-base.aitransform.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: AI Transform +description: Documentation for the AI Transform node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +--- + +# AI Transform + +Use the AI Transform node to generate code snippets based on your prompt. The AI is context-aware, understanding the workflow’s nodes and their data types. + +/// info | Feature availability +Available only on [Cloud plans](/manage-cloud/overview.md). +/// + +## Node parameters + +### Instructions + +Enter your prompt for the AI and click the **Generate code** button to automatically populate the **Transformation Code**. For example, you can specify how you want to process or categorize your data. Refer to [Writing good prompts](/code/ai-code.md#writing-good-prompts) for more information. + +The prompt should be in plain English and under 500 characters. + +### Transformation Code + +The code snippet generated by the node is read-only. To edit this code, adjust your prompt in **Instructions** or copy and paste it into a [Code](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) node. + +## Templates and examples + +[[ templatesWidget(page.title, 'ai-transform') ]] + + + +# integrations/builtin/core-nodes/n8n-nodes-base.code/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Code node common issues +description: Documentation for common issues and questions in the Code node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Code node common issues + +Here are some common errors and issues with the [Code node](/integrations/builtin/core-nodes/n8n-nodes-base.code/index.md) and steps to resolve or troubleshoot them. + + +## Code doesn't return items properly + + +This error occurs when the code in your Code node doesn't return data in the expected format. + +In n8n, all data passed between nodes is an array of objects. Each of these objects wraps another object with the `json` key: + +```javascript +[ + { + "json": { + // your data goes here + } + } +] +``` + +To troubleshoot this error, check the following: + +* Read the [data structure](/data/data-structure.md) to understand the data you receive in the Code node and the requirements for outputting data from the node. +* Understand how data items work and how to connect data items from previous nodes with [item linking](/data/data-mapping/data-item-linking/index.md). + + +## A 'json' property isn't an object + + +This error occurs when the Code node returns data where the `json` key isn't pointing to an object. + +This may happen if you set `json` to a different data structure, like an array: + +```javascript +[ + { + "json": [ + // Setting `json` to an array like this will produce an error + ] + } +] +``` + +To resolve this, ensure that the `json` key references an object in your return data: + +```javascript +[ + { + "json": { + // Setting `json` to an object as expected + } + } +] +``` + +## Code doesn't return an object + +This error may occur when your Code node doesn't return anything or if it returns an unexpected result. + +To resolve this, ensure that your Code node returns the [expected data structure](/data/data-structure.md): + +```javascript +[ + { + "json": { + // your data goes here + } + } +] +``` + +This error may also occur if the code you provided returns `'undefined'` instead of the expected result. In that case, ensure that the data you are referencing in your Code node exists in each execution and that it has the structure your code expects. + +## 'import' and 'export' may only appear at the top level + +This error occurs if you try to use `import` or `export` in the Code node. These aren't supported by n8n's JavaScript sandbox. Instead, use the `require` function to load modules. + +To resolve this issue, try changing your `import` statements to use `require`: + +```javascript +// Original code: +// import express from "express"; +// New code: +const express = require("express"); +``` + + +## Cannot find module '<module>' + + +This error occurs if you try to use `require` in the Code node and n8n can't find the module. + +/// warning | Only for self-hosted +n8n doesn't support importing modules in the [Cloud](/manage-cloud/overview.md) version. +/// + +If you're [self-hosting](/hosting/index.md) n8n, follow these steps: + +* Install the module into your n8n environment. + * If you are running n8n with [npm](/hosting/installation/npm.md), install the module in the same environment as n8n. + * If you are running n8n with [Docker](/hosting/installation/docker.md), you need to extend the official n8n image with a [custom image](https://docs.docker.com/build/building/base-images/){:target=_blank .external-link} that includes your module. +* Set the `NODE_FUNCTION_ALLOW_BUILTIN` and `NODE_FUNCTION_ALLOW_EXTERNAL` [environment variables](/hosting/configuration/configuration-examples/modules-in-code-node.md) to allow importing modules. + +## Using global variables + +Sometimes you may wish to set and retrieve simple global data related to a workflow across and within executions. For example, you may wish to include the date of the previous report when compiling a report with a list of project updates. + +To set, update, and retrieve data directly to a workflow, use the [static data](/code/cookbook/builtin/get-workflow-static-data.md) functions within your code. You can manage data either globally or tied to specific nodes. + +/// info | Use Remove Duplicates when possible +If you're interested in using variables to avoid processing the same data items more than once, consider using the [Remove Duplicates node](/integrations/builtin/core-nodes/n8n-nodes-base.removeduplicates/index.md) instead. The Remove Duplicates node can save information across executions to avoid processing the same items multiple times. +/// + + +# integrations/builtin/core-nodes/n8n-nodes-base.code/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Code node documentation +description: Documentation for the Code node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: critical +tags: + - code node + - code +hide: + - tags +search: + boost: 1.5 +--- + +# Code node + +--8<-- "_snippets/integrations/builtin/core-nodes/code-node.md" + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common Issues](/integrations/builtin/core-nodes/n8n-nodes-base.code/common-issues.md). + + +# integrations/builtin/core-nodes/n8n-nodes-base.code/keyboard-shortcuts.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +title: Code editor keyboard shortcuts +description: A list of the keyboard shortcuts, for multiple platforms, which are supported by the Code node editor. +priority: high +--- + +# Keyboard shortcuts when using the Code editor + +The Code node editing environment supports a range of keyboard shortcuts to speed up and enhance your experience. Select the appropriate tab to see the relevant shortcuts for your operating system. + +## Cursor Movement + +=== "Windows" + + | Action | Shortcut | + |---------------------------|----------------------------------| + | Move cursor left | ++left++ | + | Move cursor right | ++right++ | + | Move cursor up | ++up++ | + | Move cursor down | ++down++ | + | Move cursor by word left | ++control+left++ | + | Move cursor by word right | ++control+right++ | + | Move to line start | ++home++ **or** ++control+left++ | + | Move to line end | ++end++ or ++control+right++ | + | Move to document start | ++control+home++ | + | Move to document end | ++control+end++ | + | Move page up | ++page-up++ | + | Move page down | ++page-down++ | + +=== "macOS" + + | Action | Shortcut | + |---------------------------|----------------------------------------| + | Move cursor left | ++left++ **or** ++control+b++ | + | Move cursor right | ++right++ **or** ++control+f++ | + | Move cursor up | ++up++ **or** ++control+p++ | + | Move cursor down | ++down++ **or** ++control+n++ | + | Move cursor by word left | ++option+left++ | + | Move cursor by word right | ++option+right++ | + | Move to line start | ++command+left++ **or** ++control+a++ | + | Move to line end | ++command+right++ **or** ++control+e++ | + | Move to document start | ++command+up++ | + | Move to document end | ++command+down++ | + | Move page up | ++page-up++ **or** ++option+v++ | + | Move page down | ++page-down++ **or** ++control+v++ | + +=== "Linux" + + | Action | Shortcut | + |---------------------------|----------------------------------| + | Move cursor left | ++left++ | + | Move cursor right | ++right++ | + | Move cursor up | ++up++ | + | Move cursor down | ++down++ | + | Move cursor by word left | ++control+left++ | + | Move cursor by word right | ++control+right++ | + | Move to line start | ++home++ **or** ++control+left++ | + | Move to line end | ++end++ or ++control+right++ | + | Move to document start | ++control+home++ | + | Move to document end | ++control+end++ | + | Move page up | ++page-up++ | + | Move page down | ++page-down++ | + +## Selection + +=== "Windows" + + | Action | Shortcut | + |---------------------------------|-----------------------------| + | Selection with any movement key | ++shift++ + [Movement Key] | + | Select all | ++control+a++ | + | Select line | ++control+l++ | + | Select next occurrence | ++control+d++ | + | Select all occurrences | ++shift+control+l++ | + | Go to matching bracket | ++shift+control+backslash++ | + +=== "macOS" + + | Action | Shortcut | + |---------------------------------|-----------------------------| + | Selection with any movement key | ++shift++ + [Movement Key] | + | Select all | ++command+a++ | + | Select line | ++command+l++ | + | Select next occurrence | ++command+d++ | + | Go to matching bracket | ++shift+command+backslash++ | + +=== "Linux" + + | Action | Shortcut | + |---------------------------------|-----------------------------| + | Selection with any movement key | ++shift++ + [Movement Key] | + | Select all | ++control+a++ | + | Select line | ++control+l++ | + | Select next occurrence | ++control+d++ | + | Select all occurrences | ++shift+control+l++ | + | Go to matching bracket | ++shift+control+backslash++ | + +## Basic Operations + +=== "Windows" + + | Action | Shortcut | + |---------------------------|------------------------------------------| + | New line with indentation | ++enter++ | + | Undo | ++control+z++ | + | Redo | ++control+y++ **or** ++control+shift+z++ | + | Undo selection | ++control+u++ | + | Copy | ++control+c++ | + | Cut | ++control+x++ | + | Paste | ++control+v++ | + +=== "macOS" + + | Action | Shortcut | + |---------------------------|------------------------------------------| + | New line with indentation | ++enter++ | + | Undo | ++command+z++ | + | Redo | ++command+y++ **or** ++command+shift+z++ | + | Undo selection | ++command+u++ | + | Copy | ++command+c++ | + | Cut | ++command+x++ | + | Paste | ++command+v++ | + +=== "Linux" + + | Action | Shortcut | + |---------------------------|------------------------------------------| + | New line with indentation | ++enter++ | + | Undo | ++control+z++ | + | Redo | ++control+y++ **or** ++control+shift+z++ | + | Undo selection | ++control+u++ | + | Copy | ++control+c++ | + | Cut | ++control+x++ | + | Paste | ++control+v++ | + +## Delete Operations + +=== "Windows" + + | Action | Shortcut | + |------------------------|-----------------------| + | Delete character left | ++backspace++ | + | Delete character right | ++delete++ | + | Delete word left | ++control+backspace++ | + | Delete word right | ++control+delete++ | + | Delete line | ++shift+control+k++ | + +=== "macOS" + + | Action | Shortcut | + |------------------------|---------------------------------------------------------| + | Delete character left | ++backspace++ | + | Delete character right | ++delete++ | + | Delete word left | ++option+backspace++ **or** ++control+command+h++ | + | Delete word right | ++option+delete++ **or** ++function+option+backspace++ | + | Delete line | ++shift+command+k++ | + | Delete to line start | ++command+backspace++ | + | Delete to line end | ++command+delete++ **or** ++control+k++ | + +=== "Linux" + + | Action | Shortcut | + |------------------------|-----------------------| + | Delete character left | ++backspace++ | + | Delete character right | ++delete++ | + | Delete word left | ++control+backspace++ | + | Delete word right | ++control+delete++ | + | Delete line | ++shift+control+k++ | + +## Line Operations + +=== "Windows" + + | Action | Shortcut | + |----------------------|--------------------------------------| + | Move line up | ++alt+up++ | + | Move line down | ++alt+down++ | + | Copy line up | ++shift+alt+up++ | + | Copy line down | ++shift+alt+down++ | + | Toggle line comment | ++control+slash++ | + | Add line comment | ++control+k++ **then** ++control+c++ | + | Remove line comment | ++control+k++ **then** ++control+u++ | + | Toggle block comment | ++shift+alt+a++ | + +=== "macOS" + + | Action | Shortcut | + |----------------------|--------------------------------------| + | Move line up | ++option+up++ | + | Move line down | ++option+down++ | + | Copy line up | ++shift+option+up++ | + | Copy line down | ++shift+option+down++ | + | Toggle line comment | ++command+slash++ | + | Add line comment | ++command+k++ **then** ++command+c++ | + | Remove line comment | ++command+k++ **then** ++command+u++ | + | Toggle block comment | ++shift+option+a++ | + | Split line | ++control+o++ | + | Transpose characters | ++control+t++ | + +=== "Linux" + + | Action | Shortcut | + |----------------------|--------------------------------------| + | Move line up | ++alt+up++ | + | Move line down | ++alt+down++ | + | Copy line up | ++shift+alt+up++ | + | Copy line down | ++shift+alt+down++ | + | Toggle line comment | ++control+slash++ | + | Add line comment | ++control+k++ **then** ++control+c++ | + | Remove line comment | ++control+k++ **then** ++control+c++ | + | Toggle block comment | ++shift+alt+a++ | + +## Autocomplete + +=== "Windows" + + | Action | Shortcut | + |-----------------------------|--------------------------| + | Start completion | ++control+space++ | + | Accept completion | ++enter++ **or** ++tab++ | + | Close completion | ++escape++ | + | Navigate completion options | ++up++ **or** ++down++ | + +=== "macOS" + + | Action | Shortcut | + |-----------------------------|--------------------------| + | Start completion | ++control+space++ | + | Accept completion | ++enter++ **or** ++tab++ | + | Close completion | ++escape++ | + | Navigate completion options | ++up++ **or** ++down++ | + +=== "Linux" + + | Action | Shortcut | + |-----------------------------|--------------------------| + | Start completion | ++control+space++ | + | Accept completion | ++enter++ **or** ++tab++ | + | Close completion | ++escape++ | + | Navigate completion options | ++up++ **or** ++down++ | + +## Indentation + +=== "Windows" + + | Action | Shortcut | + |-------------|-----------------------------------------------| + | Indent more | ++tab++ **or** ++control+bracket-right++ | + | Indent less | ++shift+tab++ **or** ++control+bracket-left++ | + +=== "macOS" + + | Action | Shortcut | + |-------------|---------------------------| + | Indent more | ++command+bracket-right++ | + | Indent less | ++command+bracket-left++ | + +=== "Linux" + + | Action | Shortcut | + |-------------|-----------------------------------------------| + | Indent more | ++tab++ **or** ++control+bracket-right++ | + | Indent less | ++shift+tab++ **or** ++control+bracket-left++ | + +## Code Folding + +=== "Windows" + + | Action | Shortcut | + |-------------|--------------------------------------| + | Fold code | ++control+shift+bracket-left++ | + | Unfold code | ++control+shift+bracket-right++ | + | Fold all | ++control+k++ **then** ++control+0++ | + | Unfold all | ++control+k++ **then** ++control+j++ | + +=== "macOS" + + | Action | Shortcut | + |-------------|--------------------------------------| + | Fold code | ++command+option+bracket-left++ | + | Unfold code | ++command+option+bracket-right++ | + | Fold all | ++command+k++ **then** ++command+0++ | + | Unfold all | ++command+k++ **then** ++command+j++ | + +=== "Linux" + + | Action | Shortcut | + |-------------|--------------------------------------| + | Fold code | ++control+shift+bracket-left++ | + | Unfold code | ++control+shift+bracket-right++ | + | Fold all | ++control+k++ **then** ++control+0++ | + | Unfold all | ++control+k++ **then** ++control+j++ | + +## Multi-cursor + +=== "Windows" + + | Action | Shortcut | + |------------------------------|----------------------| + | Add cursor at click position | ++alt+left-button++ | + | Add cursor above | ++control+alt+up++ | + | Add cursor below | ++control+alt+down++ | + | Add cursors to line ends | ++shift+alt+i++ | + | Clear multiple cursors | ++escape++ | + +=== "macOS" + + | Action | Shortcut | + |------------------------------|-------------------------| + | Add cursor at click position | ++option+left-button++ | + | Add cursor above | ++control+option+up++ | + | Add cursor below | ++control+option+down++ | + | Add cursors to line ends | ++shift+option+i++ | + | Clear multiple cursors | ++escape++ | + +=== "Linux" + + | Action | Shortcut | + |------------------------------|---------------------| + | Add cursor at click position | ++alt+left-button++ | + | Add cursor above | ++shift+alt+up++ | + | Add cursor below | ++shift+alt+down++ | + | Add cursors to line ends | ++shift+alt+i++ | + | Clear multiple cursors | ++escape++ | + +## Formatting + +=== "Windows" + + | Action | Shortcut | + |-----------------|----------------------------------------------| + | Format document | ++shift+alt+f++ | + +=== "macOS" + + | Action | Shortcut | + |-----------------|----------------------------------------------| + | Format document | ++shift+command+f++ | + +=== "Linux" + + | Action | Shortcut | + |-----------------|-----------------------------------------------| + | Format document | ++control+shift+i++ | + +## Search & Navigation + +=== "Windows" + + | Action | Shortcut | + |-----------------|-----------------------| + | Open Search | ++control+f++ | + | Select All | ++alt+enter++ | + | Replace All | ++control+alt+enter++ | + | Go To Line | ++control+g++ | + | Next Diagnostic | ++f8++ | + | Previous Diag. | ++shift+f8++ | + | Open Lint Panel | ++control+shift+m++ | + +=== "macOS" + + | Action | Shortcut | + |-----------------|-----------------------| + | Open Search | ++command+f++ | + | Select All | ++command+enter++ | + | Replace All | ++command+option+enter++ | + | Go To Line | ++command+g++ | + | Next Diagnostic | ++f8++ | + | Previous Diag. | ++shift+f8++ | + | Open Lint Panel | ++command+shift+m++ | + +=== "Linux" + + | Action | Shortcut | + |-----------------|-----------------------| + | Open Search | ++control+f++ | + | Select All | ++alt+enter++ | + | Replace All | ++control+alt+enter++ | + | Go To Line | ++control+g++ | + | Next Diagnostic | ++f8++ | + | Previous Diag. | ++shift+f8++ | + | Open Lint Panel | ++control+shift+m++ | + + +# integrations/builtin/core-nodes/n8n-nodes-base.comparedatasets.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Compare Datasets +description: Documentation for the Compare Datasets node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Compare Datasets + +The Compare Datasets node helps you compare data from two input streams. + +## Node parameters + +1. Decide which fields to compare. In **Input A Field**, enter the name of the field you want to use from input stream A. In **Input B Field**, enter the name of the field you want to use from input stream B. +2. **Optional**: You can compare by multiple fields. Select **Add Fields to Match** to set up more comparisons. +3. Choose how to handle differences between the datasets. In **When There Are Differences**, select one of the following: + * **Use Input A Version** to treat input stream A as the source of truth. + * **Use Input B Version** to treat input stream B as the source of truth. + * **Use a Mix of Versions** to use different inputs for different fields. + * Use **Prefer** to select either **Input A Version** or **Input B Version** as the main source of truth. + * Enter input fields that are exceptions to **For Everything Except** to pull from the other input source. To add multiple input fields, enter a comma-separated list. + * **Include Both Versions** to include both input streams in the output, which may make the structure more complex. +4. Decide whether to use **Fuzzy Compare**. When turned on, the comparison will tolerate small type differences when comparing fields. For example, the number 3 and the string `3` are treated as the same with **Fuzzy Compare** turned on, but wouldn't be treated the same with it turned off. + +## Understand item comparison + +Item comparison is a two stage process: + +1. n8n checks if the values of the fields you selected to compare match across both inputs. +2. If the fields to compare match, n8n then compares all fields within the items, to determine if the items are the same or different. + +## Node options + +Use the node **Options** to refine your comparison or tweak comparison behavior. + +### Fields to Skip Comparing + +Enter field names that you want to ignore in the comparison. + +For example, if you compare the two datasets below using `person.language` as the **Fields to Match**, n8n returns them as different. If you add `person.name` to **Fields to Skip Comparing**, n8n returns them as matching. + +```json + // Input 1 + [ + { + "person": + { + "name": "Stefan", + "language": "de" + } + }, + { + "person": + { + "name": "Jim", + "language": "en" + } + }, + { + "person": + { + "name": "Hans", + "language": "de" + } + } + ] + // Input 2 + [ + { + "person": + { + "name": "Sara", + "language": "de" + } + }, + { + "person": + { + "name": "Jane", + "language": "en" + } + }, + { + "person": + { + "name": "Harriet", + "language": "de" + } + } + ] +``` + +### Disable Dot Notation + +Whether to disallow referencing child fields using `parent.child` in the field name (turned on) or allow it (turned off, default). + +### Multiple Matches + +Choose how to handle duplicate data. The default is **Include All Matches**. You can choose **Include First Match Only**. + +For example, given these two datasets: +```json + // Input 1 + [ + { + "fruit": { + "type": "apple", + "color": "red" + } + }, + { + "fruit": { + "type": "apple", + "color": "red" + } + }, + { + "fruit": { + "type": "banana", + "color": "yellow" + } + } + ] + // Input 2 + [ + { + "fruit": { + "type": "apple", + "color": "red" + } + }, + { + "fruit": { + "type": "apple", + "color": "red" + } + }, + { + "fruit": { + "type": "banana", + "color": "yellow" + } + } + ] +``` + +n8n returns three items in the **Same Branch** tab. The data is the same in both branches. + +If you select **Include First Match Only**, n8n returns two items, in the **Same Branch** tab. The data is the same in both branches, but n8n only returns the first occurrence of the matching "apple" items. + + +## Understand the output + +There are four output options: + +* **In A only Branch**: Contains data that occurs only in the first input. +* **Same Branch**: Contains data that's the same in both inputs. +* **Different Branch**: Contains data that's different between inputs. +* **In B only Branch**: Contains data that occurs only in the second output. + +## Templates and examples + + +[[ templatesWidget(page.title, 'compare-datasets') ]] + + + +# integrations/builtin/core-nodes/n8n-nodes-base.compression.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Compression +description: Documentation for the Compression node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: medium +--- + +# Compression + +Use the Compression node to compress and decompress files. Supports Zip and Gzip formats. + +## Node parameters + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +The node parameters depend on which **Operation** you select. Choose to: + +* **Compress**: Create a compressed file from your input data. +* **Decompress**: Decompress an existing compressed file. + +Refer to the sections below for parameters specific to each **Operation**. + +### Compress + +- **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. +- **Output Format**: Choose whether to format the compressed output as **Zip** or **Gzip**. +- **File Name**: Enter the name of the zip file the node creates. +- **Put Output File in Field**: Enter the name of the field in the output data to contain the file. + +### Decompress + +- **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. +- **Output Prefix**: Enter a prefix to add to the output file name. + +## Templates and examples + + +[[ templatesWidget(page.title, 'compression') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Convert to File +description: Documentation for the Convert to File node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: critical +--- + +# Convert to File + +Use 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. + +/// note | Extract From File +To extract data from a file and convert it to JSON, use the [Extract from File](/integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md) node. +/// + +## Operations + +* [**Convert to CSV**](#convert-to-csv) +* [**Convert to HTML**](#convert-to-html) +* [**Convert to ICS**](#convert-to-ics) +* [**Convert to JSON**](#convert-to-json) +* [**Convert to ODS**](#convert-to-ods) +* [**Convert to RTF**](#convert-to-rtf) +* [**Convert to Text File**](#convert-to-text-file) +* [**Convert to XLS**](#convert-to-xls) +* [**Convert to XLSX**](#convert-to-xlsx) +* [**Move Base64 String to File**](#move-base64-string-to-file) + +Node parameters and options depend on the operation you select. + +### Convert to CSV + +Configure 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. + +#### Convert to CSV options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* If the first row of the file contains header names, turn on the **Header Row** option. + +### Convert to HTML + +Configure 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. + +#### Convert to HTML options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* If the first row of the file contains header names, turn on the **Header Row** option. + +### Convert to ICS + +* **Put Output File in Field**. Enter the name of the field in the output data to contain the file. +* **Event Title**: Enter the title for the event. +* **Start**: Enter the date and time the event will start. All-day events ignore the time. +* **End**: Enter the date and time the event will end. All-day events ignore the time. If unset, the node uses the start date. +* **All Day**: Select whether the event is an all day event (turned on) or not (turned off). + +#### Convert to ICS options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **Attendees**: Use this option to add attendees to the event. For each attendee, add: + * **Name** + * **Email** + * **RSVP**: Select whether the attendee needs to confirm attendance (turned on) or doesn't (turned off). +* **Busy Status**: Use this option to set the busy status for Microsoft applications like Outlook. Choose from: + * **Busy** + * **Tentative** +* **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){:target=_blank .external-link} for the event. +* **Description**: Enter an event description. +* **Geolocation**: Enter the **Latitude** and **Longitude** for the event's location. +* **Location**: Enter the event's intended venue/location. +* **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){:target=_blank .external-link}. +* **Organizer**: Enter the organizer's **Name** and **Email**. +* **Sequence**: If you're sending an update for an event with the same universally unique ID (UID), enter the revision sequence number. +* **Status**: Set the status of the event. Choose from: + * **Confirmed** + * **Cancelled** + * **Tentative** +* **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. +* **URL**: Enter a URL associated with the event. +* **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](/workflows/settings.md). + +### Convert to JSON + +Choose the best output **Mode** for your needs from these options: + +* **All Items to One File**: Send all input items to a single file. +* **Each Item to Separate File**: Create a file for every input item. + +#### Convert to JSON options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **Format**: Choose whether to format the JSON for easier reading (turned on) or not (turned off). +* **Encoding**: Choose the character set to use to encode the data. The default is **utf8**. + +### Convert to ODS + +Configure 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. + +#### Convert to ODS options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **Compression**: Choose whether to compress and reduce the file's output size. +* **Header Row**: Turn on if the first row of the file contains header names. +* **Sheet Name**: Enter the Sheet Name to create in the spreadsheet. + +### Convert to RTF + +Configure 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. + +#### Convert to RFT options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* If the first row of the file contains header names, turn on the **Header Row** option. + +### Convert to Text File + +Enter 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`. + +#### Convert to Text File options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **Encoding**: Choose the character set to use to encode the data. The default is **utf8**. + +### Convert to XLS + +Configure 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. + +#### Convert to XLS options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **Header Row**: Turn on if the first row of the file contains header names. +* **Sheet Name**: Enter the Sheet Name to create in the spreadsheet. + +### Convert to XLSX + +Configure 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. + +#### Convert to XLSX options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **Compression**: Choose whether to compress and reduce the file's output size. +* **Header Row**: Turn on if the first row of the file contains header names. +* **Sheet Name**: Enter the Sheet Name to create in the spreadsheet. + +### Move Base64 String to File + +Enter 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`. + +#### Move Base64 String to File options + +You can also configure this operation with these **Options**: + +* **File Name**: Enter the file name for the generated output file. +* **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){:target=_blank .external-link} for a list of common MIME types and the file extensions they relate to. + +## Templates and examples + + +[[ templatesWidget(page.title, 'convert-to-file') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.crypto.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Crypto +description: Documentation for the Crypto node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: medium +--- + +# Crypto + +Use the Crypto node to encrypt data in workflows. + +## Actions + +* [**Generate** a random string](#generate-parameters) +* [**Hash** a text or file](#hash-parameters) in a specified format +* [**Hmac** a text or file](#hmac-parameters) in a specified format +* [**Sign** a string](#sign-parameters) using a private key + +## Node parameters + +--8<-- "_snippets/integrations/builtin/app-nodes/ai-tools.md" + +Node parameters depend on the action you select. + +### Generate parameters + +* **Property Name**: Enter the name of the property to write the random string to. +* **Type**: Select the encoding type to use to generate the string. Choose from: + * **ASCII** + * **BASE64** + * **HEX** + * **UUID** + +### Hash parameters + +* **Type**: Select the hash type to use. Choose from: + * **MD5** + * **SHA256** + * **SHA3-256** + * **SHA3-384** + * **SHA3-512** + * **SHA385** + * **SHA512** +* **Binary File**: Turn this parameter on if the data you want to hash is from a binary file. + * **Value**: If you turn off **Binary File**, enter the value you want to hash. + * **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to hash. +* **Property Name**: Enter the name of the property you want to write the hash to. +* **Encoding**: Select the encoding type to use. Choose from: + * **BASE64** + * **HEX** + +### Hmac parameters + +* **Binary File**: Turn this parameter on if the data you want to encrypt is from a binary file. + * **Value**: If you turn off **Binary File**, enter the value you want to encrypt. + * **Binary Property Name**: If you turn on **Binary File**, enter the name of the binary property that contains the data you want to encrypt. +* **Type**: Select the encryption type to use. Choose from: + * **MD5** + * **SHA256** + * **SHA3-256** + * **SHA3-384** + * **SHA3-512** + * **SHA385** + * **SHA512** +* **Property Name**: Enter the name of the property you want to write the hash to. +* **Secret**: Enter the secret or secret key used for decoding. +* **Encoding**: Select the encoding type to use. Choose from: + * **BASE64** + * **HEX** + +### Sign parameters + +* **Value**: Enter the value you want to sign. +* **Property Name**: Enter the name of the property you want to write the signed value to. +* **Algorithm Name or ID**: Choose an algorithm name from the list or specify an ID using an [expression](/code/expressions.md). +* **Encoding**: Select the encoding type to use. Choose from: + * **BASE64** + * **HEX** +* **Private Key**: Enter a private key to use when signing the string. + +## Templates and examples + + +[[ templatesWidget(page.title, 'crypto') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.datetime.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Date & Time +description: Documentation for the Date & Time node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Date & Time + +The Date & Time node manipulates date and time data and convert it to different formats. + +--8<-- "_snippets/integrations/builtin/core-nodes/schedule/timezone-settings.md" + +/// note | Date and time in other nodes +You 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](/code/cookbook/luxon.md) for more information. +/// + +## Operations + +* **Add to a Date**: Add a specified amount of time to a date. +* **Extract Part of a Date**: Extract part of a date, such as the year, month, or day. +* **Format a Date**: Transform a date's format to a new format using preset options or a custom expression. +* **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. +* **Get Time Between Dates**: Calculate the amount of time in specific units between two dates. +* **Round a Date**: Round a date up or down to the nearest unit of your choice, such as month, day, or hour. +* **Subtract From a Date**: Subtract a specified amount of time from a date. + +Refer to the sections below for parameters and options specific to each operation. + +## Add to a Date + +Configure the node for this operation using these parameters: + +* **Date to Add To**: Enter the date you want to change. +* **Time Unit to Add**: Select the time unit for the **Duration** parameter. +* **Duration**: Enter the number of time units to add to the date. +* **Output Field Name**: Enter the name of the field to output the new date to. + +### Add to a Date options + +This 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. + +## Extract Part of a Date + +Configure the node for this operation using these parameters: + +* **Date**: Enter the date you want to round or extract part of. +* **Part**: Select the part of the date you want to extract. Choose from: + * **Year** + * **Month** + * **Week** + * **Day** + * **Hour** + * **Minute** + * **Second** +* **Output Field Name**: Enter the name of the field to output the extracted date part to. + +### Extract Part of a Date options + +This 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. + +## Format a Date + +Configure the node for this operation using these parameters: + +* **Date**: Enter the date you want to format. +* **Format**: Select the format you want to change the date to. Choose from: + * **Custom Format**: Enter your own custom format using Luxon's [special tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens){:target=_blank .external-link}. Tokens are case-sensitive. + * **MM/DD/YYYY**: For `4 September 1986`, this formats the date as `09/04/1986`. + * **YYYY/MM/DD**: For `4 September 1986`, this formats the date as `1986/09/04`. + * **MMMM DD YYYY**: For `4 September 1986`, this formats the date as `September 04 1986`. + * **MM-DD-YYYY**: For `4 September 1986`, this formats the date as `09-04-1986`. + * **YYYY-MM-DD**: For `4 September 1986`, this formats the date as `1986-09-04`. +* **Output Field Name**: Enter the name of the field to output the formatted date to. + +### Format a Date options + +This operation includes these options: + +* **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. +* **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){:target=_blank .external-link} to enter the format. Tokens are case-sensitive +* **Use Workflow Timezone**: Whether to use the input's time zone (turned off) or the workflow's timezone (turned on). + +## Get Current Date + +Configure the node for this operation using these parameters: + +* **Include Current Time**: Choose whether to include the current time (turned on) or to set the time to midnight (turned off). +* **Output Field Name**: Enter the name of the field to output the current date to. + +### Get Current Date options + +This operation includes these options: + +* **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. +* **Timezone**: Set the timezone to use. If left blank, the node uses the n8n instance's timezone. + +/// note | +00:00 timezone +Use `GMT` for +00:00 timezone. +/// + +## Get Time Between Dates + +Configure the node for this operation using these parameters: + +* **Start Date**: Enter the earlier date you want to compare. +* **End Date**: Enter the later date you want to compare. +* **Units**: Select the units you want to calculate the time between. You can include multiple units. Choose from: + * **Year** + * **Month** + * **Week** + * **Day** + * **Hour** + * **Minute** + * **Second** + * **Millisecond** +* **Output Field Name**: Enter the name of the field to output the calculated time between to. + +### Get Time Between Dates options + +The 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: + + timeDifference + years : 1 + months : 3 + days : 13 + +If you turn on the **Output as ISO String** option, the node formats the output as a single ISO duration string, for example: `P1Y3M13D`. + +ISO duration format displays a format as `PYMDTHMS`. `` is the number for the unit after it. + +* P = period (duration). It begins all ISO duration strings. +* Y = years +* M = months +* W = weeks +* D = days +* T = delineator between dates and times, used to avoid confusion between months and minutes +* H = hours +* M = minutes +* S = seconds + +Milliseconds don't get their own unit, but instead are decimal seconds. For example, 2.1 milliseconds is `0.0021S`. + +## Round a Date + +Configure the node for this operation using these parameters: + +* **Date**: Enter the date you'd like to round. +* **Mode**: Choose whether to **Round Down** or **Round Up**. +* **To Nearest**: Select the unit you'd like to round to. Choose from: + * **Year** + * **Month** + * **Week** + * **Day** + * **Hour** + * **Minute** + * **Second** +* **Output Field Name**: Enter the name of the field to output the rounded date to. + +### Round a Date options + +This 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. + +## Subtract From a Date + +Configure the node for this operation using these parameters: + +* **Date to Subtract From**: Enter the date you'd like to subtract from. +* **Time Unit to Subtract**: Select the unit for the **Duration** amount you want to subtract. +* **Duration**: Enter the amount of the time units you want to subtract from the **Date to Subtract From**. +* **Output Field Name**: Enter the name of the field to output the rounded date to. + +### Subtract From a Date options + +This 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. + +## Templates and examples + + +[[ templatesWidget(page.title, 'date-and-time') ]] + +## Related resources + +The Date & Time node uses [Luxon](https://moment.github.io/luxon){:target=_blank .external-link}. You can also use Luxon in the [Code](/code/code-node.md) node and [expressions](/code/expressions.md). Refer to [Date and time with Luxon](/code/cookbook/luxon.md) for more information. + +### Supported date formats + +n8n supports all date formats [supported by Luxon](https://moment.github.io/luxon/#/formatting?id=table-of-tokens){:target=_blank .external-link}. Tokens are case-sensitive. + + +# integrations/builtin/core-nodes/n8n-nodes-base.debughelper.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Debug Helper +description: Documentation for the Debug Helper node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: medium +--- + +# Debug Helper + +Use the Debug Helper node to trigger different error types or generate random datasets to help test n8n workflows. + +## Operations + +Define the operation by selecting the **Category**: + +* **Do Nothing**: Don't do anything. +* [**Throw Error**](#throw-error): Throw an error with the specified type and message. +* [**Out Of Memory**](#out-of-memory): Generate a specific memory size to simulate being out of memory. +* [**Generate Random Data**](#generate-random-data): Generate some random data in a selected format. + +## Node parameters + +The node parameters depend on the **Category** selected. The **Do Nothing** Category has no other parameters. + +### Throw Error + +* **Error Type**: Select the type of error to throw. Choose from: + * **NodeApiError** + * **NodeOperationError** + * **Error** +* **Error Message**: Enter the error message to throw. + +### Out Of Memory + +The Out of Memory Category adds one parameter, the **Memory Size to Generate**. Enter the approximate amount of memory to generate. + +### Generate Random Data + +* **Data Type**: Choose the type of random data you'd like to generate. Options include: + * **Address** + * **Coordinates** + * **Credit Card** + * **Email** + * **IPv4** + * **IPv6** + * **MAC** + * **Nanoids**: If you select this data type, you'll also need to enter: + * **Nanoid Alphabet**: The alphabet the generator will use to generate the nanoids. + * **Nanoid Length**: The length of each nanoid. + * **URL** + * **User Data** + * **UUID** + * **Version** +* **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. +* **Number of Items to Generate**: Enter the number of random items you'd like to generate. +* **Output as Single Array**: Whether to generate the data as a single array (turned on) or multiple items (turned off). + +## Templates and examples + + +[[ templatesWidget(page.title, 'debughelper') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.editimage.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Edit Image +description: Documentation for the Edit Image node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: medium +--- + +# Edit Image + +Use the Edit Image node to manipulate and edit images. + +/// note | Dependencies +1. If you aren't running n8n on Docker, you need to install [GraphicsMagick](http://www.graphicsmagick.org/README.html){:target=_blank .external-link}. +2. You need to use a node such as the [Read/Write Files from Disk](/integrations/builtin/core-nodes/n8n-nodes-base.readwritefile.md) node or the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node to pass the image file as a data property to the Edit Image node. +/// + +## Operations + +- Add a **Blur** to the image to reduce sharpness +- Add a **Border** to the image +- **Composite** an image on top of another image +- **Create** a new image +- **Crop** the image +- **Draw** on an image +- **Get Information** about the image +- **Multi Step** perform multiple operations on the image +- **Resize**: Change the size of the image +- **Rotate** the image +- **Shear** image along the X or Y axis +- Add **Text** to the image +- Make a color in image **Transparent** + +## Node parameters + +The parameters for this node depend on the operation you select. + +### Blur parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Blur**: Enter a number to set how strong the blur should be, between 0 and 1000. Higher numbers create blurrier images. +* **Sigma**: Enter a number to set the stigma for the blur, between 0 and 1000. Higher numbers create blurrier images. + +Refer to [Node options](#node-options) for optional configuration options. + +### Border parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Border Width**: Enter the width of the border. +* **Border Height**: Enter the height of the border. +* **Border Color**: Set the color for the border. You can either enter a hex or select the color swatch to open a color picker. + +Refer to [Node options](#node-options) for optional configuration options. + +### Composite parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. This image is your base image. +* **Composite Image Property**: Enter the name of the binary property that stores image to composite on top of the **Property Name** image. +* **Operator**: Select composite operator, which determines how the composite works. Options include: + * **Add** + * **Atop** + * **Bumpmap** + * **Copy** + * **Copy Black** + * **Copy Blue** + * **Copy Cyan** + * **Copy Green** + * **Copy Magenta** + * **Copy Opacity** + * **Copy Red** + * **Copy Yellow** + * **Difference** + * **Divide** + * **In** + * **Minus** + * **Multiply** + * **Out** + * **Over** + * **Plus** + * **Subtract** + * **Xor** +* **Position X**: Enter the x axis position (horizontal) of the composite image. +* **Position Y**: Enter the y axis position (vertical) of the composite image. + +Refer to [Node options](#node-options) for optional configuration options. + +### Create parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **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. +* **Image Width**: Enter the width of the image. +* **Image Height**: Enter the height of the image. + +Refer to [Node options](#node-options) for optional configuration options. + +### Crop parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Width**: Enter the width you'd like to crop to. +* **Height**: Enter the height you'd like to crop to. +* **Position X**: Enter the x axis position (horizontal) to start the crop from. +* **Position Y**: Enter the y axis position (vertical) to start the crop from. + +Refer to [Node options](#node-options) for optional configuration options. + +### Draw parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Primitive**: Select the primitive shape to draw. Choose from: + * **Circle** + * **Line** + * **Rectangle** +* **Color**: Set the color for the primitive. You can either enter a hex or select the color swatch to open a color picker. +* **Start Position X**: Enter the x axis position (horizontal) to start drawing from. +* **Start Position Y**: Enter the y axis position (vertical) to start drawing from. +* **End Position X**: Enter the x axis position (horizontal) to stop drawing at. +* **End Position Y**: Enter the y axis position (vertical) to start drawing at. +* **Corner Radius**: Enter a number to set the corner radius. Adding a corner radius will round the corners of the drawn primitive. + +Refer to [Node options](#node-options) for optional configuration options. + +### Get Information parameters + +For this operation, you only need to add the **Property Name** of the binary property that stores the image data. + +Refer to [Node options](#node-options) for optional configuration options. + +### Multi Step parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Operations**: Add the operations you want the multi step operation to perform. You can use any of the other operations. + +Refer to [Node options](#node-options) for optional configuration options. + +### Resize parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Width**: Enter the new width you'd like for the image. +* **Height**: Enter the new height you'd like for the image. +* **Option**: Select how you'd like to resize the image. Choose from: + * **Ignore Aspect Ratio**: Ignore the aspect ratio and resize to the exact height and width you've entered. + * **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. + * **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. + * **Only if Larger**: Resize the image only if it's larger than the width and height you entered. The image maintains its aspect ratio. + * **Only if Smaller**: Resize the image only if it's smaller than the width and height you entered. The image maintains its aspect ratio. + * **Percent**: Resize the image using the width and height as percentages of the original image. + +Refer to [Node options](#node-options) for optional configuration options. + +### Rotate parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Rotate**: Enter the number of degrees to rotate the image, from --360 to 360. +* **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. + +Refer to [Node options](#node-options) for optional configuration options. + +### Shear parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Degrees X**: Enter the number of degrees to shear from the x axis. +* **Degrees Y**: Enter the number of degrees to shear from the y axis. + +Refer to [Node options](#node-options) for optional configuration options. + +### Text parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Text**: Enter the text you'd like to write on the image. +* **Font Size**: Select the font size for the text. +* **Font Color**: Set the font color. You can either enter a hex or select the color swatch to open a color picker. +* **Position X**: Enter the x axis position (horizontal) to begin the text at. +* **Position Y**: Enter the y axis position (vertical) to begin the text at. +* **Max Line Length**: Enter the maximum amount of characters in a line before adding a line break. + +Refer to [Node options](#node-options) for optional configuration options. + +### Transparent parameters + +* **Property Name**: Enter the name of the binary property that stores the image data. +* **Color**: Set the color to make transparent. You can either enter a hex or select the color swatch to open a color picker. + +Refer to [Node options](#node-options) for optional configuration options. + +## Node options + +- **File Name**: Enter the filename of the output file. +- **Format**: Enter the image format of the output file. Choose from: + - **bmp** + - **gif** + - **jpeg** + - **png** + - **tiff** + - **WebP** + +The **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](/code/expressions.md). + +## Templates and examples + + +[[ templatesWidget(page.title, 'edit-image') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.emailimap.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Email Trigger (IMAP) node documentation +description: Learn how to use the Email Trigger (IMAP) Trigger node in n8n. Follow technical documentation to integrate Email Trigger (IMAP) Trigger node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Email Trigger (IMAP) node + +Use the IMAP Email node to receive emails using an IMAP email server. This node is a trigger node. + +/// note | Credential +You can find authentication information for this node [here](/integrations/builtin/credentials/imap/index.md). +/// + +## Operations + +- Receive an email + +## Node parameters + +Configure the node using the following parameters. + +### Credential to connect with + +Select or create an [IMAP credential](/integrations/builtin/credentials/imap/index.md) to connect to the server with. + +### Mailbox Name + +Enter the mailbox from which you want to receive emails. + +### Action + +Choose 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. + +### Download Attachments + +This toggle controls whether to download email attachments (turned on) or not (turned off). Only set this if necessary, since it increases processing. + +### Format + +Choose the format to return the message in from these options: + +* **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. +* **Resolved**: This format returns the full email with all data resolved and attachments saved as binary data. +* **Simple**: This format returns the full email. Don't use it if you want to gather inline attachments. + +## Node options + +You can further configure the node using these **Options**. + +### Custom Email Rules + +Enter custom email fetching rules to determine which emails the node fetches. + +Refer to [node-imap's search function criteria](https://github.com/mscdex/node-imap){:target=_blank .external-link} for more information. + +### Force Reconnect Every Minutes + +Set an interval in minutes to force reconnection. + +## Templates and examples + + +[[ templatesWidget(page.title, 'email-trigger-imap') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.errortrigger.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Error Trigger node documentation +description: Learn how to use the Error Trigger node in n8n. Follow technical documentation to integrate Error Trigger node into your workflows. +contentType: [integration, reference] +priority: medium +--- + +# Error Trigger node + +You 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. + +## Usage + +--8<-- "_snippets/flow-logic/create-set-error-workflow.md" + + +Note the following: + +* If a workflow uses the Error Trigger node, you don't have to activate the workflow. +* If a workflow contains the Error Trigger node, by default, the workflow uses itself as the error workflow. +* You can't test error workflows when running workflows manually. The Error Trigger only runs when an automatic workflow errors. + +## Templates and examples + + +[[ templatesWidget(page.title, 'error-trigger') ]] + +## Related resources + +You can use the [Stop And Error](/integrations/builtin/core-nodes/n8n-nodes-base.stopanderror.md) node to send custom messages to the Error Trigger. + +Read more about [Error workflows](/flow-logic/error-handling.md) in n8n workflows. + +## Error data + +--8<-- "_snippets/integrations/builtin/core-nodes/error-trigger/error-data.md" + + + +# integrations/builtin/core-nodes/n8n-nodes-base.executecommand/common-issues.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Execute Command node common issues +description: Documentation for common issues and questions in the Execute Command node in n8n, a workflow automation platform. Includes details of the issue and suggested solutions. +contentType: [integration, reference] +priority: high +--- + +# Execute Command node common issues + +Here are some common errors and issues with the [Execute Command node](/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/index.md) and steps to resolve or troubleshoot them. + + +## Command failed: <command> /bin/sh: <command>: not found + + +This error occurs when the shell environment can't find one of the commands in the **Command** parameter. + +To fix this error, review the following: + +* Check that the command and its arguments don't have typos in the **Command** parameter. +* Check that the command is in the `PATH` of the user running n8n. +* 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/){:target=_blank .external-link} that includes your command. + * If n8n is already running: + ```sh + # 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 + ``` + * If n8n isn't running: + ```sh + # 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 + ``` + + +## Error: stdout maxBuffer length exceeded + + +This error happens when your command returns more output than the Execute Command node is able to process at one time. + +To 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. + + +# integrations/builtin/core-nodes/n8n-nodes-base.executecommand/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Execute Command +description: Documentation for the Execute Command node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Execute Command + +The Execute Command node runs shell commands on the host machine that runs n8n. + +/// note | Which shell runs the command? +This node executes the command in the default shell of the host machine. For example, `cmd` on Windows and `zsh` on macOS. + +If you run n8n with Docker, your command will run in the n8n container and not the Docker host. +/// + +/// note | Not available on Cloud +This node isn't available on n8n Cloud. +/// + +## Node parameters + +Configure the node using the following parameters. + +### Execute Once + +Choose whether you want the node to execute only once (turned on) or once for every item it receives as input (turned off). + +### Command + +Enter 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). + +#### Run multiple commands + +Use one of two methods to run multiple commands in one Execute Command node: + +* Enter each command on one line separated by `&&`. For example, you can combine the change directory (cd) command with the list (ls) command using `&&`. + + ```bash + cd bin && ls + ``` + +* 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. + + ```bash + cd bin + ls + ``` + +#### Run cURL command + +You can also use the [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node to make a cURL request. + +If 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. + +1. Create a file named `Dockerfile`. +2. Add the below code snippet to the Dockerfile. + + ```shell + FROM docker.n8n.io/n8nio/n8n + USER root + RUN apk --update add curl + USER node + ``` + +3. In the same folder, execute the command below to build the Docker image. + + ```shell + docker build -t n8n-curl + ``` + +4. Replace the Docker image you used before. For example, replace `docker.n8n.io/n8nio/n8n` with `n8n-curl`. +5. Run the newly created Docker image. You'll now be able to execute ssh using the Execute Command Node. + +## Templates and examples + + +[[ templatesWidget(page.title, 'execute-command') ]] + +## Common issues + +For common questions or issues and suggested solutions, refer to [Common Issues](/integrations/builtin/core-nodes/n8n-nodes-base.executecommand/common-issues.md). + + +# integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Execute Sub-workflow +description: Documentation for the Execute Sub-workflow node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Execute Sub-workflow + +Use the Execute Sub-workflow node to run a different workflow on the host machine that runs n8n. + +## Node parameters + +### Source + +Select where the node should get the sub-workflow's information from: + +- **Database**: Select this option to load the workflow from the database by ID. You must also enter either: + - **From list**: Select the workflow from a list of workflows available to your account. + - **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`. +- **Local File**: Select this option to load the workflow from a locally saved JSON file. You must also enter: + - **Workflow Path**: Enter the path to the local JSON workflow file you want the node to execute. +- **Parameter**: Select this option to load the workflow from a parameter. You must also enter: + - **Workflow JSON**: Enter the JSON code you want the node to execute. +- **URL**: Select this option to load the workflow from a URL. You must also enter: + - **Workflow URL**: Enter the URL you want to load the workflow from. + +### Workflow Inputs + +If 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. + +You 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. + +Input items won't appear if the sub-workflow's Workflow Input Trigger node uses the "Accept all data" input data mode. + +### Mode + +Use this parameter to control the execution mode for the node. Choose from these options: + +- **Run once with all items**: Pass all input items into a single execution of the node. +- **Run once for each item**: Execute the node once for each input item in turn. + +## Node options + +This 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). + +## Templates and examples + + +[[ templatesWidget(page.title, 'execute-workflow') ]] + +## Set up and use a sub-workflow + +This section walks through setting up both the parent workflow and sub-workflow. + +--8<-- "_snippets/flow-logic/subworkflow-usage.md" + + +## How data passes between workflows + +--8<-- "_snippets/flow-logic/subworkflow-data-flow.md" + + +# integrations/builtin/core-nodes/n8n-nodes-base.executeworkflowtrigger.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Execute Sub-workflow Trigger node documentation +description: Learn how to use the Execute Sub-workflow Trigger node in n8n. Follow technical documentation to integrate Execute Sub-workflow Trigger node into your workflows. +contentType: [integration, reference] +priority: high +--- + +# Execute Sub-workflow Trigger node + +Use this node to start a workflow in response to another workflow. It should be the first node in the workflow. + +n8n allows you to call workflows from other workflows. This is useful if you want to: + +* 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. +* Break large workflows into smaller components. + +## Usage + +This node runs in response to a call from the [Execute Sub-workflow](/integrations/builtin/core-nodes/n8n-nodes-base.executeworkflow.md) or [Call n8n Workflow Tool](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md) nodes. + +--8<-- "_snippets/flow-logic/subworkflow-usage.md" + +## Templates and examples + + +[[ templatesWidget(page.title, 'execute-workflow-trigger') ]] + +## How data passes between workflows + +--8<-- "_snippets/flow-logic/subworkflow-data-flow.md" + + +# integrations/builtin/core-nodes/n8n-nodes-base.executiondata.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Execution Data +description: Documentation for the Execution Data node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Execution Data + +Use this node to save metadata for workflow executions. You can then search by this data in the **Executions** list. + +You can retrieve custom execution data during workflow execution using the Code node. Refer to [Custom executions data](/workflows/executions/custom-executions-data.md) for more information. + +/// info | Feature availability +Available on Pro and Enterprise plans. +/// + +## Operations + +* Save Execution Data for Search + +## Data to Save + +Add a **Saved Field** for each key/value pair of metadata you'd like to save. + +## Limitations + +The Execution Data node has the following restrictions when storing execution metadata: + +* `key`: limited to 50 characters +* `value`: limited to 512 characters + +If either the `key` or `value` exceed the above limitations, n8n truncates to their maximum length and outputs a log entry. + +## Templates and examples + + +[[ templatesWidget(page.title, 'execution-data') ]] + + +# integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Extract From File +description: Documentation for the Extract From File node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: high +--- + +# Extract From File + +A common pattern in n8n workflows is to receive a file, either from and [HTTP Request node][] (for files you are fetching from a website), a [Webhook Node][] (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. + +The 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](/integrations/builtin/core-nodes/n8n-nodes-base.converttofile.md) node. + +## Operations + +Use the **Operations** drop-down to select the format of the source file to extract data from. + +- **Extract From CSV**: The "Comma Separated Values" file type is commonly used for tabulated data. +- **Extract From HTML**: Extract fields from standard web page HTML format files. +- **Extract From JSON**: Extract JSON data from a binary file. +- **Extract From ICS**: Extract fields from iCalendar format files. +- **Extract From ODS**: Extract fields from ODS spreadsheet files. +- **Extract From PDF**: Extract fields from Portable Document Format files. +- **Extract From RTF**: Extract fields from Rich Text Format files. +- **Extract From Text File**: Extract fields from a standard text file format. +- **Extract From XLS**: Extract fields from a Microsoft Excel file (older format). +- **Extract From XLSX**: Extract fields from a Microsoft Excel file. +- **Move File to Base64 String**: Converts binary data to a text-friendly [base64][] format. + +## Example workflow + +In 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. + +[[ workflowDemo("file:///integrations/builtin/core-nodes/n8n-nodes-base.extractfromfile/webhook-example.json") ]] + +Set to operate as 'Extract from CSV', the node then outputs the data as a series of JSON 'row' objects: + +``` +{ + "row": { + "0": "apple", + "1": "1", + "2": "2", + "3": "3" + } + ... +``` + +/// tip | Receiving files with a webhook +Select 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. +/// + +## Node parameters + +### Input Binary Field + +Enter the name of the field from the node input data that contains the binary file. The default is 'data'. + +### Destination Output Field + +Enter the name of the field in the node output that will contain the extracted data. + +This parameter is only available for these operations: + +- Extract From JSON +- Extract From ICS +- Extract From Text File +- Move File to Base64 String + +## Templates and examples + + +[[ templatesWidget(page.title, 'extract-from-file') ]] + +[HTTP Request Node]: /integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md +[Webhook Node]: /integrations/builtin/core-nodes/n8n-nodes-base.webhook/index.md +[base64]: https://datatracker.ietf.org/doc/html/rfc4648#section-4 + + +# integrations/builtin/core-nodes/n8n-nodes-base.filter.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Filter +description: Documentation for the Filter node in n8n, a workflow automation platform. Includes guidance on usage, and links to examples. +contentType: [integration, reference] +priority: critical +--- + +# Filter + +Filter 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. + +## Node parameters + +Create filter comparison **Conditions** to perform your filter. + +- 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**. +- 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. + +Select **Add condition** to create more conditions. + +### Combining conditions + +You can choose to keep items: + +* When they meet all conditions: Create two or more conditions and select **AND** in the dropdown between them. +* When they meet any of the conditions: Create two or more conditions and select **OR** in the dropdown between them. + +You can't create a mix of AND and OR rules. + +## Node options + +- **Ignore Case**: Whether to ignore letter case (turned on) or be case sensitive (turned off). +- **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. + +## Templates and examples + + +[[ templatesWidget(page.title, 'filter') ]] + +--8<-- "_snippets/integrations/builtin/core-nodes/data-types.md" + + +# integrations/builtin/core-nodes/n8n-nodes-base.form.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n Form node documentation +description: Documentation for the n8n Form node in n8n, a workflow automation platform. Includes guidance on usage and links to examples. +contentType: [integration, reference] +--- + +# n8n Form node + +Use the n8n Form node to create user-facing forms with multiple steps. You can add other nodes with custom logic between to process user input. You must start the workflow with the [n8n Form Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.formtrigger.md). + +[[ workflowDemo("file:///integrations/builtin/core-nodes/n8n-nodes-base.form/mutually-exclusive-branching.json") ]] + +## Setting up the node + +### Set default selections with query parameters + +You can set the initial values for fields by using [query parameters](https://en.wikipedia.org/wiki/Query_string#Web_forms){:target=_blank .external-link} with the initial URL provided by the [n8n Form Trigger](/integrations/builtin/core-nodes/n8n-nodes-base.formtrigger.md). Every page in the form receives the same query parameters sent to the n8n Form Trigger URL. + +/// note | Only for production +Query parameters are only available when using the form in production mode. n8n won't populate field values from query parameters in testing mode. +/// + + +When using query parameters, [percent-encode](https://en.wikipedia.org/wiki/Percent-encoding){:target=_blank .external-link} any field names or values that use special characters. This ensures n8n uses the initial values for the given fields. You can use tools like [URL Encode/Decode](https://www.url-encode-decode.com/) to format your query parameters using percent-encoding. + +As an example, imagine you have a form with the following properties: + +* Production URL: `https://my-account.n8n.cloud/form/my-form` +* Fields: + * `name`: `Jane Doe` + * `email`: `jane.doe@example.com` + +With query parameters and percent-encoding, you could use the following URL to set initial field values to the data above: + +``` +https://my-account.n8n.cloud/form/my-form?email=jane.doe%40example.com&name=Jane%20Doe +``` + +Here, percent-encoding replaces the at-symbol (`@`) with the string `%40` and the space character (` `) with the string `%20`. This will set the initial value for these fields no matter which page of the form they appear on. + + +### Displaying custom HTML + +You can display custom HTML on your form by adding a **Custom HTML** field to your form. This provides an **HTML** box where you can insert arbitrary HTML code to display as part of the form page. + +You can use the HTML field to enrich your form page by including things like links, images, videos, and more. n8n will render the content with the rest of the form fields in the normal document flow. + +Because custom HTML content is read-only, these fields aren't included in the form output data by default. To include the raw HTML content in the node output, provide a name for the data using the **Element Name** field. + +The HTML field doesn't support ` + + +# docs/api/authentication.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Authentication for n8n's public REST API. +contentType: howto +--- + +# API authentication + +n8n uses API keys to authenticate API calls. + +/// info | Feature availability +The n8n API isn't available during the free trial. Please upgrade to access this feature. +/// + +## API Scopes + +Users of [enterprise instances](https://n8n.io/enterprise/) can limit which resources and actions a key can access with scopes. API key scopes allow you specify the exact level of access a key needs for its intended purpose. + +Non-enterprise API keys have full access to all the account's resources and capabilities. + +## Create an API key + +1. Log in to n8n. +1. Go to **Settings** > **n8n API**. +1. Select **Create an API key**. +1. Choose a **Label** and set an **Expiration** time for the key. +1. If on an enterprise plan, choose the **Scopes** to give the key. +1. Copy **My API Key** and use this key to authenticate your calls. + +## Call the API using your key + +Send the API key in your API call as a header named `X-N8N-API-KEY`. + +For example, say you want to get all active workflows. Your curl request will look like this: + +```shell +# For a self-hosted n8n instance +curl -X 'GET' \ + '://api/v/workflows?active=true' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' + +# For n8n Cloud +curl -X 'GET' \ + '/api/v/workflows?active=true' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' +``` + +## Delete an API key + +1. Log in to n8n. +2. Go to **Settings** > **n8n API**. +3. Select **Delete** next to the key you want to delete. +4. Confirm the delete by selecting **Delete Forever**. + + +# docs/api/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n public REST API Documentation and Guides +description: Access n8n public REST API documentation and guides. Find comprehensive resources to programmatically perform tasks with the public API instead of the GUI. +contentType: overview +search: + boost: 5 +--- + +# n8n public REST API + +/// info | Feature availability +The n8n API isn't available during the free trial. Please upgrade to access this feature. +/// + +Using n8n's public [API](/glossary.md#api), you can programmatically perform many of the same tasks as you can in the GUI. This section introduces n8n's REST API, including: + +* How to [authenticate](/api/authentication.md) +* [Paginating](/api/pagination.md) results +* Using the [built-in API playground](/api/using-api-playground.md) (self-hosted n8n only) +* [Endpoint reference](/api/api-reference.md) + +n8n provides an [n8n API node](/integrations/builtin/core-nodes/n8n-nodes-base.n8n.md) to access the API in your workflows. + +## Learn about REST APIs + +The API documentation assumes you are familiar with REST APIs. If you're not, these resources may be helpful: + +* [KnowledgeOwl's guide to working with APIs](https://support.knowledgeowl.com/help/working-with-apis){:target=_blank .external-link}: a basic introduction, including examples of how to call REST APIs. +* [IBM Cloud Learn Hub - What is an Application Programming Interface (API)](https://www.ibm.com/cloud/learn/api){:target=_blank .external-link}: this gives a general, but technical, introduction to APIs. +* [IBM Cloud Learn Hub - What is a REST API?](https://www.ibm.com/cloud/learn/rest-apis){:target=_blank .external-link}: more detailed information about REST APIs. +* [MDN web docs - An overview of HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview){:target=_blank .external-link}: REST APIs work over HTTP and use HTTP verbs, or methods, to specify the action to perform. + +/// tip | Use the API playground (self-hosted n8n only) +Trying out the API in the [playground](/api/using-api-playground.md) 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. +/// + + +# docs/api/pagination.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Pagination in n8n's public REST API. +contentType: howto +--- + +# API pagination + +The default page size is 100 results. You can change the page size limit. The maximum permitted size is 250. + +When a response contains more than one page, it includes a cursor, which you can use to request the next pages. + +For example, say you want to get all active workflows, 150 at a time. + +Get the first page: + +```shell +# For a self-hosted n8n instance +curl -X 'GET' \ + '://api/v/workflows?active=true&limit=150' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' + +# For n8n Cloud +curl -X 'GET' \ + '/api/v/workflows?active=true&limit=150' \ + -H 'accept: application/json' \ + -H 'X-N8N-API-KEY: ' +``` + +The response is in JSON format, and includes a `nextCursor` value. This is an example response. + +```js +{ + "data": [ + // The response contains an object for each workflow + { + // Workflow data + } + ], + "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA" +} +``` + +Then to request the next page: + +```bash +# For a self-hosted n8n instance +curl -X 'GET' \ + '://api/v/workflows?active=true&limit=150&cursor=MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA' \ + -H 'accept: application/json' + +# For n8n Cloud +curl -X 'GET' \ + '/api/v/workflows?active=true&limit=150&cursor=MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA' \ + -H 'accept: application/json' +``` + + +# docs/api/using-api-playground.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: How to use the API playground to try out n8n's public REST API. +contentType: howto +--- + +# Using the API playground + +/// info | Feature availability +The API playground isn't available on Cloud. It's available for all self-hosted pricing tiers. +/// + +The n8n API comes with a built-in Swagger UI playground in self-hosted versions. This provides interactive documentation, where you can try out requests. The path to access the playground depends on your hosting. + +n8n constructs the path from values set in your environment variables: + +```shell +N8N_HOST:N8N_PORT/N8N_PATH/api/v/docs +``` + +The API version number is `1`. There may be multiple versions available in the future. + +/// warning | Real data +If you select **Authorize** and enter your API key in the API playground, you have access to your live data. This is useful for trying out requests. Be aware you can change or delete real data. +/// +The API includes built-in documentation about credential formats. This is available using the `credentials` endpoint: + +```shell +N8N_HOST:N8N_PORT/N8N_PATH/api/v/credentials/schema/{credentialTypeName} +``` + +/// note | How to find `credentialTypeName` +To find the type, download your workflow as JSON and examine it. For example, for a Google Drive node the `{credentialTypeName}` is `googleDriveOAuth2Api`: +```json +{ + ..., + "credentials": { + "googleDriveOAuth2Api": { + "id": "9", + "name": "Google Drive" + } + } +} +``` +/// + + +# docs/source-control-environments/create-environments.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Tutorial - Create environments with source control +description: How to use n8n's source control feature to create environments. +contentType: tutorial +--- + +# Tutorial: Create environments with source control + +--8<-- "_snippets/source-control-environments/feature-availability.md" + +This tutorial walks through the process of setting up environments end-to-end. You'll create two environments: development and production. It uses GitHub as the Git provider. The process is similar for other providers. + +n8n has built its environments feature on top of Git, a version control software. You link an n8n instance to a Git branch, and use a push-pull pattern to move work between environments. You should have some understanding of environments and Git. If you need more information on these topics, refer to: + +* [Environments in n8n](/source-control-environments/understand/environments.md): the purpose of environments, and how they work in n8n. +* [Git and n8n](/source-control-environments/understand/git.md): Git concepts and source control in n8n. + +## Choose your source control pattern + +Before setting up source control and environments, you need to plan your environments, and how they relate to Git branches. n8n supports different [Branch patterns](/source-control-environments/understand/patterns.md). For environments, you need to choose between two patterns: multi-instance, multi-branch, or multi-instance, single-branch. This tutorial covers both patterns. + +--8<-- "_snippets/source-control-environments/one-direction.md" + +### Multiple instances, multiple branches + +![Diagram](/_images/source-control-environments/vc-multi-multi.png) + +--8<-- "_snippets/source-control-environments/multi-instance-multi-branch-pros-cons.md" + + +### Multiple instances, one branch + +![Diagram](/_images/source-control-environments/vc-multi-one.png) + +--8<-- "_snippets/source-control-environments/multi-instance-one-branch-pros-cons.md" + +## Set up your repository + +Once you've chosen your pattern, you need to set up your GitHub repository. + +=== "Multi-branch" + + 1. [Create a new repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository){:target=_blank .external-link}. + * Make sure the repository is private, unless you want your workflows, tags, and variable and credential stubs exposed to the internet. + * Create the new repository with a README so you can immediately create branches. + 1. Create one branch named `production` and another named `development`. Refer to [Creating and deleting branches within your repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository){:target=_blank .external-link} for guidance. + + +=== "Single-branch" + + [Create a new repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository){:target=_blank .external-link}. + + * Make sure the repository is private, unless you want your workflows, tags, and variable and credential stubs exposed to the internet. + * Create the new repository with a README. This creates the `main` branch, which you'll connect to. + + +## Connect your n8n instances to your repository + +Create two n8n instances, one for development, one for production. + +### Configure Git in n8n + +--8<-- "_snippets/source-control-environments/configure-git-in-n8n.md" + +### Set up a deploy key + +Set up SSH access by creating a deploy key for the repository using the SSH key from n8n. The key must have write access. Refer to [GitHub | Managing deploy keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys){:target=_blank .external-link} for guidance. + +### Connect n8n and configure your instance + +=== "Multi-branch" + + 1. In **Settings** > **Environments** in n8n, select **Connect**. n8n connects to your Git repository. + 1. Under **Instance settings**, choose which branch you want to use for the current n8n instance. Connect the production branch to the production instance, and the development branch to the development instance. + 1. Production instance only: select **Protected instance** to prevent users editing workflows in this instance. + 1. Select **Save settings**. + +=== "Single-branch" + + 1. In **Settings** > **Environments** in n8n, select **Connect**. + 1. Under **Instance settings**, select the main branch. + 1. Production instance only: select **Protected instance** to prevent users editing workflows in this instance. + 1. Select **Save settings**. + +## Push work from development + +In your development instance, create a few workflows, tags, variables, and credentials. + +--8<-- "_snippets/source-control-environments/push.md" + +## Pull work to production + +Your work is now in GitHub. If you're using a multi-branch setup, it's on the development branch. If you chose the single-branch setup, it's on main. + +=== "Multi-branch" + + 1. In GitHub, create a pull request to merge development into production. + 1. Merge the pull request. + 1. In your production instance, select **Pull** ![Pull icon](/_images/source-control-environments/pull-icon.png){.off-glb} in the main menu. + +=== "Single-branch" + + In your production instance, select **Pull** ![Pull icon](/_images/source-control-environments/pull-icon.png){.off-glb} in the main menu. + +--8<-- "_snippets/source-control-environments/push-pull-menu-state.md" + +### Optional: Use a GitHub Action to automate pulls + +If you want to avoid logging in to your production instance to pull, you can use a [GitHub Action](https://docs.github.com/en/actions/creating-actions/about-custom-actions){:target=_blank .external-link} and the [n8n API](/api/index.md) to automatically pull every time you push new work to your production or main branch. + +--8<-- "_snippets/source-control-environments/github-action.md" + + +## Next steps + +Learn more about: + +* [Environments in n8n](/source-control-environments/understand/environments.md) and [Git and n8n](/source-control-environments/understand/git.md) +* [Source control patterns](/source-control-environments/understand/patterns.md) + + +# docs/source-control-environments/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Source control and environments +description: Overview of source control and environments in n8n +contentType: overview +hide: + - toc +--- + +# Source control and environments + +--8<-- "_snippets/source-control-environments/feature-availability.md" + +n8n 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. + +In this section: + +* [Understand](/source-control-environments/understand/index.md): + * [Environments in n8n](/source-control-environments/understand/environments.md): The purpose of environments, and how they work in n8n. + * [Git and n8n](/source-control-environments/understand/git.md): How n8n uses Git. + * [Branch patterns](/source-control-environments/understand/patterns.md): The possible relationships between n8n instances and Git branches. +* [Set up source control for environments](/source-control-environments/setup.md): How to connect your n8n instance to Git. +* [Using](/source-control-environments/using/index.md): + * [Push and pull](/source-control-environments/using/push-pull.md): Send work to Git, and fetch work from Git to your instance. + * [Copy work between environments](/source-control-environments/using/copy-work.md): How to copy work between different n8n instances. +* [Tutorial: Create environments with source control](/source-control-environments/create-environments.md): An end-to-end tutorial, setting up environments using n8n's recommended configurations. + +Related sections: + +* [Variables](/code/variables.md): reusable values. +* [External secrets](/external-secrets.md): manage [credentials](/glossary.md#credential-n8n) with an external secrets vault. + + +# docs/source-control-environments/setup.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Set up source control +description: Link n8n to your Git provider. +contentType: howto +--- + +# Set up source control for environments + +Link a Git repository to an n8n instance and configure your source control. + +n8n uses source control to provide environments. Refer to [Environments in n8n](/source-control-environments/understand/environments.md) for more information. + +## Prerequisites + +To use source control with n8n, you need a Git repository that allows SSH access. + +This document assumes you are familiar with Git and your Git provider. + +## Step 1: Set up your repository and branches + +For a new setup: + +1. Create a new repository for use with n8n. +1. Create the branches you need. For example, if you plan to have different environments for test and production, set up a branch for each. + +To help decide what branches you need for your use case, refer to [Branch patterns](/source-control-environments/understand/patterns.md). + +## Step 2: Configure Git in n8n + +--8<-- "_snippets/source-control-environments/configure-git-in-n8n.md" + +## Step 3: Set up a deploy key + +Set up SSH access by creating a deploy key for the repository using the SSH key from n8n. The key must have write access. + +The steps depend on your Git provider. Help links for common providers: + +* [GitHub | Managing deploy keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys){:target=_blank .external-link} +* [GitLab | Deploy keys](https://docs.gitlab.com/ee/user/project/deploy_keys/){:target=_blank .external-link} + +## Step 4: Connect n8n and configure your instance + +1. In **Settings** > **Environments** in n8n, select **Connect**. n8n connects to your Git repository. +1. Under **Instance settings**, choose which branch you want to use for the current n8n instance. +1. **Optional**: select **Protected instance** to prevent users editing workflows in this instance. This is useful for protecting production instances. +1. **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. +1. Select **Save settings**. + + + +# docs/source-control-environments/using/copy-work.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Copy work between environments +description: How to get changes from one environment into another. +contentType: howto +--- + +# Copy work between environments + +The steps to send work from one n8n instance to another are different depending on whether you use a single Git branch or multiple branches. + +## Single branch + +If you have a single Git branch the steps to copy work are: + +1. Push work from one instance to the Git branch. +1. Log in to the other instance to pull the work from Git. You can [automate pulls](#automatically-send-changes-to-n8n). + +## Multiple branches + +If you have more than one Git branch, you need to merge the branches in your Git provider to copy work between environments. You can't copy work directly between environments in n8n. + +A common pattern is: + +1. Do work in your developments instance. +1. Push the work to the development branch in Git. +1. Merge your development branch into your production branch. Refer to the documentation for your Git provider for guidance on doing this: + * [GitHub: Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request){:target=_blank .external-link} + * [GitLab: Creating merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html){:target=_blank .external-link} + * [Git: Basic branching and merging](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging){:target=_blank .external-link} +1. In your production n8n instance, pull the changes. You can [automate pulls](#automatically-send-changes-to-n8n). + +## Automatically send changes to n8n + +You can automate parts of the process of copying work, using the `/source-control/pull` API endpoint. Call the API after merging the changes: + +```curl +curl --request POST \ + --location '/api/v1/source-control/pull' \ + --header 'Content-Type: application/json' \ + --header 'X-N8N-API-KEY: ' \ + --data '{"force": true}' +``` + +This means you can use a GitHub Action or GitLab CI/CD to automatically pull changes to the production instance on merge. + +--8<-- "_snippets/source-control-environments/github-action.md" + + + +# docs/source-control-environments/using/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Using source control and environments +description: How to use source control and environments in n8n. +contentType: overview +hide: + - toc +--- + +# Using source control and environments + +--8<-- "_snippets/source-control-environments/feature-availability.md" + +* [Push and pull](/source-control-environments/using/push-pull.md): Send work to Git, and fetch work from Git to your instance. Understand what gets committed, and how n8n handles merge conflicts. +* [Copy work between environments](/source-control-environments/using/copy-work.md): How to copy work between different n8n instances. + + +# docs/source-control-environments/using/push-pull.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Push and pull +description: Send work to Git, and fetch work from Git to your instance. +contentType: howto +--- + +# Push and pull + +If your n8n instance connects to a Git repository, you need to keep your work in sync with Git. + +This document assumes some familiarity with Git concepts and terminology. Refer to [Git and n8n](/source-control-environments/understand/git.md) for an introduction to how n8n works with Git. + +--8<-- "_snippets/source-control-environments/one-direction.md" + +## Fetch other people's work + +/// note | Restricted feature +Not all users can fetch changes from Git. You must be an n8n instance owner or admin to push or pull changes. +/// +To pull work from Git, select **Pull** ![Pull icon](/_images/source-control-environments/pull-icon.png){.off-glb} in the main menu. + +--8<-- "_snippets/source-control-environments/push-pull-menu-state.md" + +n8n may display a warning about overriding local changes. Select **Pull and override** to override your local work with the content in Git. + +When the changes include new variable or credential stubs, n8n notifies you that you need to populate the values for the items before using them. + +/// info | How deleted resources are handled +When 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. +/// + +### Workflow and credential owner may change on pull + +When you pull from Git to an n8n instance, n8n tries to assign workflows and credentials to a matching user or project. + +If the original owner is a user: + +If 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. + +If the original owner is a [project](/user-management/rbac/index.md): + +n8n 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. + +### Pulling may cause brief service interruption + +If 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. + +## Send your work to Git + +/// note | Restricted feature +Ordinary users can't send work to Git. You must be an n8n instance owner, admin, or project owner to send work to Git. +/// + +--8<-- "_snippets/source-control-environments/push.md" + +## What gets committed + +n8n commits the following to Git: + +* Workflows, including their tags and the email address of the workflow owner. You can choose which workflows to push. +* Credential stubs (ID, name, type) +* Variable stubs (ID and name) +* Projects +* Folders + +## Merge behaviors and conflicts + +n8n's implementation of source control is opinionated. It resolves merge conflicts for credentials and variables automatically. n8n can't detect conflicts on workflows. + +### Workflows + +You have to explicitly tell n8n what to do about workflows when pushing or pulling. The Git repository acts as the source of truth. + +When 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. + +When 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. + +To 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. + +To avoid losing data: + +* 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. +* Don't push all workflows. Select the ones you need. +* Be cautious about manually editing files in the Git repository. + +### Credentials, variables and workflow tags + +Credentials and variables can't have merge issues, as n8n chooses the version to keep. + +On pull: + +* If the tag, variable or credential doesn't exist, n8n creates it. +* If the tag, variable or credential already exists, n8n doesn't update it, unless: + * You set the value of a variable using the API or externally. The new value overwrites any existing value. + * The credential name has changed. n8n uses the version in Git. + * 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. + +On push: + +* n8n overwrites the entire variables and tags files. +* If a credential already exists, n8n overwrites it with the changes, but doesn't apply these changes to existing credentials on pull. + +/// note | Manage credentials with an external secrets vault +If you need different credentials on different n8n environments, use [external secrets](/external-secrets.md). +/// + + +# docs/source-control-environments/understand/environments.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Environments in n8n +description: Understand the concepts behind environments in n8n. +contentType: explanation +--- + +# Environments in n8n + +n8n has built its environments feature on top of Git, a version control software. This document helps you understand: + +* The purpose of environments. +* How environments work in n8n. + +## Environments: What and why + +In 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){:target=_blank .external-link}. + +Low-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](/hosting/configuration/configuration-methods.md). 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. + +There are advantages to having more than one environment. A common pattern is to have different environments for development and production: + +* Development: do work and make changes. +* Production: the live environment. + +A setup like this helps you make changes to workflows without breaking workflows that are in use. + +## Environments in n8n + +In n8n, an environment comprises two parts, an n8n instance and a Git branch: + +* The n8n instance is where you build and run workflows. +* The Git branch stores copies of the workflows, as well as tags, and variable and credential stubs. + +n8n 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](/source-control-environments/using/push-pull.md#what-gets-committed). + +How you copy work between environments depends on your branch and n8n instance configuration: + +* Multiple instances, one branch: you can push from one instance to the Git branch, then pull the work to another instance. +* 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](/source-control-environments/using/copy-work.md) for more information, including steps to partially automate the process. + +For detailed guidance on pushing and pulling work, refer to [Push and pull](/source-control-environments/using/push-pull.md). + +Refer to [Set up source control](/source-control-environments/setup.md) to learn more about linking your n8n instance to Git, or follow the [Tutorial: Create environments with source control](/source-control-environments/create-environments.md) to set up your environments using one of n8n's recommended configurations. + + +# docs/source-control-environments/understand/git.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Git and n8n +description: Git concepts and limitations in n8n. +contentType: explanation +--- + +# Git and n8n + +n8n 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. + + +/// note | New to Git and source control? +If 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. +/// +/// note | Familiar with Git and source control? +If 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. +/// + +This 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](/source-control-environments/setup.md) should have some familiarity with Git and with their Git hosting provider. + +/// note | This is a brief introduction +Git 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){:target=_blank .external-link}. +/// +## Git overview + +[Git](https://git-scm.com/){:target=_blank .external-link} 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/){:target=_blank .external-link} and [GitLab](https://about.gitlab.com/){:target=_blank .external-link}. + +## Branches: Multiple copies of a project + +Git 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. + +![Diagram](/_images/source-control-environments/simple-git-branch.png) + +## Local and remote: Moving work between your machine and a Git provider + +A 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. + +n8n 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. + +## Push, pull, and commit + +n8n uses three key Git processes: + +* **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. +* **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. + + /// warning | Pulling overwrites your work + 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. + /// + +* **Commit**: a commit in n8n is a single occurrence of pushing work to Git. In n8n, commit and push happen at the same time. + +Refer to [Push and pull](/source-control-environments/using/push-pull.md) for detailed information about how n8n interacts with Git. + + +# docs/source-control-environments/understand/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Understand source control and environments +description: Understand how source control and environments work in n8n. +contentType: overview +hide: + - toc +--- + +# Understand source control and environments + +--8<-- "_snippets/source-control-environments/feature-availability.md" + +* [Environments in n8n](/source-control-environments/understand/environments.md): The purpose of environments, and how they work in n8n. +* [Git in n8n](/source-control-environments/understand/git.md): How n8n uses Git. +* [Branch patterns](/source-control-environments/understand/patterns.md): The possible relationships between n8n instances and Git branches. + + +# docs/source-control-environments/understand/patterns.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Branch patterns +description: Understand the different relationships between n8n instances and Git branches that are possible with source control. +contentType: explanation +--- + +# Branch patterns + +The relationship between n8n instances and Git branches is flexible. You can create different setups depending on your needs. + +--8<-- "_snippets/source-control-environments/one-direction.md" + +## Multiple instances, multiple branches + +This pattern involves having multiple n8n instances, each one linked to its own branch. + +You 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. + +--8<-- "_snippets/source-control-environments/multi-instance-multi-branch-pros-cons.md" + +![Diagram](/_images/source-control-environments/vc-multi-multi.png) + +## Multiple instances, one branch + +Use this pattern if you want the same workflows, tags, and variables everywhere, but want to use them in different n8n instances. + +You 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. + +This 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. + +--8<-- "_snippets/source-control-environments/multi-instance-one-branch-pros-cons.md" + +![Diagram](/_images/source-control-environments/vc-multi-one.png) + +## One instance, multiple branches + +The 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. + +This 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. + +/// note | No cleanup +n8n 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. +/// +![Diagram](/_images/source-control-environments/vc-one-multi.png) + +## One instance, one branch + +This is the simplest pattern. + +![Diagram](/_images/source-control-environments/vc-one-one.png) + + +# docs/integrations/custom-operations.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Custom API operations + +--8<-- "_snippets/integrations/credential-only-intro.md" + +## Predefined credential types + +A predefined credential type is a credential that already exists in n8n. You can use predefined credential types instead of generic credentials in the HTTP Request node. + +For example: you create an Asana credential, for use with the Asana node. Later, you want to perform an operation that isn't supported by the Asana node, using Asana's API. You can use your existing Asana credential in the HTTP Request node to perform the operation, without additional authentication setup. + +### Using predefined credential types + +--8<-- "_snippets/integrations/predefined-credential-type-how-to.md" + + +### Credential scopes + +Some existing credential types have specific scopes: endpoints that they work with. n8n warns you about this when you select the credential type. + +For example, follow the steps in [Using predefined credential types](#using-predefined-credential-types), and select **Google Calendar OAuth2 API** as your **Credential Type**. n8n displays a box listing the two endpoints you can use this credential type with: + +![The scopes box](/_images/integrations/custom-operations/scopes.png) + + + +# docs/integrations/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: n8n Integrations Documentation and Guides +description: Access n8n integrations documentation and guides. Find comprehensive resources to help you master app integrations using different types of nodes to improve your automation workflows. +contentType: overview +--- + +# Integrations + +n8n calls integrations nodes. + +Nodes 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. + +## Built-in nodes + +n8n includes a collection of built-in integrations. Refer to [Built-in nodes](/integrations/builtin/node-types.md) for documentation on all n8n's built-in nodes. + +## Community nodes + +As well as using the built-in nodes, you can also install community-built nodes. Refer to [Community nodes](/integrations/community-nodes/installation/index.md) for more information. + +## Credential-only nodes and custom operations + +--8<-- "_snippets/integrations/credential-only-intro.md" + +Refer to [Custom operations](/integrations/custom-operations.md) for more information. + +## Generic integrations + +If 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](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/index.md) node. Refer to the node page for details on how to set up authentication and create your API call. + +## Where to go next + +* If you want to create your own node, head over to the [Creating Nodes](/integrations/creating-nodes/overview.md) section. +* Check out [Community nodes](/integrations/community-nodes/usage.md) to learn about installing and managing community-built nodes. +* 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](/integrations/builtin/core-nodes/index.md), [Actions](/integrations/builtin/app-nodes/index.md), and [Triggers](/integrations/builtin/trigger-nodes/index.md). +* If you'd like to learn how to add the credentials for the different nodes, head over to the [Credentials](/integrations/builtin/credentials/index.md) section. + + +# docs/integrations/creating-nodes/overview.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Creating nodes + +Learn how to build your own custom [nodes](/glossary.md#node-n8n). + +This section includes: + +* Guidance on planning your build, including [which style to use](/integrations/creating-nodes/plan/choose-node-method.md). +* [Tutorials](/integrations/creating-nodes/build/index.md) for different node building styles. +* Instructions for [testing your node](/integrations/creating-nodes/test/index.md), including how to use the n8n [node linter](/integrations/creating-nodes/test/node-linter.md) and [troubleshooting](/integrations/creating-nodes/test/troubleshooting-node-development.md) support. +* How to [share your node](/integrations/creating-nodes/deploy/submit-community-nodes.md) with the community, submit it for [verification by n8n](/integrations/creating-nodes/deploy/submit-community-nodes.md), or use it as a [private node](/integrations/creating-nodes/deploy/install-private-nodes.md). +* [Reference material](/integrations/creating-nodes/build/reference/index.md), including UI elements and information on the individual files that make up a node. + +## Prerequisites + +This section assumes the following: + +* Some familiarity with JavaScript and TypeScript. +* Ability to manage your own development environment, including git. +* Knowledge of npm, including creating and submitting packages. +* Familiarity with n8n, including a good understanding of [data structures](/data/data-structure.md) and [item linking](/data/data-mapping/data-item-linking/index.md). + + +# docs/integrations/creating-nodes/build/declarative-style-node.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Build a declarative-style node + +This tutorial walks through building a declarative-style node. Before you begin, make sure this is the node style you need. Refer to [Choose your node building approach](/integrations/creating-nodes/plan/choose-node-method.md) for more information. + +## Prerequisites + +You need the following installed on your development machine: + +--8<-- "_snippets/integrations/creating-nodes/prerequisites.md" + +You need some understanding of: + +- JavaScript/TypeScript +- REST APIs +- git + +## Build your node + +In this section, you'll clone n8n's node starter repository, and build a node that integrates the [NASA API](https://api.nasa.gov/){:target=_blank .external-link}. You'll create a node that uses two of NASA's services: APOD (Astronomy Picture of the Day) and Mars Rover Photos. To keep the code examples short, the node won't implement every available option for the Mars Rover Photos endpoint. + +/// note | Existing node +n8n has a built-in NASA node. To avoid clashing with the existing node, you'll give your version a different name. +/// +### Step 1: Set up the project + + +n8n provides a starter repository for node development. Using the starter ensures you have all necessary dependencies. It also provides a linter. + +Clone the repository and navigate into the directory: + +1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate) from the template repository. +2. Clone your new repository: + ```shell + git clone https://github.com//.git n8n-nodes-nasa-pics + cd n8n-nodes-nasa-pics + ``` + +The starter contains example nodes and credentials. Delete the following directories and files: + +* `nodes/ExampleNode` +* `nodes/HTTPBin` +* `credentials/ExampleCredentials.credentials.ts` +* `credentials/HttpBinApi.credentials.ts` + +Now create the following directories and files: + +`nodes/NasaPics` +`nodes/NasaPics/NasaPics.node.json` +`nodes/NasaPics/NasaPics.node.ts` +`credentials/NasaPicsApi.credentials.ts` + +These are the key files required for any node. Refer to [Node file structure](/integrations/creating-nodes/build/reference/node-file-structure.md) for more information on required files and recommended organization. + +Now install the project dependencies: + +```shell +npm i +``` + +### Step 2: Add an icon + +Save the NASA SVG logo from [here](https://upload.wikimedia.org/wikipedia/commons/e/e5/NASA_logo.svg){:target=_blank .external-link} as `nasapics.svg` in `nodes/NasaPics/`. + + +--8<-- "_snippets/integrations/creating-nodes/node-icons.md" + + +### Step 3: Create the node + +Every node must have a base file. Refer to [Node base file](/integrations/creating-nodes/build/reference/node-base-files/index.md) for detailed information about base file parameters. + +In this example, the file is `NasaPics.node.ts`. To keep this tutorial short, you'll place all the node functionality in this one file. When building more complex nodes, you should consider splitting out your functionality into modules. Refer to [Node file structure](/integrations/creating-nodes/build/reference/node-file-structure.md) for more information. + +#### Step 3.1: Imports + +Start by adding the import statements: + +```typescript +import { INodeType, INodeTypeDescription } from 'n8n-workflow'; +``` + +#### Step 3.2: Create the main class + +The node must export an interface that implements INodeType. This interface must include a `description` interface, which in turn contains the `properties` array. + +/// note | Class names and file names +Make sure the class name and the file name match. For example, given a class `NasaPics`, the filename must be `NasaPics.node.ts`. +/// +```typescript +export class NasaPics implements INodeType { + description: INodeTypeDescription = { + // Basic node details will go here + properties: [ + // Resources and operations will go here + ] + }; +} +``` + +#### Step 3.3: Add node details + +All nodes need some basic parameters, such as their display name, icon, and the basic information for making a request using the node. Add the following to the `description`: + +```typescript +displayName: 'NASA Pics', +name: 'NasaPics', +icon: 'file:nasapics.svg', +group: ['transform'], +version: 1, +subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', +description: 'Get data from NASAs API', +defaults: { + name: 'NASA Pics', +}, +inputs: ['main'], +outputs: ['main'], +credentials: [ + { + name: 'NasaPicsApi', + required: true, + }, +], +requestDefaults: { + baseURL: 'https://api.nasa.gov', + headers: { + Accept: 'application/json', + 'Content-Type': 'application/json', + }, +}, +``` + +n8n uses some of the properties set in `description` to render the node in the Editor UI. These properties are `displayName`, `icon`, `description`, and `subtitle`. + +#### Step 3.4: Add resources + +The resource object defines the API resource that the node uses. In this tutorial, you're creating a node to access two of NASA's API endpoints: `planetary/apod` and `mars-photos`. This means you need to define two resource options in `NasaPics.node.ts`. Update the `properties` array with the resource object: + +```typescript +properties: [ + { + displayName: 'Resource', + name: 'resource', + type: 'options', + noDataExpression: true, + options: [ + { + name: 'Astronomy Picture of the Day', + value: 'astronomyPictureOfTheDay', + }, + { + name: 'Mars Rover Photos', + value: 'marsRoverPhotos', + }, + ], + default: 'astronomyPictureOfTheDay', + }, + // Operations will go here + +] +``` + +`type` controls which UI element n8n displays for the resource, and tells n8n what type of data to expect from the user. `options` results in n8n adding a dropdown that allows users to choose one option. Refer to [Node UI elements](/integrations/creating-nodes/build/reference/ui-elements.md) for more information. + +#### Step 3.5: Add operations + +The operations object defines the available operations on a resource. + +In a declarative-style node, the operations object includes `routing` (within the `options` array). This sets up the details of the API call. + +Add the following to the `properties` array, after the `resource` object: + +```typescript +{ + displayName: 'Operation', + name: 'operation', + type: 'options', + noDataExpression: true, + displayOptions: { + show: { + resource: [ + 'astronomyPictureOfTheDay', + ], + }, + }, + options: [ + { + name: 'Get', + value: 'get', + action: 'Get the APOD', + description: 'Get the Astronomy Picture of the day', + routing: { + request: { + method: 'GET', + url: '/planetary/apod', + }, + }, + }, + ], + default: 'get', +}, +{ + displayName: 'Operation', + name: 'operation', + type: 'options', + noDataExpression: true, + displayOptions: { + show: { + resource: [ + 'marsRoverPhotos', + ], + }, + }, + options: [ + { + name: 'Get', + value: 'get', + action: 'Get Mars Rover photos', + description: 'Get photos from the Mars Rover', + routing: { + request: { + method: 'GET', + }, + }, + }, + ], + default: 'get', +}, +{ + displayName: 'Rover name', + description: 'Choose which Mars Rover to get a photo from', + required: true, + name: 'roverName', + type: 'options', + options: [ + {name: 'Curiosity', value: 'curiosity'}, + {name: 'Opportunity', value: 'opportunity'}, + {name: 'Perseverance', value: 'perseverance'}, + {name: 'Spirit', value: 'spirit'}, + ], + routing: { + request: { + url: '=/mars-photos/api/v1/rovers/{{$value}}/photos', + }, + }, + default: 'curiosity', + displayOptions: { + show: { + resource: [ + 'marsRoverPhotos', + ], + }, + }, +}, +{ + displayName: 'Date', + description: 'Earth date', + required: true, + name: 'marsRoverDate', + type: 'dateTime', + default:'', + displayOptions: { + show: { + resource: [ + 'marsRoverPhotos', + ], + }, + }, + routing: { + request: { + // You've already set up the URL. qs appends the value of the field as a query string + qs: { + earth_date: '={{ new Date($value).toISOString().substr(0,10) }}', + }, + }, + }, +}, +// Optional/additional fields will go here +``` + +This code creates two operations: one to get today's APOD image, and another to send a get request for photos from one of the Mars Rovers. The object named `roverName` requires the user to choose which Rover they want photos from. The `routing` object in the Mars Rover operation references this to create the URL for the API call. + +#### Step 3.6: Optional fields + +Most APIs, including the NASA API that you're using in this example, have optional fields you can use to refine your query. + +To avoid overwhelming users, n8n displays these under **Additional Fields** in the UI. + +For this tutorial, you'll add one additional field, to allow users to pick a date to use with the APOD endpoint. Add the following to the properties array: + +```typescript +{ + displayName: 'Additional Fields', + name: 'additionalFields', + type: 'collection', + default: {}, + placeholder: 'Add Field', + displayOptions: { + show: { + resource: [ + 'astronomyPictureOfTheDay', + ], + operation: [ + 'get', + ], + }, + }, + options: [ + { + displayName: 'Date', + name: 'apodDate', + type: 'dateTime', + default: '', + routing: { + request: { + // You've already set up the URL. qs appends the value of the field as a query string + qs: { + date: '={{ new Date($value).toISOString().substr(0,10) }}', + }, + }, + }, + }, + ], +} +``` + + +### Step 4: Set up authentication + +The NASA API requires users to authenticate with an API key. + +Add the following to `nasaPicsApi.credentials.ts`: + +```typescript +import { + IAuthenticateGeneric, + ICredentialType, + INodeProperties, +} from 'n8n-workflow'; + +export class NasaPicsApi implements ICredentialType { + name = 'NasaPicsApi'; + displayName = 'NASA Pics API'; + // Uses the link to this tutorial as an example + // Replace with your own docs links when building your own nodes + documentationUrl = 'https://docs.n8n.io/integrations/creating-nodes/build/declarative-style-node/'; + properties: INodeProperties[] = [ + { + displayName: 'API Key', + name: 'apiKey', + type: 'string', + default: '', + }, + ]; + authenticate = { + type: 'generic', + properties: { + qs: { + 'api_key': '={{$credentials.apiKey}}' + } + }, + } as IAuthenticateGeneric; +} +``` + +For more information about credentials files and options, refer to [Credentials file](/integrations/creating-nodes/build/reference/credentials-files.md). + + +### Step 5: Add node metadata + +Metadata about your node goes in the JSON file at the root of your node. n8n refers to this as the codex file. In this example, the file is `NasaPics.node.json`. + +Add the following code to the JSON file: + +```json +{ + "node": "n8n-nodes-base.NasaPics", + "nodeVersion": "1.0", + "codexVersion": "1.0", + "categories": [ + "Miscellaneous" + ], + "resources": { + "credentialDocumentation": [ + { + "url": "" + } + ], + "primaryDocumentation": [ + { + "url": "" + } + ] + } +} +``` + +For more information on these parameters, refer to [Node codex files](/integrations/creating-nodes/build/reference/node-codex-files.md). + +### Step 6: Update the npm package details + +Your npm package details are in the `package.json` at the root of the project. It's essential to include the `n8n` object with links to the credentials and base node file. Update this file to include the following information: + +```json +{ + // All node names must start with "n8n-nodes-" + "name": "n8n-nodes-nasapics", + "version": "0.1.0", + "description": "n8n node to call NASA's APOD and Mars Rover Photo services.", + "keywords": [ + // This keyword is required for community nodes + "n8n-community-node-package" + ], + "license": "MIT", + "homepage": "https://n8n.io", + "author": { + "name": "Test", + "email": "test@example.com" + }, + "repository": { + "type": "git", + // Change the git remote to your own repository + // Add the new URL here + "url": "git+" + }, + "main": "index.js", + "scripts": { + // don't change + }, + "files": [ + "dist" + ], + // Link the credentials and node + "n8n": { + "n8nNodesApiVersion": 1, + "credentials": [ + "dist/credentials/NasaPicsApi.credentials.js" + ], + "nodes": [ + "dist/nodes/NasaPics/NasaPics.node.js" + ] + }, + "devDependencies": { + // don't change + }, + "peerDependencies": { + // don't change + } +} +``` + +You need to update the `package.json` to include your own information, such as your name and repository URL. For more information on npm `package.json` files, refer to [npm's package.json documentation](https://docs.npmjs.com/cli/v8/configuring-npm/package-json){:target=_blank .external-link}. + +## Test your node + +--8<-- "_snippets/integrations/creating-nodes/testing.md" + +## Next steps + +* [Deploy your node](/integrations/creating-nodes/deploy/index.md). +* View an example of a declarative node: n8n's [Brevo node](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Brevo){:target=_blank .external-link}. Note that the main node is declarative, while the trigger node is in programmatic style. +* Learn about [node versioning](/integrations/creating-nodes/build/reference/node-versioning.md). + + + +# docs/integrations/creating-nodes/build/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Build a node + +This section provides tutorials on building nodes. It covers: + +* [Tutorial: Build a declarative-style node](/integrations/creating-nodes/build/declarative-style-node.md) +* [Reference](/integrations/creating-nodes/build/reference/index.md) material on [file structure](/integrations/creating-nodes/build/reference/node-file-structure.md), parameter definitions for [base](/integrations/creating-nodes/build/reference/node-base-files/index.md), [codex](/integrations/creating-nodes/build/reference/node-codex-files.md), and [credentials](/integrations/creating-nodes/build/reference/credentials-files.md) files, [node UI elements](/integrations/creating-nodes/build/reference/ui-elements.md), and more. + +Coming soon: + +* More tutorials +* Revised guidance on standards + + + + + + +# docs/integrations/creating-nodes/build/node-development-environment.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Set up your development environment + +This document lists the essential dependencies for developing a node, as well as guidance on setting up your editor. + +## Requirements + +To build and test a node, you need: + +* Node.js and npm. Minimum version Node 18.17.0. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL (Windows Subsystem for Linux) [here](https://github.com/nvm-sh/nvm){:target=_blank class=.external-link}. For Windows users, refer to Microsoft's guide to [Install NodeJS on Windows](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows){:target=_blank class=.external-link}. +* A local instance of n8n. You can install n8n with `npm install n8n -g`, then follow the steps in [Run your node locally](/integrations/creating-nodes/test/run-node-locally.md) to test your node. + +You should also have [git](https://git-scm.com/){:target=_blank class=.external-link} installed. This allows you to clone and use the [n8n-node-starter](https://github.com/n8n-io/n8n-nodes-starter){:target=_blank class=.external-link}. + +## Editor setup + +n8n recommends using [VS Code](https://code.visualstudio.com/){:target=_blank class=.external-link} as your editor. + +Install these extensions: + +* [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint){:target=_blank class=.external-link} +* [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig){:target=_blank class=.external-link} +* [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode){:target=_blank class=.external-link} + +By using VS Code and these extensions, you get access to the n8n node linter's warnings as you code. + + +# docs/integrations/creating-nodes/build/programmatic-style-node.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: tutorial +--- + +# Build a programmatic-style node + +This tutorial walks through building a programmatic-style node. Before you begin, make sure this is the node style you need. Refer to [Choose your node building approach](/integrations/creating-nodes/plan/choose-node-method.md) for more information. + +## Prerequisites + +You need the following installed on your development machine: + +--8<-- "_snippets/integrations/creating-nodes/prerequisites.md" + +You need some understanding of: + +- JavaScript/TypeScript +- REST APIs +- git +- [Expressions](/glossary.md#expression-n8n) in n8n + + +## Build your node + +In this section, you'll clone n8n's node starter repository, and build a node that integrates the [SendGrid](https://sendgrid.com/){:target=_blank .external-link}. You'll create a node that implements one piece of SendGrid functionality: create a contact. + +/// note | Existing node +n8n has a built-in SendGrid node. To avoid clashing with the existing node, you'll give your version a different name. +/// +### Step 1: Set up the project + +n8n provides a starter repository for node development. Using the starter ensures you have all necessary dependencies. It also provides a linter. + +Clone the repository and navigate into the directory: + +1. [Generate a new repository](https://github.com/n8n-io/n8n-nodes-starter/generate){:target=_blank .external-link} from the template repository. +2. Clone your new repository: + ```shell + git clone https://github.com//.git n8n-nodes-friendgrid + cd n8n-nodes-friendgrid + ``` + +The starter contains example nodes and credentials. Delete the following directories and files: + +* `nodes/ExampleNode` +* `nodes/HTTPBin` +* `credentials/ExampleCredentials.credentials.ts` +* `credentials/HttpBinApi.credentials.ts` + +Now create the following directories and files: + +`nodes/FriendGrid` +`nodes/FriendGrid/FriendGrid.node.json` +`nodes/FriendGrid/FriendGrid.node.ts` +`credentials/FriendGridApi.credentials.ts` + +These are the key files required for any node. Refer to [Node file structure](/integrations/creating-nodes/build/reference/node-file-structure.md) for more information on required files and recommended organization. + +Now install the project dependencies: + +```shell +npm i +``` + +### Step 2: Add an icon + +Save the SendGrid SVG logo from [here](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/SendGrid/sendGrid.svg){:target=_blank .external-link} as `friendGrid.svg` in `nodes/FriendGrid/`. + + +--8<-- "_snippets/integrations/creating-nodes/node-icons.md" + + +### Step 3: Define the node in the base file + +Every node must have a base file. Refer to [Node base file](/integrations/creating-nodes/build/reference/node-base-files/index.md) for detailed information about base file parameters. + +In this example, the file is `FriendGrid.node.ts`. To keep this tutorial short, you'll place all the node functionality in this one file. When building more complex nodes, you should consider splitting out your functionality into modules. Refer to [Node file structure](/integrations/creating-nodes/build/reference/node-file-structure.md) for more information. + +#### Step 3.1: Imports + +Start by adding the import statements: + +```typescript +import { + IExecuteFunctions, +} from 'n8n-core'; + +import { + IDataObject, + INodeExecutionData, + INodeType, + INodeTypeDescription, +} from 'n8n-workflow'; + +import { + OptionsWithUri, +} from 'request'; +``` + +#### Step 3.2: Create the main class + +The node must export an interface that implements `INodeType`. This interface must include a `description` interface, which in turn contains the `properties` array. + +/// note | Class names and file names +Make sure the class name and the file name match. For example, given a class `FriendGrid`, the filename must be `FriendGrid.node.ts`. +/// +```typescript +export class FriendGrid implements INodeType { + description: INodeTypeDescription = { + // Basic node details will go here + properties: [ + // Resources and operations will go here + ], + }; + // The execute method will go here + async execute(this: IExecuteFunctions): Promise { + } +} +``` + +#### Step 3.3: Add node details + +All programmatic nodes need some basic parameters, such as their display name and icon. Add the following to the `description`: + +```typescript +displayName: 'FriendGrid', +name: 'friendGrid', +icon: 'file:friendGrid.svg', +group: ['transform'], +version: 1, +description: 'Consume SendGrid API', +defaults: { + name: 'FriendGrid', +}, +inputs: ['main'], +outputs: ['main'], +credentials: [ + { + name: 'friendGridApi', + required: true, + }, +], +``` + +n8n uses some of the properties set in `description` to render the node in the Editor UI. These properties are `displayName`, `icon`, and `description`. + +#### Step 3.4: Add the resource + +The resource object defines the API resource that the node uses. In this tutorial, you're creating a node to access one of SendGrid's API endpoints: `/v3/marketing/contacts`. This means you need to define a resource for this endpoint. Update the `properties` array with the resource object: + +```typescript +{ + displayName: 'Resource', + name: 'resource', + type: 'options', + options: [ + { + name: 'Contact', + value: 'contact', + }, + ], + default: 'contact', + noDataExpression: true, + required: true, + description: 'Create a new contact', +}, +``` + +`type` controls which UI element n8n displays for the resource, and tells n8n what type of data to expect from the user. `options` results in n8n adding a dropdown that allows users to choose one option. Refer to [Node UI elements](/integrations/creating-nodes/build/reference/ui-elements.md) for more information. + +#### Step 3.5: Add operations + +The operations object defines what you can do with a resource. It usually relates to REST API verbs (GET, POST, and so on). In this tutorial, there's one operation: create a contact. It has one required field, the email address for the contact the user creates. + +Add the following to the `properties` array, after the `resource` object: + +```typescript +{ + displayName: 'Operation', + name: 'operation', + type: 'options', + displayOptions: { + show: { + resource: [ + 'contact', + ], + }, + }, + options: [ + { + name: 'Create', + value: 'create', + description: 'Create a contact', + action: 'Create a contact', + }, + ], + default: 'create', + noDataExpression: true, +}, +{ + displayName: 'Email', + name: 'email', + type: 'string', + required: true, + displayOptions: { + show: { + operation: [ + 'create', + ], + resource: [ + 'contact', + ], + }, + }, + default:'', + placeholder: 'name@email.com', + description:'Primary email for the contact', +}, +``` + +#### Step 3.6: Add optional fields + +Most APIs, including the SendGrid API that you're using in this example, have optional fields you can use to refine your query. + +To avoid overwhelming users, n8n displays these under **Additional Fields** in the UI. + +For this tutorial, you'll add two additional fields, to allow users to enter the contact's first name and last name. Add the following to the properties array: + +```typescript +{ + displayName: 'Additional Fields', + name: 'additionalFields', + type: 'collection', + placeholder: 'Add Field', + default: {}, + displayOptions: { + show: { + resource: [ + 'contact', + ], + operation: [ + 'create', + ], + }, + }, + options: [ + { + displayName: 'First Name', + name: 'firstName', + type: 'string', + default: '', + }, + { + displayName: 'Last Name', + name: 'lastName', + type: 'string', + default: '', + }, + ], +}, +``` + +### Step 4: Add the execute method + +You've set up the node UI and basic information. It's time to map the node UI to API requests, and make the node actually do something. + +The `execute` method runs every time the node runs. In this method, you have access to the input items and to the parameters that the user set in the UI, including the credentials. + +Add the following the `execute` method in the `FriendGrid.node.ts`: + +```typescript +// Handle data coming from previous nodes +const items = this.getInputData(); +let responseData; +const returnData = []; +const resource = this.getNodeParameter('resource', 0) as string; +const operation = this.getNodeParameter('operation', 0) as string; + +// For each item, make an API call to create a contact +for (let i = 0; i < items.length; i++) { + if (resource === 'contact') { + if (operation === 'create') { + // Get email input + const email = this.getNodeParameter('email', i) as string; + // Get additional fields input + const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; + const data: IDataObject = { + email, + }; + + Object.assign(data, additionalFields); + + // Make HTTP request according to https://sendgrid.com/docs/api-reference/ + const options: OptionsWithUri = { + headers: { + 'Accept': 'application/json', + }, + method: 'PUT', + body: { + contacts: [ + data, + ], + }, + uri: `https://api.sendgrid.com/v3/marketing/contacts`, + json: true, + }; + responseData = await this.helpers.requestWithAuthentication.call(this, 'friendGridApi', options); + returnData.push(responseData); + } + } +} +// Map data to n8n data structure +return [this.helpers.returnJsonArray(returnData)]; +``` + +Note the following lines of this code: + +```typescript +const items = this.getInputData(); +... +for (let i = 0; i < items.length; i++) { + ... + const email = this.getNodeParameter('email', i) as string; + ... +} +``` + +Users can provide data in two ways: + +* Entered directly in the node fields +* By mapping data from earlier nodes in the workflow + +`getInputData()`, and the subsequent loop, allows the node to handle situations where data comes from a previous node. This includes supporting multiple inputs. This means that if, for example, the previous node outputs contact information for five people, your FriendGrid node can create five contacts. + + +### Step 5: Set up authentication + +The SendGrid API requires users to authenticate with an API key. + +Add the following to `FriendGridApi.credentials.ts` + +```typescript +import { + IAuthenticateGeneric, + ICredentialTestRequest, + ICredentialType, + INodeProperties, +} from 'n8n-workflow'; + +export class FriendGridApi implements ICredentialType { + name = 'friendGridApi'; + displayName = 'FriendGrid API'; + properties: INodeProperties[] = [ + { + displayName: 'API Key', + name: 'apiKey', + type: 'string', + default: '', + }, + ]; + + authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + headers: { + Authorization: '=Bearer {{$credentials.apiKey}}', + }, + }, + }; + + test: ICredentialTestRequest = { + request: { + baseURL: 'https://api.sendgrid.com/v3', + url: '/marketing/contacts', + }, + }; +} + +``` + +For more information about credentials files and options, refer to [Credentials file](/integrations/creating-nodes/build/reference/credentials-files.md). + +### Step 6: Add node metadata + +Metadata about your node goes in the JSON file at the root of your node. n8n refers to this as the codex file. In this example, the file is `FriendGrid.node.json`. + +Add the following code to the JSON file: + +```json +{ + "node": "n8n-nodes-base.FriendGrid", + "nodeVersion": "1.0", + "codexVersion": "1.0", + "categories": [ + "Miscellaneous" + ], + "resources": { + "credentialDocumentation": [ + { + "url": "" + } + ], + "primaryDocumentation": [ + { + "url": "" + } + ] + } +} +``` + +For more information on these parameters, refer to [Node codex files](/integrations/creating-nodes/build/reference/node-codex-files.md). + + +### Step 7: Update the npm package details + +Your npm package details are in the `package.json` at the root of the project. It's essential to include the `n8n` object with links to the credentials and base node file. Update this file to include the following information: + +```json +{ + // All node names must start with "n8n-nodes-" + "name": "n8n-nodes-friendgrid", + "version": "0.1.0", + "description": "n8n node to create contacts in SendGrid", + "keywords": [ + // This keyword is required for community nodes + "n8n-community-node-package" + ], + "license": "MIT", + "homepage": "https://n8n.io", + "author": { + "name": "Test", + "email": "test@example.com" + }, + "repository": { + "type": "git", + // Change the git remote to your own repository + // Add the new URL here + "url": "git+" + }, + "main": "index.js", + "scripts": { + // don't change + }, + "files": [ + "dist" + ], + // Link the credentials and node + "n8n": { + "n8nNodesApiVersion": 1, + "credentials": [ + "dist/credentials/FriendGridApi.credentials.js" + ], + "nodes": [ + "dist/nodes/FriendGrid/FriendGrid.node.js" + ] + }, + "devDependencies": { + // don't change + }, + "peerDependencies": { + // don't change + } +} +``` + +You need to update the `package.json` to include your own information, such as your name and repository URL. For more information on npm `package.json` files, refer to [npm's package.json documentation](https://docs.npmjs.com/cli/v8/configuring-npm/package-json){:target=_blank .external-link}. + + + +## Test your node + +--8<-- "_snippets/integrations/creating-nodes/testing.md" + +## Next steps + +* [Deploy your node](/integrations/creating-nodes/deploy/index.md). +* View an example of a programmatic node: n8n's [Mattermost node](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Mattermost){:target=_blank .external-link}. This is an example of a more complex programmatic node structure. +* Learn about [node versioning](/integrations/creating-nodes/build/reference/node-versioning.md). +* Make sure you understand key concepts: [item linking](/data/data-mapping/data-item-linking/item-linking-concepts.md) and [data structures](/data/data-structure.md). + + +# docs/integrations/creating-nodes/build/reference/code-standards.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# Code standards + +Following defined code standards when building your node makes your code more readable and maintainable, and helps avoid errors. This document provides guidance on good code practices for node building. It focuses on code details. For UI standards and UX guidance, refer to [Node UI design](/integrations/creating-nodes/plan/node-ui-design.md). + +## Use the linter + +The n8n node linter provides automatic checking for many of the node-building standards. You should ensure your node passes the linter's checks before publishing it. Refer to the [n8n node linter](/integrations/creating-nodes/test/node-linter.md) documentation for more information. + +## Use the starter + +The n8n node starter project includes a recommended setup, dependencies (including the linter), and examples to help you get started. Begin new projects with the [starter](https://github.com/n8n-io/n8n-nodes-starter){:target=_blank .external-link}. + +## Write in TypeScript + +All n8n code is TypeScript. Writing your nodes in TypeScript can speed up development and reduce bugs. + +## Detailed guidelines for writing a node + +These guidelines apply to any node you build. + +### Resources and operations + +If your node can perform several operations, call the parameter that sets the operation `Operation`. If your node can do these operations on more than one resource, create a `Resource` parameter. The following code sample shows a basic resource and operations setup: + +```js +export const ExampleNode implements INodeType { + description: { + displayName: 'Example Node', + ... + properties: [ + { + displayName: 'Resource', + name: 'resource', + type: 'options', + options: [ + { + name: 'Resource One', + value: 'resourceOne' + }, + { + name: 'Resource Two', + value: 'resourceTwo' + } + ], + default: 'resourceOne' + }, + { + displayName: 'Operation', + name: 'operation', + type: 'options', + // Only show these operations for Resource One + displayOptions: { + show: { + resource: [ + 'resourceOne' + ] + } + }, + options: [ + { + name: 'Create', + value: 'create', + description: 'Create an instance of Resource One' + } + ] + } + ] + } +} +``` + +### Reuse internal parameter names + +All resource and operation fields in an n8n node have two settings: a display name, set using the `name` parameter, and an internal name, set using the `value` parameter. Reusing the internal name for fields allows n8n to preserve user-entered data if a user switches operations. + +For example: you're building a node with a resource named 'Order'. This resource has several operations, including Get, Edit, and Delete. Each of these operations uses an order ID to perform the operation on the specified order. You need to display an ID field for the user. This field has a display label, and an internal name. By using the same internal name (set in `value`) for the operation ID field on each resource, a user can enter the ID with the Get operation selected, and not lose it if they switch to Edit. + +When reusing the internal name, you must ensure that only one field is visible to the user at a time. You can control this using `displayOptions`. + +## Detailed guidelines for writing a programmatic-style node + +These guidelines apply when building nodes using the programmatic node-building style. They aren't relevant when using the declarative style. For more information on different node-building styles, refer to [Choose your node building approach](/integrations/creating-nodes/plan/choose-node-method.md). + +### Don't change incoming data + +Never change the incoming data a node receives (data accessible with `this.getInputData()`) as all nodes share it. If you need to add, change, or delete data, clone the incoming data and return the new data. If you don't do this, sibling nodes that execute after the current one will operate on the altered data and process incorrect data. + +It's not necessary to always clone all the data. For example, if a node changes the binary data but not the JSON data, you can create a new item that reuses the reference to the JSON item. + + +### Use the built in request library + +Some third-party services have their own libraries on npm, which make it easier to create an integration. The problem with these packages is that you add another dependency (plus all the dependencies of the dependencies). This adds more and more code, which has to be loaded, can introduce security vulnerabilities, bugs, and so on. Instead, use the built-in module: + +```typescript +// If no auth needed +const response = await this.helpers.httpRequest(options); + +// If auth needed +const response = await this.helpers.httpRequestWithAuthentication.call( + this, + 'credentialTypeName', // For example: pipedriveApi + options, +); +``` + +This uses the npm package [Axios](https://www.npmjs.com/package/axios){:target=_blank .external-link}. + +Refer to [HTTP helpers](/integrations/creating-nodes/build/reference/http-helpers.md) for more information, and for migration instructions for the removed `this.helpers.request`. + + +# docs/integrations/creating-nodes/build/reference/credentials-files.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# Credentials file + +The credentials file defines the authorization methods for the node. The settings in this file affect what n8n displays in the **Credentials** modal, and must reflect the authentication requirements of the service you're connecting to. + +In the credentials file, you can use all the [n8n UI elements](/integrations/creating-nodes/build/reference/ui-elements.md). n8n encrypts the data that's stored using credentials using an encryption key. + +## Structure of the credentials file + +The credentials file follows this basic structure: + +1. Import statements +2. Create a class for the credentials +3. Within the class, define the properties that control authentication for the node. + +### Outline structure + +```js +import { + IAuthenticateGeneric, + ICredentialTestRequest, + ICredentialType, + INodeProperties, +} from 'n8n-workflow'; + +export class ExampleNode implements ICredentialType { + name = 'exampleNodeApi'; + displayName = 'Example Node API'; + documentationUrl = ''; + properties: INodeProperties[] = [ + { + displayName: 'API Key', + name: 'apiKey', + type: 'string', + default: '', + }, + ]; + authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + // Can be body, header, qs or auth + qs: { + // Use the value from `apiKey` above + 'api_key': '={{$credentials.apiKey}}' + } + + }, + }; + test: ICredentialTestRequest = { + request: { + baseURL: '={{$credentials?.domain}}', + url: '/bearer', + }, + }; +} +``` + + +## Parameters + +### `name` + +String. The internal name of the object. Used to reference it from other places in the node. + +### `displayName` + +String. The name n8n uses in the GUI. + +### `documentationUrl` + +String. URL to your credentials documentation. + +### `properties` + +Each object contains: + +* `displayName`: the name n8n uses in the GUI. +* `name`: the internal name of the object. Used to reference it from other places in the node. +* `type`: the data type expected, such as `string`. +* `default`: the URL that n8n should use to test credentials. + +### `authenticate` + +* `authenticate`: Object. Contains objects that tell n8n how to inject the authentication data as part of the API request. + +#### `type` + +String. If you're using an authentication method that sends data in the header, body, or query string, set this to `'generic'`. + +#### `properties` + +Object. Defines the authentication methods. Options are: + +* `body`: Object. Sends authentication data in the request body. Can contain nested objects. +```typescript +authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + body: { + username: '={{$credentials.username}}', + password: '={{$credentials.password}}', + }, + }, +}; +``` + +* `header`: Object. Send authentication data in the request header. +```typescript +authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + header: { + Authorization: '=Bearer {{$credentials.authToken}}', + }, + }, +}; +``` + +* `qs`: Object. Stands for "query string." Send authentication data in the request query string. +```typescript +authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + qs: { + token: '={{$credentials.token}}', + }, + }, +}; +``` + +* `auth`: Object. Used for Basic Auth. Requires `username` and `password` as the key names. +```typescript +authenticate: IAuthenticateGeneric = { + type: 'generic', + properties: { + auth: { + username: '={{$credentials.username}}', + password: '={{$credentials.password}}', + }, + }, +}; +``` + +### `test` + +Provide a `request` object containing a URL and authentication type that n8n can use to test the credential. + +```typescript +test: ICredentialTestRequest = { + request: { + baseURL: '={{$credentials?.domain}}', + url: '/bearer', + }, + }; +``` + + +# docs/integrations/creating-nodes/build/reference/http-helpers.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# HTTP request helper for node builders + +n8n provides a flexible helper for making HTTP requests, which abstracts away most of the complexity. + +/// note | Programmatic style only +The information in this document is for node building using the programmatic style. It doesn't apply to declarative style nodes. +/// +## Usage + +Call the helper inside the `execute` function. + +```typescript +// If no auth needed +const response = await this.helpers.httpRequest(options); + +// If auth needed +const response = await this.helpers.httpRequestWithAuthentication.call( + this, + 'credentialTypeName', // For example: pipedriveApi + options, +); +``` + +`options` is an object: + +```typescript +{ + url: string; + headers?: object; + method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD'; + body?: FormData | Array | string | number | object | Buffer | URLSearchParams; + qs?: object; + arrayFormat?: 'indices' | 'brackets' | 'repeat' | 'comma'; + auth?: { + username: string, + password: string, + }; + disableFollowRedirect?: boolean; + encoding?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text' | 'stream'; + skipSslCertificateValidation?: boolean; + returnFullResponse?: boolean; + proxy?: { + host: string; + port: string | number; + auth?: { + username: string; + password: string; + }, + protocol?: string; + }; + timeout?: number; + json?: boolean; +} +``` + +`url` is required. The other fields are optional. The default method is `GET`. + +Some notes about the possible fields: + +- `body`: you can use a regular JavaScript object for JSON payload, a buffer for file uploads, an instance of FormData for `multipart/form-data`, and `URLSearchParams` for `application/x-www-form-urlencoded`. +- `headers`: a key-value pair. + * If `body` is an instance of `FormData` then n8n adds `content-type: multipart/form-data` automatically. + * If `body` is an instance of `URLSearchParams`, then n8n adds `content-type: application/x-www-form-urlencoded`. + * To override this behavior, set a `content-type` header. +- `arrayFormat`: if your query string contains an array of data, such as `const qs = {IDs: [15,17]}`, the value of `arrayFormat` defines how n8n formats it. + * `indices` (default): `{ a: ['b', 'c'] }` as `a[0]=b&a[1]=c` + * `brackets`: `{ a: ['b', 'c'] }` as `a[]=b&a[]=c` + * `repeat`: `{ a: ['b', 'c'] }` as `a=b&a=c` + * `comma`: `{ a: ['b', 'c'] }` as `a=b,c` +- `auth`: Used for Basic auth. Provide `username` and `password`. n8n recommends omitting this, and using `helpers.httpRequestWithAuthentication(...)` instead. +- `disableFollowRedirect`: By default, n8n follows redirects. You can set this to true to prevent this from happening. +- `skipSslCertificateValidation`: Used for calling HTTPS services without proper certificate +- `returnFullResponse`: Instead of returning just the body, returns an object with more data in the following format: `{body: body, headers: object, statusCode: 200, statusMessage: 'OK'}` +- `encoding`: n8n can detect the content type, but you can specify `arrayBuffer` to receive a Buffer you can read from and interact with. + +## Example + +For an example, refer to the [Mattermost node](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Mattermost/v1/MattermostV1.node.ts){:target=_blank .external-link}. + +## Deprecation of the previous helper + +The previous helper implementation using `this.helpers.request(options)` used and exposed the `request-promise` library. This was removed in version 1. + +To minimize incompatibility, n8n made a transparent conversion to another library called `Axios`. + +If you are having issues, please report them in the [Community Forums](https://community.n8n.io/){:target=_blank .external-link} or on [GitHub](https://github.com/n8n-io/n8n/issues){:target=_blank .external-link}. + +## Migration guide to the new helper + +The new helper is much more robust, library agnostic, and easier to use. + +New nodes should all use the new helper. You should strongly consider migrating existing custom nodes to the new helper. These are the main considerations when migrating: + +- Accepts `url`. Doesn't accept `uri`. +- `encoding: null` now must be `encoding: arrayBuffer`. +- `rejectUnauthorized: false` is now `skipSslCertificateValidation: true` +- Use `body` according to `content-type` headers to clarify the payload. +- `resolveWithFullResponse` is now `returnFullResponse` and has similar behavior + + +# docs/integrations/creating-nodes/build/reference/index.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: overview +--- + +# Node building reference + +This section contains reference information, including details about: + +* [Node UI elements](/integrations/creating-nodes/build/reference/ui-elements.md) +* [Organizing your node files](/integrations/creating-nodes/build/reference/node-file-structure.md) +* Key parameters in your node's [base file](/integrations/creating-nodes/build/reference/node-base-files/index.md) and [credentials file](/integrations/creating-nodes/build/reference/credentials-files.md). +* [UX guidelines](/integrations/creating-nodes/build/reference/ux-guidelines.md) and [verification guidelines](/integrations/creating-nodes/build/reference/verification-guidelines.md) for submitting your node for [verification by n8n](/integrations/community-nodes/installation/verified-install.md). + + +# docs/integrations/creating-nodes/build/reference/node-codex-files.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# Node codex files + +The codex file contains metadata about your node. This file is the JSON file at the root of your node. For example, the [`HttpBin.node.json`](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/HttpBin/HttpBin.node.json){:target=_blank .external-class} file in the n8n starter. + +The codex filename must match the node base filename. For example, given a node base file named `MyNode.node.ts`, the codex would be named `MyNode.node.json`. + +| Parameter | Description | +| -------- | ----------- | +| `node` | Includes the node name. Must start with `n8n-nodes-base.`. For example, `n8n-nodes-base.openweatherapi`. | +| `nodeVersion` | The node version. This should have the same value as the `version` parameter in your main node file. For example, `"1.0"`. | +| `codexVersion` | The codex file version. The current version is `"1.0"`. | +| `categories` | The settings in the `categories` array determine which category n8n adds your node to in the GUI. See [Node categories](#node-categories) for more information. | +| `resources` | The `resources` object contains links to your node documentation. n8n automatically adds help links to credentials and nodes in the GUI. | + +## Node categories + +You can define one or more categories in your node configuration JSON. This helps n8n put the node in the correct category in the nodes panel. + +Choose from these categories: + +* Data & Storage +* Finance & Accounting +* Marketing & Content +* Productivity +* Miscellaneous +* Sales +* Development +* Analytics +* Communication +* Utility + +You must match the syntax. For example, `Data & Storage` not `data and storage`. + + +# docs/integrations/creating-nodes/build/reference/node-file-structure.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: explanation +--- + +# Node file structure + +Following best practices and standards in your node structure makes your node easier to maintain. It's helpful if other people need to work with the code. + +The file and directory structure of your node depends on: + +* Your node's complexity. +* Whether you use node versioning. +* How many nodes you include in the npm package. + +## Required files and directories + +Your node must include: + +* A `package.json` file at the root of the project. This is required for any npm module. +* A `nodes` directory, containing the code for your node: + * This directory must contain the [base file](/integrations/creating-nodes/build/reference/node-base-files/index.md), in the format `.node.ts`. For example, `MyNode.node.ts`. + * n8n recommends including a [codex file](/integrations/creating-nodes/build/reference/node-codex-files.md), containing metadata for your node. The codex filename must match the node base filename. For example, given a node base file named `MyNode.node.ts`, the codex name is `MyNode.node.json`. + * The `nodes` directory can contain other files and subdirectories, including directories for versions, and node code split across more than one file to create a modular structure. +* A `credentials` directory, containing your credentials code. This code lives in a single [credentials file](/integrations/creating-nodes/build/reference/credentials-files.md). The filename format is `.credentials.ts`. For example, `MyNode.credentials.ts`. + +## Modular structure + +You can choose whether to place all your node's functionality in one file, or split it out into a base file and other modules, which the base file then imports. Unless your node is very simple, it's a best practice to split it out. + + +A basic pattern is to separate out operations. Refer to the [HttpBin starter node](https://github.com/n8n-io/n8n-nodes-starter/tree/master/nodes/HttpBin){:target=_blank .external-link} for an example of this. + +For more complex nodes, n8n recommends a directory structure. Refer to the [Airtable node](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Airtable){:target=_blank .external-class} or [Microsoft Outlook node](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Microsoft/Outlook){:target=_blank .external-link} as examples. + + * `actions`: a directory containing sub-directories that represent resources. + * Each sub-directory should contain two types of files: + * An index file with resource description (named either `.resource.ts` or `index.ts`) + * Files for operations `.operation.ts`. These files should have two exports: `description` of the operation and an `execute` function. + * `methods`: an optional directory dynamic parameters' functions. + * `transport`: a directory containing the communication implementation. + + +## Versioning + +If your node has more than one version, and you're using full versioning, this makes the file structure more complex. You need a directory for each version, along with a base file that sets the default version. Refer to [Node versioning](/integrations/creating-nodes/build/reference/node-versioning.md) for more information on working with versions, including types of versioning. + +## Decide how many nodes to include in a package + +There are two possible setups when building a node: + +* One node in one npm package. +* More than one node in a single npm package. + +n8n supports both approaches. If you include more than one node, each node should have its own directory in the `nodes` directory. + +## A best-practice example for programmatic nodes + +n8n's built-in [Airtable node](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Airtable){:target=_blank .external-class} implements a modular structure and versioning, following recommended patterns. + + + + +# docs/integrations/creating-nodes/build/reference/node-versioning.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Node versioning + +n8n supports node versioning. You can make changes to existing nodes without breaking the existing behavior by introducing a new version. + +Be aware of how n8n decides which node version to load: + +* If a user builds and saves a workflow using version 1, n8n continues to use version 1 in that workflow, even if you create and publish a version 2 of the node. +* When a user creates a new workflow and browses for nodes, n8n always loads the latest version of the node. + +/// note | Versioning type restricted by node style +If you build a node using the declarative style, you can't use full versioning. +/// +## Light versioning + +This is available for all node types. + +One node can contain more than one version, allowing small version increments without code duplication. To use this feature: + +1. Change the main `version` parameter to an array, and add your version numbers, including your existing version. +2. You can then access the version parameter with `@version` in your `displayOptions` in any object (to control which versions n8n displays the object with). You can also query the version from a function using `const nodeVersion = this.getNode().typeVersion;`. + +As an example, say you want to add versioning to the NasaPics node from the [Declarative node tutorial](/integrations/creating-nodes/build/declarative-style-node.md), then configure a resource so that n8n only displays it in version 2 of the node. In your base `NasaPics.node.ts` file: + +```js +{ + displayName: 'NASA Pics', + name: 'NasaPics', + icon: 'file:nasapics.svg', + // List the available versions + version: [1,2,3], + // More basic parameters here + properties: [ + // Add a resource that's only displayed for version2 + { + displayName: 'Resource name', + // More resource parameters + displayOptions: { + show: { + '@version': 2, + }, + }, + }, + ], +} +``` + +## Full versioning + +This isn't available for declarative-style nodes. + +As an example, refer to the [Mattermost node](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Mattermost){:target=_blank .external-link}. + +Full versioning summary: + +- The base node file should extend `NodeVersionedType` instead of `INodeType`. +- The base node file should contain a description including the `defaultVersion` (usually the latest), other basic node metadata such as name, and a list of versions. It shouldn't contain any node functionality. +- n8n recommends using `v1`, `v2`, and so on, for version folder names. + + + + +# docs/integrations/creating-nodes/build/reference/paired-items.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: howto +--- + +# Item linking + +--8<-- "_snippets/data/data-mapping/item-linking-node-creators.md" + + +# docs/integrations/creating-nodes/build/reference/ui-elements.md + +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +contentType: reference +--- + +# Node user interface elements + +n8n provides a set of predefined UI components (based on a JSON file) that allows users to input all sorts of data types. The following UI elements are available in n8n. + +## String + +Basic configuration: + +```typescript +{ + displayName: Name, // The value the user sees in the UI + name: name, // The name used to reference the element UI within the code + type: string, + required: true, // Whether the field is required or not + default: 'n8n', + description: 'The name of the user', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + + +![String](/_images/integrations/creating-nodes/string.png) + + +String field for inputting passwords: + +```typescript +{ + displayName: 'Password', + name: 'password', + type: 'string', + required: true, + typeOptions: { + password: true, + }, + default: '', + description: `User's password`, + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Password](/_images/integrations/creating-nodes/password.png) + + +String field with more than one row: + +```typescript +{ + displayName: 'Description', + name: 'description', + type: 'string', + required: true, + typeOptions: { + rows: 4, + }, + default: '', + description: 'Description', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Multiple rows](/_images/integrations/creating-nodes/multiple-rows.png) + +### Support drag and drop for data keys + +Users can drag and drop data values to map them to fields. Dragging and dropping creates an [expression](/glossary.md#expression-n8n) to load the data value. n8n supports this automatically. + +You need to add an extra configuration option to support dragging and dropping data keys: + +* `requiresDataPath: 'single'`: for fields that require a single string. +* `requiresDataPath: 'multiple'`: for fields that can accept a comma-separated list of string. + +The [Compare Datasets node code](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/CompareDatasets/CompareDatasets.node.ts){:target=_blank .external-link} has examples. + +## Number + +Number field with decimal points: + +```typescript +{ + displayName: 'Amount', + name: 'amount', + type: 'number', + required: true, + typeOptions: { + maxValue: 10, + minValue: 0, + numberPrecision: 2, + }, + default: 10.00, + description: 'Your current amount', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Decimal](/_images/integrations/creating-nodes/decimal.png) + +## Collection + +Use the `collection` type when you need to display optional fields. + +```typescript +{ + displayName: 'Filters', + name: 'filters', + type: 'collection', + placeholder: 'Add Field', + default: {}, + options: [ + { + displayName: 'Type', + name: 'type', + type: 'options', + options: [ + { + name: 'Automated', + value: 'automated', + }, + { + name: 'Past', + value: 'past', + }, + { + name: 'Upcoming', + value: 'upcoming', + }, + ], + default: '', + }, + ], + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Collection](/_images/integrations/creating-nodes/collection.png) + + +## DateTime + +The `dateTime` type provides a date picker. + +```typescript +{ + displayName: 'Modified Since', + name: 'modified_since', + type: 'dateTime', + default: '', + description: 'The date and time when the file was last modified', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![DateTime](/_images/integrations/creating-nodes/datetime.png) + + + +## Boolean + +The `boolean` type adds a toggle for entering true or false. + +```typescript +{ + displayName: 'Wait for Image', + name: 'waitForImage', + type: 'boolean', + default: true, // Initial state of the toggle + description: 'Whether to wait for the image or not', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Boolean](/_images/integrations/creating-nodes/boolean.png) + +## Color + +The `color` type provides a color selector. + +```typescript +{ + displayName: 'Background Color', + name: 'backgroundColor', + type: 'color', + default: '', // Initially selected color + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Color](/_images/integrations/creating-nodes/color.png) + +## Options + +The `options` type adds an options list. Users can select a single value. + +```typescript +{ + displayName: 'Resource', + name: 'resource', + type: 'options', + options: [ + { + name: 'Image', + value: 'image', + }, + { + name: 'Template', + value: 'template', + }, + ], + default: 'image', // The initially selected option + description: 'Resource to consume', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Options](/_images/integrations/creating-nodes/options.png) + +## Multi-options + +The `multiOptions` type adds an options list. Users can select more than one value. + +```typescript +{ + displayName: 'Events', + name: 'events', + type: 'multiOptions', + options: [ + { + name: 'Plan Created', + value: 'planCreated', + }, + { + name: 'Plan Deleted', + value: 'planDeleted', + }, + ], + default: [], // Initially selected options + description: 'The events to be monitored', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Multi-options](/_images/integrations/creating-nodes/multioptions.png) + + +## Filter + +Use this component to evaluate, match, or filter incoming data. + +This is the code from n8n's own If node. It shows a filter component working with a [collection](#collection) component where users can configure the filter's behavior. + +```typescript +{ + displayName: 'Conditions', + name: 'conditions', + placeholder: 'Add Condition', + type: 'filter', + default: {}, + typeOptions: { + filter: { + // Use the user options (below) to determine filter behavior + caseSensitive: '={{!$parameter.options.ignoreCase}}', + typeValidation: '={{$parameter.options.looseTypeValidation ? "loose" : "strict"}}', + }, + }, +}, +{ +displayName: 'Options', +name: 'options', +type: 'collection', +placeholder: 'Add option', +default: {}, +options: [ + { + displayName: 'Ignore Case', + description: 'Whether to ignore letter case when evaluating conditions', + name: 'ignoreCase', + type: 'boolean', + default: true, + }, + { + displayName: 'Less Strict Type Validation', + description: 'Whether to try casting value types based on the selected operator', + name: 'looseTypeValidation', + type: 'boolean', + default: true, + }, +], +}, +``` + +![Filter](/_images/integrations/creating-nodes/filter.png) + + +## Assignment collection (drag and drop) + +Use the drag and drop component when you want users to pre-fill name and value parameters with a single drag interaction. + +```typescript +{ + displayName: 'Fields to Set', + name: 'assignments', + type: 'assignmentCollection', + default: {}, +}, +``` + +You can see an example in n8n's [Edit Fields (Set) node](https://github.com/n8n-io/n8n/tree/0faeab1228e26d69a2a93bdb2f89523cca1e4036/packages/nodes-base/nodes/Set/v2){:target=_blank .external-link}: + +![A gif showing the drag and drop action, as well as changing a field to fixed](/_images/integrations/builtin/core-nodes/set/drag-drop-fixed-toggle.gif) + +## Fixed collection + +Use the `fixedCollection` type to group fields that are semantically related. + +```typescript +{ + displayName: 'Metadata', + name: 'metadataUi', + placeholder: 'Add Metadata', + type: 'fixedCollection', + default: '', + typeOptions: { + multipleValues: true, + }, + description: '', + options: [ + { + name: 'metadataValues', + displayName: 'Metadata', + values: [ + { + displayName: 'Name', + name: 'name', + type: 'string', + default: 'Name of the metadata key to add.', + }, + { + displayName: 'Value', + name: 'value', + type: 'string', + default: '', + description: 'Value to set for the metadata key.', + }, + ], + }, + ], + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![Fixed collection](/_images/integrations/creating-nodes/fixed-collection.png) + + + +## Resource locator + +![Resource locator](/_images/integrations/creating-nodes/resource-locator.png) + +The resource locator element helps users find a specific resource in an external service, such as a card or label in Trello. + +The following options are available: + +* ID +* URL +* List: allows users to select or search from a prepopulated list. This option requires more coding, as you must populate the list, and handle searching if you choose to support it. + +You can choose which types to include. + +Example: + +```typescript +{ + displayName: 'Card', + name: 'cardID', + type: 'resourceLocator', + default: '', + description: 'Get a card', + modes: [ + { + displayName: 'ID', + name: 'id', + type: 'string', + hint: 'Enter an ID', + validation: [ + { + type: 'regex', + properties: { + regex: '^[0-9]', + errorMessage: 'The ID must start with a number', + }, + }, + ], + placeholder: '12example', + // How to use the ID in API call + url: '=http://api-base-url.com/?id={{$value}}', + }, + { + displayName: 'URL', + name: 'url', + type: 'string', + hint: 'Enter a URL', + validation: [ + { + type: 'regex', + properties: { + regex: '^http', + errorMessage: 'Invalid URL', + }, + }, + ], + placeholder: 'https://example.com/card/12example/', + // How to get the ID from the URL + extractValue: { + type: 'regex', + regex: 'example.com/card/([0-9]*.*)/', + }, + }, + { + displayName: 'List', + name: 'list', + type: 'list', + typeOptions: { + // You must always provide a search method + // Write this method within the methods object in your base file + // The method must populate the list, and handle searching if searchable: true + searchListMethod: 'searchMethod', + // If you want users to be able to search the list + searchable: true, + // Set to true if you want to force users to search + // When true, users can't browse the list + // Or false if users can browse a list + searchFilterRequired: true, + }, + }, + ], + displayOptions: { + // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ], + }, + }, +}, +``` + +Refer to the following for live examples: + +* Refer to [`CardDescription.ts`](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Trello/CardDescription.ts){:target=_blank .external-link} and [`Trello.node.ts`](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Trello/Trello.node.ts){:target=_blank .external-link} in n8n's Trello node for an example of a list with search that includes `searchFilterRequired: true`. +* Refer to [`GoogleDrive.node.ts`](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Google/Drive/GoogleDrive.node.ts){:target=_blank .external-link} for an example where users can browse the list or search. + +## Resource mapper + +If your node performs insert, update, or upsert operations, you need to send data from the node in a format supported by the service you're integrating with. A common pattern is to use a Set node before the node that sends data, to convert the data to match the schema of the service you're connecting to. The resource mapper UI component provides a way to get data into the required format directly within the node, rather than using a Set node. The resource mapper component can also validate input data against the schema provided in the node, and cast input data into the expected type. + +/// note | Mapping and matching +Mapping is the process of setting the input data to use as values when updating row(s). Matching is the process of using column names to identify the row(s) to update. +/// + +```js +{ + displayName: 'Columns', + name: 'columns', // The name used to reference the element UI within the code + type: 'resourceMapper', // The UI element type + default: { + // mappingMode can be defined in the component (mappingMode: 'defineBelow') + // or you can attempt automatic mapping (mappingMode: 'autoMapInputData') + mappingMode: 'defineBelow', + // Important: always set default value to null + value: null, + }, + required: true, + // See "Resource mapper type options interface" below for the full typeOptions specification + typeOptions: { + resourceMapper: { + resourceMapperMethod: 'getMappingColumns', + mode: 'update', + fieldWords: { + singular: 'column', + plural: 'columns', + }, + addAllFields: true, + multiKeyMatch: true, + supportAutoMap: true, + matchingFieldsLabels: { + title: 'Custom matching columns title', + description: 'Help text for custom matching columns', + hint: 'Below-field hint for custom matching columns', + }, + }, + }, +}, +``` + +Refer to the [Postgres node (version 2)](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Postgres/v2){:target=_blank .external-link} for a live example using a database schema. + +Refer to the [Google Sheets node (version 2)](https://github.com/n8n-io/n8n/tree/master/packages/nodes-base/nodes/Google/Sheet/v2){:target=_blank .external-link} for a live example using a schema-less service. + +### Resource mapper type options interface + +The `typeOptions` section must implement the following interface: + +```js +export interface ResourceMapperTypeOptions { + // The name of the method where you fetch the schema + // Refer to the Resource mapper method section for more detail + resourceMapperMethod: string; + // Choose the mode for your operation + // Supported modes: add, update, upsert + mode: 'add' | 'update' | 'upsert'; + // Specify labels for fields in the UI + fieldWords?: { singular: string; plural: string }; + // Whether n8n should display a UI input for every field when node first added to workflow + // Default is true + addAllFields?: boolean; + // Specify a message to show if no fields are fetched from the service + // (the call is successful but the response is empty) + noFieldsError?: string; + // Whether to support multi-key column matching + // multiKeyMatch is for update and upsert only + // Default is false + // If true, the node displays a multi-select dropdown for the matching column selector + multiKeyMatch?: boolean; + // Whether to support automatic mapping + // If false, n8n hides the mapping mode selector field and sets mappingMode to defineBelow + supportAutoMap?: boolean; + // Custom labels for the matching columns selector + matchingFieldsLabels?: { + title?: string; + description?: string; + hint?: string; + }; +} +``` + +### Resource mapper method + +This method contains your node-specific logic for fetching the data schema. Every node must implement its own logic for fetching the schema, and setting up each UI field according to the schema. + +It must return a value that implements the `ResourceMapperFields` interface: + +```js +interface ResourceMapperField { + // Field ID as in the service + id: string; + // Field label + displayName: string; + // Whether n8n should pre-select the field as a matching field + // A matching field is a column used to identify the rows to modify + defaultMatch: boolean; + // Whether the field can be used as a matching field + canBeUsedToMatch?: boolean; + // Whether the field is required by the schema + required: boolean; + // Whether to display the field in the UI + // If false, can't be used for matching or mapping + display: boolean; + // The data type for the field + // These correspond to UI element types + // Supported types: string, number, dateTime, boolean, time, array, object, options + type?: FieldType; + // Added at runtime if the field is removed from mapping by the user + removed?: boolean; + // Specify options for enumerated types + options?: INodePropertyOptions[]; +} +``` + +Refer to the [Postgres resource mapping method](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Postgres/v2/methods/resourceMapping.ts){:target=_blank .external-link} and [Google Sheets resource mapping method](https://github.com/n8n-io/n8n/blob/master/packages/nodes-base/nodes/Google/Sheet/v2/methods/resourceMapping.ts){:target=_blank .external-link} for live examples. + +## JSON + +```typescript +{ + displayName: 'Content (JSON)', + name: 'content', + type: 'json', + default: '', + description: '', + displayOptions: { // the resources and operations to display this element with + show: { + resource: [ + // comma-separated list of resource names + ], + operation: [ + // comma-separated list of operation names + ] + } + }, +} +``` + +![JSON](/_images/integrations/creating-nodes/json.png) + + +## HTML + +The HTML editor allows users to create HTML templates in their workflows. The editor supports standard HTML, CSS in `