Documentation for n8n, a fair-code licensed automation tool with a free community edition and powerful enterprise options. Build AI functionality into your workflows.
Home Page: https://docs.n8n.io
License: Other
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
The workflow settings Save Execution Progress was added in 0.108.0 according to the changelog, but it's missing its documentation on the docs page n8n-docs/docs/reference/workflow.md.
I assumed that n8n was stateless (except for the database) and could therefore be run on Google Cloud Run. However, I just had the case that I was testing a webhook, and while the container was in the "waiting to receive request" mode, all requests were suddenly routed to another container. This is not a deal breaker, but now I'm wondering what other functionality is not stateless and could cause problems in the future?
Change:
| N8N_SMTP_SENDER | string | You can select the sender name from the sender addresses. Example: "N8N [email protected]"| Required |
To:
| N8N_SMTP_SENDER | string | You can select the sender name from the sender addresses. Example: "N8N <[email protected]>"| Required |
And
Change:
| N8N_SMTP_SENDER | String | - |You can select the sender name from the sender addresses. Example: N8N [email protected]_|
To:
| N8N_SMTP_SENDER | String | - | You can select the sender name from the sender addresses. Example: N8N <[email protected]>|
License section in README.md (https://github.com/n8n-io/n8n-docs#license)
n8n-docs is fair-code licensed under Apache 2.0 with Commons Clause should pobably read
n8n-docs is fair-code licensed under Sustainable Use License.
BTW and FWIW, I think your decision to move away from the Commons Clause was wise. I believe that the wording of the Common Clause makes it a time-bomb, and not "Fair-code" at all.
The link here
https://docs.n8n.io/getting-started/installation/updating.html
does not exist anymore
A user asked me how they might get the execution time of a portion of a workflow (they are testing API latency, and need to record the ms it took for API to reply). I created this workflow to be generic enough to answer the general question "how do I measure how long a workflow/ portion of workflow took to execute?"
Workflow on n8n.io: https://n8n.io/workflows/717
Not sure exactly where, but I recommend this is linked in the docs. Maybe in the function node, or perhaps in Javascript Snippets cheatsheet. Not too precious where!
It would be good to clarify that the endpoints in N8N_AUTH_EXCLUDE_ENDPOINTS must not start with a slash: correct:correct, /incorrect:/incorrect.
https://docs.n8n.io/reference/environment-variables.html#security
This is my first time using n8n. Working through the "slightly longer introduction" I observed the following inconsistencies:
Instructions 4 and 5 now occur in the opposite order.
Instead of Select the Credential for NASA API dropdown., this appears:
Only after selecting the resource does the credential UI appear:
Instruction 5. b) does not match the UI:
Select Current Node > Input Data > JSON > classType. n8n adds the expression to the Expression editor
To get the variable reference in the field, I dragged classType from the left side of the UI.
Close the expressions editor to return to the node
By default the expressions editor is not opened; the variable is edited inline.
There are additional inconsistencies, but you get the idea.
Is this something the community is aware of, and if so is an update to the Quickstart prioritized? If not I am willing to take this on.
The Get the binary data buffer cookbook says that the getBinaryDataBuffer() should be used to access binary data from the Code node, but this method is completely undocumented other than in this cookbook, making it very confusing to use.
I think this method needs to be added to the documentation for Built-in methods and variables. There should be clarification on the type and purpose of the two parameters (itemIndex and binaryPropertyName) as well as the method's return value.
Hello ! 👋
In the documentation Server Setup, there is the volume configuration /var/run/docker.sock:/var/run/docker.sock in the n8n service declaration; implying that n8n requires an access to the Docker socket to work.
https://docs.n8n.io/reference/server-setup.html#_5-create-docker-compose-file
However, I looked through the documentation to check any reason to do so, but I unfortunately found none.
Does n8n really uses the docker.sock for anything ?
If so, documentation should be clearer about the usage for security and transparency purposes
If not, I guess this is just a typo that should be removed maybe ?
Regards,
At https://docs.n8n.io/getting-started/installation/docker-quickstart.html#using-alternate-databases it says that the /root/.n8n directory needs to be persisted since it contains the encryption key for credentials. However, the encryption key can also be provided via the N8N_ENCRYPTION_KEY environment variable.
So as far as I can tell /root/.n8n does not need to be persisted, right?
That's very important information if you want to run n8n on an ephemeral hosting service like Google Cloud Run.
--
@harshil1712 Proposed additions to the 'Automate Product Feedback with Typeform, Airtable, and Trello 📈' pathway:
Steps to Reproduce the bug:
Browser: Brave Browser
Had a case came up that seems abstract enough to merit inclusion in https://docs.n8n.io/reference/javascript-code-snippets.html .
I pulled in an Airtable list, sorted by a field (in this case a score). I needed to get only the first n items (in this case "top 10 items sorted by score") and ended up being a very simple function node:
return items.slice(0, n);
Create First Node Documentation
Let’s make the Node Editor View ask for these parameters:
'dd the following under description.properties in packages/nodes-base/nodes/FriendGrid/FriendGrid.node.ts.
Should be: Add the following under description.properties...
Hi there, the plugin currently uses the Twilio primary account sid and password. This is pretty risky for production systems, and a pain to manage if they need to be revoked without breaking other systems.
Twilio provides "standard" apikeys and passwords with limited permissions that should be used instead.
https://docs.n8n.io/credentials/twilio/
https://www.twilio.com/docs/iam/keys/api-key
Thank you for your consideration
Hello n8n team,
I'm reaching out to bring to your attention an issue I've encountered with the Trello integration in n8n. It appears that Trello has recently updated how they manage API keys and authentication.
Documentation Link Issue: The current n8n documentation for Trello integration directs users to https://trello.com/app-key for obtaining API keys. However, this link now redirects users to a new page (https://trello.com/power-ups/admin/) with a notice about changes in managing API keys.
Change in Authentication Method: On the new Trello page, it is mentioned that "Each Power-Up can now have a unique API key and be managed by any collaborators," and there's an emphasis on managing these keys from the "Power-Up Admin Portal." Most notably, what was previously referred to as an 'API Token' is now termed as an 'API Secret.'
Integration Issue: In the n8n Trello node configuration, it still asks for an 'API Key' and 'API Token.' When I try to use the new 'API Key' and 'API Secret' from Trello in these fields, I encounter a 401 authentication error.
I seems the n8n Trello node needs an update to align with these new changes from Trello. It would be greatly appreciated if you could look into this issue and update the integration process accordingly. This change is crucial for ensuring smooth and continued integration between n8n and Trello. I tried this from both my local and your cloud. I added my localhost, my IP address and the cloud address of the workspace to the Trello allowed origins.
Thank you for your attention to this matter.
Best regards,
Luke
Users ask how to "get all" tickets from JIRA node but with filters applied. Answer is using JQL queries (an "option" in JIRA Node). FAQ answer should include link to JQL reference.
Original post in community:
https://community.n8n.io/t/jira-project-selection/2578
Essential for node development and apparently not mentioned anywhere. Brought up twice by new joiners.
The https://docs.n8n.io/getting-started/create-your-first-workflow/daily-weather-notifications/#building-the-workflow and https://docs.n8n.io/getting-started/create-your-first-workflow/get-product-feedback/#building-the-workflow sections has the following broken links (they redirect the browser to the locations in parens, which work when visited directly):
The IF and Twilio links work.
Example contents of page for Cron above:
I see this problem in Firefox, Chrome and Safari on macOS. I do not see this problem in Safari on iOS or Chromium on Linux.
The license title on Docs page still showing Apache 2.0 with Commons Clause instead of Sustainable Use License. However, the link points correctly to the new LICENSE.md file.
The below link in the Server Setup is broken.
https://docs.n8n.io/getting-started/installation/advanced/security.html
Hi devs,
I'm new to n8n, and I am trying very-quick-quickstart-workflow. The node "Edit Field" seems not configured when I use the template, as the following screenshots:
Since the final outputs from messenger are pretty weird, I assume that I should map some original fields in {{$json.customer_name}} and {{$json.customer_description}} in the node "Edit Field" first? Yet the tutorial didn't tell me to do that.
Step three: Run the workflow#
Select Test Workflow. This runs the workflow, loading the data from the Customer Datastore node, then transforming it with Edit Fields. You need this data available in the workflow so that you can work with it in the next step.
Please kindly tell me if I get something wrong, thanks!
Best,
Andrew
Following environment variables are explained on https://docs.n8n.io/getting-started/installation/advanced/configuration.html, but not listed on the reference page at https://docs.n8n.io/reference/environment-variables.html.
N8N_CONFIG_FILESN8N_CUSTOM_EXTENSIONSN8N_ENCRYPTION_KEYN8N_USER_FOLDERNODE_FUNCTION_ALLOW_BUILTINNODE_FUNCTION_ALLOW_EXTERNALVUE_APP_URL_BASE_APIWEBHOOK_TUNNEL_URLFrom the Merge docs:
If there are more items in one input than the other, the default behavior is to leave out the items without a match. Choose Add Option > Include Any Unpaired Items to keep the unmatched items.
It seems the 'Include Any Unpaired Items' option referenced is not in the interface; there is only 'Clash Handling', 'Multiple Matches', and 'Disable Dot Notation'.
Was having trouble on how to DM a user directly (instead of posting a message to a chat). Slack is an accessible/ broadly used node (and also will be used heavily in cloud onboarding), so I think it's justifiable to give it a second example like this (i.e. is one of our "top nodes")
Had to make a custom Cron expression (Mon-Thursday at 9 am). Immediately I googled "Cron expression generator" as I reach for a visual tool for things like this and regex. Was having errors on first two generator tools I found because they were conformed to the popular Quartz spec (which we don't support). I recommend we find a free tool that supports the spec we conform to and link to it in Cron node docs.
On our docs for Salesforce credentials ( ) we state that for n8n.cloud users "You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Salesforce account to n8n."
This confusing because Add Credentials modal for Salesforce (on n8n.cloud) has an additional "Access Token URL:" field. If the user reads "⛅️ Note for n8n.cloud users", they could understand it to mean "don't touch Access Token URL", even though they would need to.
Walkthrough request: anything related to working with binary data, uploading it via http request (multipart form etc).
This line in the instructions is no longer valid:
git clone https://github.com/n8n-io/mkdocs-material-insiders.git mkdocs-material
Result:
fatal: repository 'https://github.com/n8n-io/mkdocs-material-insiders.git/' not found
Cloud user asked about Gmail trigger node. Not on immediate roadmap since we have IMAP Email node. Current docs are rather light on how to use IMAP node. Would be great to have another example specifically with gmail where we can point users when they ask for "gmail trigger". Useful then for other email users since we atleast show how to configure it with a mainstream email client.
https://docs.n8n.io/nodes/n8n-nodes-base.emailReadImap/#basic-operations
https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.bitly/#example-usage
Here, it was mentioned to use the credentials of Twilio, it should be Bitly instead.
n8n-docs/docs/code-examples/javascript-functions/jmespath.md
Lines 164 to 198 in 29927b2
Hi there 👋
I just noticed a little typo resulting of a merge conflict over there:
n8n-docs/docs/release-notes.md
Line 1061 in 0f73ee6
There are 3 areas where we can see the merge conflicts.
https://docs.n8n.io/integrations/builtin/credentials/shopify/
Shopify private apps are not called private apps any more and keys have changed:
The documentation si really underwhelming. If n8n should be a no-code platform, there should be at least some instruction how to get the credential, at least from the most used platforms.
I was quite happy to see the progress on the n8n project and thought, hey, let's switch to an open-source project from Make.com - but what is actually great on Make is that you often don't need to enter any credentials, you just log into your google account or similar. If there's a need for api keys e.t.c. then there are super detailed instructions.
I'd love to switch all automations our company does, which is quite a lot of workflows already, about 30 working workflows.
Typeform OAuth creds are not currently deployed to cloud for Typeform, so the note on https://docs.n8n.io/credentials/typeform/#prerequisites is not accurate.
Needed to count number of items returned by node (in this case, Airtable rows). Found this in the community forums from Ricardo. It did the trick nicely and seems like a generally useful snippet.
{
"nodes": [
{
"parameters": {
"functionCode": "if (Object.keys(items[0].json).length === 0) {\n return [\n {\n json: {\n results: 0,\n }\n }\n ]\n}\n\nreturn [\n {\n json: {\n results: items.length,\n }\n }\n];"
},
"name": "Count # of items",
"type": "n8n-nodes-base.function",
"typeVersion": 1,
"position": [
820,
300
]
}
],
"connections": {}
}
The node creation guide is likely a frequently visited document, so worth thinking about updating the screencaps to show the current UI.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.