Merge branch 'main' of github.com:n8n-io/n8n-docs into DOC-737-auth-creds
@ -1,3 +1,5 @@
|
||||
*[completion]: Completions are the responses generated by a model like GPT.
|
||||
*[hallucinations]: Hallucination in AI is when an LLM (large language model) mistakenly perceives patterns or objects that don't exist.
|
||||
*[vector database]: A vector database stores mathematical representations of information. Use with embeddings and retrievers to create a database that your AI can access when answering questions.
|
||||
*[vector store]: A vector store, or vector database, stores mathematical representations of information. Use with embeddings and retrievers. Use with embeddings and retrievers to create a database that your AI can access when answering questions.
|
||||
|
||||
|
||||
@ -1,3 +1,7 @@
|
||||
/// info | Feature availability
|
||||
AI assistance in the Code node is available to Cloud users. It isn't available in self-hosted n8n.
|
||||
///
|
||||
|
||||
/// note | AI generated code overwrites your code
|
||||
If you've already written some code on the **Code** tab, the AI generated code will replace it. n8n recommends using AI as a starting point to create your initial code, then editing it as needed.
|
||||
///
|
||||
|
||||
@ -2,5 +2,5 @@
|
||||
If you have issues with expressions in 1.9.0:
|
||||
|
||||
* Please report the issue on the [forums](https://community.n8n.io/){:target=_blank .external-link}.
|
||||
* Self-hosted users can switch back to RiotTmpl: set `N8N_EXPRESSION_EVALUATOR` to `tmpl`. Refer to [Environment variables](/hosting/environment-variables/) for more information on configuring self-hosted n8n.
|
||||
///
|
||||
* Self-hosted users can switch back to RiotTmpl: set `N8N_EXPRESSION_EVALUATOR` to `tmpl`. Refer to [Environment variables](/hosting/configuration/) for more information on configuring self-hosted n8n.
|
||||
///
|
||||
|
||||
@ -0,0 +1,11 @@
|
||||
## What to do if your operation isn't supported
|
||||
|
||||
If this node doesn't support the operation you want to do, you can use the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to call the service's API.
|
||||
|
||||
You can use the credential you created for this service in the HTTP Request node:
|
||||
|
||||
1. In the HTTP Request node, select **Authentication** > **Predefined Credential Type**.
|
||||
1. Select the service you want to connect to.
|
||||
1. Select your credential.
|
||||
|
||||
Refer to [Custom API operations](/integrations/custom-operations/) for more information.
|
||||
@ -1 +1 @@
|
||||
View n8n's [LangChain](/langchain/) documentation.
|
||||
View n8n's [Advanced AI](/advanced-ai/) documentation.
|
||||
|
||||
@ -1 +1 @@
|
||||
You can use this agent with the [On new manual Chat Message](/integrations/builtin/core-nodes/n8n-nodes-langchain.manualchattrigger/) node. Attach a memory sub-node so that users can have an ongoing conversation with multiple queries. Memory doesn't persist between sessions.
|
||||
You can use this agent with the [On new manual Chat Message](/integrations/builtin/core-nodes/n8n-nodes-langchain.chattrigger/) node. Attach a memory sub-node so that users can have an ongoing conversation with multiple queries. Memory doesn't persist between sessions.
|
||||
|
||||
@ -3,8 +3,8 @@ The Code node allows you to write custom JavaScript or Python and run it as a st
|
||||
/// note | Coding in n8n
|
||||
This page gives usage information about the Code node. For more guidance on coding in n8n, refer to the [Code](/code/) section. It includes:
|
||||
|
||||
* Reference documentation on [Built-in methods and variables](/code/builtin/)
|
||||
* Guidance on [Handling dates](/code/luxon/) and [Querying JSON](/code/jmespath/)
|
||||
* Reference documentation on [Built-in methods and variables](/code/builtin/overview/)
|
||||
* Guidance on [Handling dates](/code/cookbook/luxon/) and [Querying JSON](/code/cookbook/jmespath/)
|
||||
* A growing collection of examples in the [Cookbook](/code/cookbook/)
|
||||
///
|
||||
|
||||
@ -41,9 +41,14 @@ The Code node supports:
|
||||
|
||||
If you self-host n8n, you can import and use built-in and external npm modules in the Code node. To learn how to enable external modules, refer the [Configuration](/hosting/configuration/#use-built-in-and-external-modules-in-the-code-node) guide.
|
||||
|
||||
If you use n8n Cloud, you can't import external npm modules. n8n makes two modules available for you:
|
||||
|
||||
* [crypto Node.js module](https://nodejs.org/docs/latest-v18.x/api/crypto.html){:target=_blank .external-link}
|
||||
* [moment npm package](https://www.npmjs.com/package/moment){:target=_blank .external-link}
|
||||
|
||||
### Built-in methods and variables
|
||||
|
||||
n8n provides built-in methods and variables for working with data and accessing n8n data. Refer to [Built-in methods and variables](/code/builtin/) for more information.
|
||||
n8n provides built-in methods and variables for working with data and accessing n8n data. Refer to [Built-in methods and variables](/code/builtin/overview/) for more information.
|
||||
|
||||
The syntax to use the built-in methods and variables is `$variableName` or `$methodName()`. Type `$` in the Code node or expressions editor to see a list of suggested methods and variables.
|
||||
|
||||
@ -57,7 +62,7 @@ The Code node takes longer to process Python than JavaScript. This is due to the
|
||||
///
|
||||
### Built-in methods and variables
|
||||
|
||||
n8n provides built-in methods and variables for working with data and accessing n8n data. Refer to [Built-in methods and variables](/code/builtin/) for more information.
|
||||
n8n provides built-in methods and variables for working with data and accessing n8n data. Refer to [Built-in methods and variables](/code/builtin/overview/) for more information.
|
||||
|
||||
The syntax to use the built-in methods and variables is `_variableName` or `_methodName()`. Type `_` in the Code node to see a list of suggested methods and variables.
|
||||
|
||||
@ -87,7 +92,7 @@ n8n includes built-in methods and variables. These provide support for:
|
||||
* Accessing data about workflows, executions, and your n8n environment
|
||||
* Convenience variables to help with data and time
|
||||
|
||||
Refer to [methods and variables](/code-examples/methods-variables-reference/) for more information.
|
||||
Refer to [Built-in methods and variables](/code/builtin/overview) for more information.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2,5 +2,5 @@
|
||||
The node relies on the timezone setting. n8n uses either:
|
||||
|
||||
1. The workflow timezone, if set. Refer to [Workflow settings](/workflows/settings/) for more information.
|
||||
2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/environment-variables/environment-variables/#timezone-and-localization). Cloud admins can change the instance timezone in the [Admin dashboard](/manage-cloud/set-cloud-timezone/).
|
||||
2. The n8n instance timezone, if the workflow timezone isn't set. The default is `America/New York` for self-hosted instances. n8n Cloud tries to detect the instance owner's timezone when they sign up, falling back to GMT as the default. Self-hosted users can change the instance setting using [Environment variables](/hosting/configuration/environment-variables/timezone-localization). Cloud admins can change the instance timezone in the [Admin dashboard](/manage-cloud/set-cloud-timezone/).
|
||||
///
|
||||
|
||||
@ -1 +1 @@
|
||||
If you self-host n8n, you are responsible for deleting user data. If you need to delete data on behalf of one of your users, you can delete the respective execution. n8n recommends configuring n8n to prune execution data automatically every few days to avoid effortful GDPR request handling as much as possible. Configure this using the `EXECUTIONS_DATA_MAX_AGE` environment variable. Refer to [Environment variables](/hosting/environment-variables/environment-variables/) for more information.
|
||||
If you self-host n8n, you are responsible for deleting user data. If you need to delete data on behalf of one of your users, you can delete the respective execution. n8n recommends configuring n8n to prune execution data automatically every few days to avoid effortful GDPR request handling as much as possible. Configure this using the `EXECUTIONS_DATA_MAX_AGE` environment variable. Refer to [Environment variables](/hosting/configuration/environment-variables/) for more information.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/// note | Latest and Next versions
|
||||
n8n releases a new minor version most weeks. The `latest` version is for production use. `next` is the most recent release. You should treat `next` as a beta: it may be unstable. To report issues, use the [forum](https://community.n8n.io/c/questions/12){:target=_blank .external-link}.
|
||||
|
||||
Current `latest`: 1.29.1
|
||||
Current `next`: 1.30.1
|
||||
Current `latest`: 1.36.1
|
||||
Current `next`: 1.37.0
|
||||
///
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
* Learn more about [configuring](/hosting/environment-variables/) and [scaling](/hosting/scaling/) n8n.
|
||||
* Learn more about [configuring](/hosting/configuration/) and [scaling](/hosting/scaling/) n8n.
|
||||
* Or explore using n8n: try the [Quickstarts](/try-it-out/).
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
The steps to update your n8n depend on which n8n platform you use. Refer to the documentation for your n8n:
|
||||
|
||||
* [Cloud](/choose-n8n/cloud/)
|
||||
* [Self-hosted options](/hosting/installation/):
|
||||
* [Cloud](/manage-cloud/update-cloud-version/)
|
||||
* Self-hosted options:
|
||||
* [npm](/hosting/installation/npm/)
|
||||
* [Docker](/hosting/installation/docker/)
|
||||
|
||||
@ -1 +1 @@
|
||||
Subproject commit 199b01479f8770cee3a3b3456edf0103c68bd468
|
||||
Subproject commit 9e8c3d99dadb89624b67c0f9f28389d14dd7cbdd
|
||||
@ -8,6 +8,12 @@ df_types:
|
||||
- month
|
||||
- year
|
||||
df_string:
|
||||
- funcName: base64Encode
|
||||
returns: A base64 encoded string.
|
||||
description: Encode a string as base64.
|
||||
- funcName: base64Decode
|
||||
returns: A plain string.
|
||||
description: Convert a base64 encoded string to a normal string.
|
||||
- funcName: extractDomain
|
||||
returns: String
|
||||
description: Extracts a domain from a string containing a valid URL. Returns undefined if none is found.
|
||||
@ -17,6 +23,9 @@ df_string:
|
||||
- funcName: extractUrl
|
||||
returns: String
|
||||
description: Extracts a URL from a string. Returns undefined if none is found.
|
||||
- funcName: extractUrlPath
|
||||
returns: String
|
||||
description: Extract the path but not the root domain from a URL. For example, <code>"https://example.com/orders/1/details".extractUrlPath()</code> returns <code>"/orders/1/details/"</code>.
|
||||
- funcName: hash
|
||||
args:
|
||||
- argName: algo
|
||||
@ -55,6 +64,9 @@ df_string:
|
||||
- funcName: isUrl
|
||||
returns: Boolean
|
||||
description: Checks if a string is a valid URL.
|
||||
- funcName: parseJson
|
||||
returns: Object
|
||||
description: Equivalent of <code>JSON.parse()</code>. Parses a string as a JSON object.
|
||||
- funcName: quote
|
||||
args:
|
||||
- argName: mark
|
||||
@ -75,9 +87,12 @@ df_string:
|
||||
- funcName: removeTags
|
||||
returns: String
|
||||
description: Remove tags, such as HTML or XML, from a string.
|
||||
- funcName: toDate
|
||||
- funcName: toBoolean
|
||||
returns: Boolean
|
||||
description: Convert a string to a boolean. <code>"false"</code>, <code>"0"</code>, <code>""</code>, and <code>"no"</code> convert to <code>false</code>.
|
||||
- funcName: toDateTime
|
||||
returns: Date
|
||||
description: Converts a string to a date.
|
||||
description: Converts a string to a <a href="https://docs.n8n.io/code/cookbook/luxon/">Luxon date object</a>.
|
||||
- funcName: toDecimalNumber
|
||||
returns: Number
|
||||
description: See <a href="#string-toFloat">toFloat</a>
|
||||
@ -171,6 +186,9 @@ df_object:
|
||||
- funcName: compact
|
||||
returns: Object
|
||||
description: Removes empty values from an Object.
|
||||
- funcName: toJsonString
|
||||
returns: String
|
||||
description: Convert an object to a JSON string. Equivalent of <code>JSON.stringify</code>.
|
||||
- funcName: urlEncode
|
||||
returns: String
|
||||
description: Transforms an Object into a URL parameter list. Only top-level keys are supported.
|
||||
@ -212,6 +230,18 @@ df_number:
|
||||
description: How many decimal places to round to.
|
||||
returns: Number
|
||||
description: Returns the value of a number rounded to the nearest whole number, unless a decimal place is specified.
|
||||
- funcName: toBoolean
|
||||
returns: Boolean
|
||||
description: Converts a number to a boolean. <code>0</code> converts to <code>false</code>. All other values convert to <code>true</code>.
|
||||
- funcName: toDateTime
|
||||
args:
|
||||
- argName: format
|
||||
optional: true
|
||||
longName: String
|
||||
type: String enum
|
||||
description: Can be <code>ms</code> (milliseconds), <code>s</code> (seconds), or <code>excel</code> (Excel 1900). Defaults to milliseconds.
|
||||
returns: Date
|
||||
description: Converts a number to a <a href="https://docs.n8n.io/code/cookbook/luxon/">Luxon date object</a>.
|
||||
df_date:
|
||||
- funcName: beginningOf
|
||||
args:
|
||||
@ -316,6 +346,9 @@ df_date:
|
||||
options: *df_durationUnit
|
||||
returns: Date
|
||||
description: Adds a given time period to a Date. Returns either a JavaScript Date or Luxon Date, depending on input.
|
||||
- funcName: toDateTime
|
||||
returns: Date
|
||||
description: Converts a JavaScript date to a <a href="https://docs.n8n.io/code/cookbook/luxon/">Luxon date object</a>.
|
||||
df_array:
|
||||
- funcName: average
|
||||
returns: Number
|
||||
@ -432,6 +465,9 @@ df_array:
|
||||
- funcName: sum
|
||||
returns: Number
|
||||
description: Returns the total sum all the values in an array of parsable numbers.
|
||||
- funcName: toJsonString
|
||||
returns: String
|
||||
description: Convert an array to a JSON string. Equivalent of <code>JSON.stringify</code>.
|
||||
- funcName: union
|
||||
args:
|
||||
- argName: arr
|
||||
@ -450,3 +486,7 @@ df_array:
|
||||
description: A key, or comma-separated list of keys, to check for duplicates.
|
||||
returns: Array
|
||||
description: Remove duplicates from an array.
|
||||
df_boolean:
|
||||
- funcName: toInt
|
||||
returns: Number
|
||||
description: Convert a boolean to a number. <code>false</code> converts to <code>0</code>, <code>true</code> converts to <code>1</code>.
|
||||
|
||||
@ -131,7 +131,7 @@ If you build custom nodes, refer to [HTTP request helpers](/integrations/creatin
|
||||
|
||||
### Removed WEBHOOK_TUNNEL_URL
|
||||
|
||||
As of version 0.227.0, n8n has renamed the `WEBHOOK_TUNNEL_URL` configuration option to `WEBHOOK_URL`. In n8n 1.0, `WEBHOOK_TUNNEL_URL` has been removed. Update your setup to reflect the new name. For more information about this configuration option, refer to [the docs](/hosting/environment-variables/configuration-methods/#webhook-url).
|
||||
As of version 0.227.0, n8n has renamed the `WEBHOOK_TUNNEL_URL` configuration option to `WEBHOOK_URL`. In n8n 1.0, `WEBHOOK_TUNNEL_URL` has been removed. Update your setup to reflect the new name. For more information about this configuration option, refer to [the docs](/hosting/configuration/configuration-methods/#webhook-url).
|
||||
|
||||
[PR #1408](https://github.com/n8n-io/n8n/pull/1408){:target=_blank .external link}
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@
|
||||
--color-text-base: #58585F;
|
||||
--color-text-dark: #555555;
|
||||
--color-background-base: #f2f4f8;
|
||||
--color-background-dark: #101330;
|
||||
--color-background-dark: #40425E;
|
||||
--color-background-darker: hsl( 240, 4.2%, 14% );
|
||||
--color-background-light: #f2f4f8;
|
||||
--color-foreground-base: #dbdfe7;
|
||||
@ -92,6 +92,7 @@
|
||||
[data-md-color-scheme="light"] .md-search__input {
|
||||
border: 1px solid var(--color-foreground-base);
|
||||
background-color: white;
|
||||
color: var(--color-text-dark);
|
||||
}
|
||||
|
||||
[data-md-color-scheme="light"] .md-search__input::placeholder {
|
||||
@ -174,6 +175,15 @@
|
||||
.md-typeset table:not([class]) {
|
||||
font-size: 0.75rem
|
||||
}
|
||||
|
||||
/* display tables at full width */
|
||||
.md-typeset__table {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.md-typeset__table table:not([class]) {
|
||||
display: table
|
||||
}
|
||||
|
||||
/* img borders */
|
||||
|
||||
@ -219,6 +229,12 @@
|
||||
background-color: var(--color-text-base);
|
||||
}
|
||||
|
||||
/* better left nav spacing */
|
||||
|
||||
.md-nav__item--section {
|
||||
margin-top: 1.75em;
|
||||
}
|
||||
|
||||
/* extra top nav */
|
||||
|
||||
.n8n-top-nav {
|
||||
@ -226,7 +242,7 @@
|
||||
}
|
||||
|
||||
.n8n-top-nav-list {
|
||||
border-bottom: 1px solid hsl(170, 69%, 35%, 0.5);
|
||||
border-bottom: 1px solid #707183;
|
||||
}
|
||||
|
||||
/* ensure headings don't disappear below top nav after adding extra top nav */
|
||||
|
||||
|
Before Width: | Height: | Size: 168 KiB After Width: | Height: | Size: 157 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 90 KiB After Width: | Height: | Size: 97 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 119 KiB After Width: | Height: | Size: 123 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 85 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 120 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 69 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 110 KiB |
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 102 KiB |
|
Before Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 212 KiB |
|
Before Width: | Height: | Size: 235 KiB |
|
Before Width: | Height: | Size: 229 KiB |
|
Before Width: | Height: | Size: 225 KiB |
|
Before Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 286 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 228 KiB |
|
Before Width: | Height: | Size: 241 KiB |
|
Before Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 834 KiB |
|
Before Width: | Height: | Size: 236 KiB |
|
Before Width: | Height: | Size: 220 KiB |
|
Before Width: | Height: | Size: 244 KiB |
|
Before Width: | Height: | Size: 216 KiB |
|
Before Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 145 KiB |
|
Before Width: | Height: | Size: 121 KiB |
|
Before Width: | Height: | Size: 139 KiB |
|
Before Width: | Height: | Size: 133 KiB |
|
Before Width: | Height: | Size: 222 KiB |
|
Before Width: | Height: | Size: 201 KiB |
|
Before Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 157 KiB |
|
Before Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 160 KiB |
|
Before Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 143 KiB |
|
Before Width: | Height: | Size: 140 KiB |
|
Before Width: | Height: | Size: 257 KiB |
|
Before Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 204 KiB |
|
Before Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 176 KiB |
|
Before Width: | Height: | Size: 213 KiB |
|
Before Width: | Height: | Size: 201 KiB |
|
Before Width: | Height: | Size: 160 KiB |
|
Before Width: | Height: | Size: 192 KiB |
|
Before Width: | Height: | Size: 192 KiB |
|
Before Width: | Height: | Size: 188 KiB |
|
Before Width: | Height: | Size: 195 KiB |
|
Before Width: | Height: | Size: 138 KiB |