Merge branch 'master' into update/date-time
@ -2,7 +2,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
These are a set of guidelines to contribute to this repository, helping ensure consistency and quality.
|
||||
If you want to contribute to this repository - thank you! Beforehand, we encourage you to have a look at the existing documentation to get an idea of the structure and writing conventions we use. In writing your documentation, please follow the guidelines described below, in order to ensure quality and consistency with our style.
|
||||
|
||||
## Documentation files
|
||||
|
||||
@ -14,39 +14,52 @@ These are a set of guidelines to contribute to this repository, helping ensure c
|
||||
|
||||
## Writing guidelines
|
||||
|
||||
* Follow the structure and writing conventions of the existing documentation. Consistency is the key.
|
||||
- In the node documentation README.md
|
||||
- Under "Basic Operations", enter the resources and operations exactly as they are named in the nodes.
|
||||
- Under "Example Usage", ensure that the link of the relevant node remains empty.
|
||||
- Exclude any optional steps from the example usage steps for the relevant node.
|
||||
- Create a workflow at [n8n.io](https://n8n.io/workflows) and use the resulting link in "Example Usage".
|
||||
- If there is a relevant n8n [Medium](https://medium.com/n8n-io) article, include it under "Further Reading". The resulting list should be ordered alphabetically. See the [Telegram node](https://docs.n8n.io/nodes/n8n-nodes-base.telegram/).
|
||||
- In the credentials README.md
|
||||
- If there is more than one authentication method, list OAuth first.
|
||||
- If there are steps that are necessary but out of the scope of creating a node in n8n, move them to the FAQ section. See the [Chargebee Trigger node](https://docs.n8n.io/nodes/n8n-nodes-base.chargebeeTrigger/).
|
||||
### Content
|
||||
A standard **node documentation** `README.md` includes the following parts:
|
||||
* Node Description
|
||||
- Describe briefly the purpose and function of the node.
|
||||
* Basic Operations
|
||||
- Enter the resources and operations exactly as they are named in the nodes.
|
||||
* Example Usage
|
||||
- Ensure that the link of the relevant node remains empty.
|
||||
- Exclude any optional steps from the example usage steps for the relevant node.
|
||||
- Create a workflow at [n8n.io](https://n8n.io/workflows) and use the resulting link in "Example Usage".
|
||||
* Further Reading
|
||||
- Include n8n [Medium](https://medium.com/n8n-io) articles that are relevant for the specific node. The resulting list should be ordered alphabetically. See the [Telegram node](https://docs.n8n.io/nodes/n8n-nodes-base.telegram/).
|
||||
|
||||
In the **credentials** `README.md`:
|
||||
* If there is more than one authentication method, list OAuth first.
|
||||
* If there are steps that are necessary but out of the scope of creating a node in n8n, move them to the FAQ section. See the [Chargebee Trigger node](https://docs.n8n.io/nodes/n8n-nodes-base.chargebeeTrigger/).
|
||||
|
||||
|
||||
### Style
|
||||
* Explain clearly each step of the process or changes you make.
|
||||
* Keep your writing as concise as possible.
|
||||
* Make sure to include commit messages in [this](https://gist.github.com/parmentf/035de27d6ed1dce0b36a) format.
|
||||
* Use present tense, active voice, and "you"-form to address the readers.
|
||||
* Spell out correctly the names of organisations or brands. For example: "GitHub", not "Github".
|
||||
* Use correct spelling and grammar. [Grammarly](https://www.grammarly.com/) is a good tool to help you with that.
|
||||
* Add commit messages in [this](https://gist.github.com/parmentf/035de27d6ed1dce0b36a) format.
|
||||
|
||||
### Screenshots
|
||||
|
||||
## Screenshot guidelines
|
||||
If your contribution includes screenshots, please make sure that they meet the following criteria:
|
||||
|
||||
Please make sure that the screenshots match the following criteria.
|
||||
|
||||
- Please ensure that only the Editor UI appears in the screenshot. Anything else like the browser frame, tabs, and so on should be omitted.
|
||||
- After zooming in once, the Editor UI should be 23 boxes wide and 9 boxes tall.
|
||||
- The nodes should have a distance of two boxes between them.
|
||||
- The nodes should fit inside the boxes (as much as they can).
|
||||
- Please make sure that the workflow is centered in the Editor canvas.
|
||||
- If the workflow uses a Trigger node, please ensure that the Start node doesn't appear in the Editor canvas.
|
||||
- When recording GIFs, please ensure that the cursor movements in the GIF are slow and easy to follow. A good rule of thumb is that the speed should be about 75% of your regular speed.
|
||||
- Only the Editor UI appears in the screenshot. Anything else, like the browser frame, tabs, and so on, should be omitted.
|
||||
- After zooming in once, the Editor UI is 23 boxes wide and 9 boxes tall.
|
||||
- The nodes have a distance of two boxes between them.
|
||||
- The nodes fit inside the boxes (as much as they can).
|
||||
- The workflow is centered in the Editor canvas.
|
||||
- If the workflow uses a Trigger node, the Start node doesn't appear in the Editor canvas.
|
||||
- In recorded GIFs, the cursor movements in the GIF are slow and easy to follow. A good rule of thumb is that the speed should be about 75% of your regular speed. In any case, make sure that GIFs capture every step of the process at a steady pace.
|
||||
|
||||
|
||||
## General checklist
|
||||
|
||||
The following is a list of common errors that you can use to check your work locally before submitting a PR:
|
||||
Before submitting a PR, make sure your contribution ticks all these boxes:
|
||||
|
||||
- [ ] Check spelling and grammar. [Grammarly](https://www.grammarly.com/) is a good tool to help.
|
||||
- [ ] Check for any broken links.
|
||||
- [ ] Ensure that branding is correct. For example, "GitHub", not "Github".
|
||||
- [ ] Ensure that GIFs capture every step of the process at a uniform pace.
|
||||
- [ ] Ensure all documentation files end with an empty newline.
|
||||
- [ ] All necessary files and images are included.
|
||||
- [ ] All links are working and direct to the right location.
|
||||
- [ ] All documentation files end with an empty newline.
|
||||
- [ ] The commit message describes clearly and succintly the changes you made.
|
||||
- [ ] The PR explains clearly and succintly the changes you made and why they are necessary.
|
||||
- [ ] You have read and accepted the [code of conduct](https://github.com/n8n-io/n8n-docs/blob/master/CODE_OF_CONDUCT.md) and [contributor license agreement](https://github.com/n8n-io/n8n-docs/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.md).
|
||||
|
||||
@ -120,11 +120,11 @@ module.exports = {
|
||||
// },
|
||||
{
|
||||
text: 'Nodes',
|
||||
link: '/nodes/nodes.md',
|
||||
link: '/nodes/',
|
||||
},
|
||||
{
|
||||
text: 'Reference',
|
||||
link: '/reference/reference.md',
|
||||
link: '/reference/',
|
||||
},
|
||||
{
|
||||
text: 'Community',
|
||||
@ -144,23 +144,8 @@ module.exports = {
|
||||
{
|
||||
title: '🧬 Overview',
|
||||
sidebarDepth: 2,
|
||||
children: [
|
||||
{
|
||||
title: 'Node Overview',
|
||||
sidebarDepth: 2,
|
||||
path: 'nodes.md',
|
||||
},
|
||||
{
|
||||
title: 'Node Basics',
|
||||
sidebarDepth: 2,
|
||||
path: 'node-basics.md',
|
||||
},
|
||||
{
|
||||
title: 'Expressions',
|
||||
sidebarDepth: 2,
|
||||
path: 'expressions.md',
|
||||
},
|
||||
]
|
||||
path: '/nodes/',
|
||||
children: getChildrenFiles('nodes'),
|
||||
},
|
||||
{
|
||||
title: '🔬 Creating Nodes',
|
||||
@ -170,20 +155,24 @@ module.exports = {
|
||||
{
|
||||
title: '🧠 Nodes Library',
|
||||
sidebarDepth: 3,
|
||||
path: '/nodes/nodes-library',
|
||||
children: [
|
||||
{
|
||||
title: 'Core Nodes',
|
||||
sidebarDepth: 1,
|
||||
path: '/nodes/nodes-library/core-nodes',
|
||||
children: getChildrenFolders('nodes/nodes-library/core-nodes'),
|
||||
},
|
||||
{
|
||||
title: 'Nodes',
|
||||
sidebarDepth: 1,
|
||||
path: '/nodes/nodes-library/nodes',
|
||||
children: getChildrenFolders('nodes/nodes-library/nodes'),
|
||||
},
|
||||
{
|
||||
title: 'Trigger Nodes',
|
||||
sidebarDepth: 1,
|
||||
path: '/nodes/nodes-library/trigger-nodes',
|
||||
children: getChildrenFolders('nodes/nodes-library/trigger-nodes'),
|
||||
},
|
||||
],
|
||||
@ -191,6 +180,7 @@ module.exports = {
|
||||
{
|
||||
title: '🔑 Credentials Library',
|
||||
sidebarDepth: 2,
|
||||
path: '/nodes/credentials',
|
||||
children: getChildrenFolders('nodes/credentials'),
|
||||
},
|
||||
],
|
||||
@ -198,7 +188,7 @@ module.exports = {
|
||||
'/reference/': [
|
||||
{
|
||||
title: '📚 Overview',
|
||||
path: 'reference.md',
|
||||
path: '/reference/',
|
||||
},
|
||||
{
|
||||
title: '🧐 Changelog',
|
||||
@ -216,10 +206,6 @@ module.exports = {
|
||||
title: '🚔 Security',
|
||||
path: 'security.md',
|
||||
},
|
||||
{
|
||||
title: '📦 Docker',
|
||||
path: 'docker.md',
|
||||
},
|
||||
{
|
||||
title: '🖥 Server Setup',
|
||||
path: 'server-setup.md',
|
||||
@ -288,6 +274,7 @@ module.exports = {
|
||||
},
|
||||
{
|
||||
title: '💪 Create Your First Workflow',
|
||||
path: '/getting-started/create-your-first-workflow/',
|
||||
children: getChildrenFolders('getting-started/create-your-first-workflow'),
|
||||
|
||||
},
|
||||
|
||||
29
docs/nodes/credentials/APITemplateIo/README.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
permalink: /credentials/apiTemplateIo
|
||||
description: Learn to configure credentials for the APITemplate.io node in n8n
|
||||
---
|
||||
|
||||
# APITemplate.io
|
||||
|
||||
You can use these credentials to authenticate the following nodes with APITemplate.io.
|
||||
- [APITemplate.io](../../nodes-library/nodes/APITemplateIo/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create an [APITemplate.io](https://apitemplate.io/) account.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Open your APITemplate.io [dashboard](https://app.apitemplate.io).
|
||||
2. Click on ***API Integration*** on the left sidebar.
|
||||
3. Click on the ***Copy text*** button to copy the API key.
|
||||
4. Enter a name for your credentials in the ***Credentials Name*** field in the 'APITemplate.io API' credentials in n8n.
|
||||
5. Paste the API key in the ***API Key*** field in the 'APITemplate.io API' credentials in n8n.
|
||||
6. Click on the ***Create*** button to create the credentials.
|
||||
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/NUAkybjCGa8" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
@ -6,6 +6,8 @@ description: Learn to configure credentials for the AWS nodes in n8n
|
||||
# AWS
|
||||
|
||||
You can use these credentials to authenticate the following nodes with AWS.
|
||||
|
||||
- [AWS Comprehend](../../nodes-library/nodes/AWSComprehend/README.md)
|
||||
- [AWS Lambda](../../nodes-library/nodes/AWSLambda/README.md)
|
||||
- [AWS Rekognition](../../nodes-library/nodes/AWSRekognition/README.md)
|
||||
- [AWS S3](../../nodes-library/nodes/AWSS3/README.md)
|
||||
@ -13,17 +15,27 @@ You can use these credentials to authenticate the following nodes with AWS.
|
||||
- [AWS SNS](../../nodes-library/nodes/AWSSNS/README.md)
|
||||
- [AWS SNS Trigger](../../nodes-library/trigger-nodes/AWSSNSTrigger/README.md)
|
||||
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create an [AWS](https://aws.amazon.com/) account.
|
||||
|
||||
## Using Access Token
|
||||
|
||||
1. Open your AWS Management Console.
|
||||
1. Open your [AWS Management Console](https://console.aws.amazon.com).
|
||||
2. Click on your name on the top right and select 'My Security Credentials' from the dropdown.
|
||||
3. Under the Access keys dropdown, click on the 'Create New Access Key' button.
|
||||
4. Click on 'Show Access Key' to retrieve your ID and key for use with your AWS node credentials in n8n.
|
||||
3. Click on the ***Create New Access Key*** button, under the ***Access keys (access key ID and secret access key)*** section
|
||||
4. Click on the ***Show Access Key*** button.
|
||||
5. Copy the displayed Access Key ID.
|
||||
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'AWS' credentials in n8n.
|
||||
7. Paste the Access Key ID in the ***Access Key ID*** field in the 'AWS' credentials in n8n.
|
||||
8. Copy the secret access key from your AWS console.
|
||||
9. Paste the secret access key in the ***Secret Access Key*** field in the 'AWS' credentials in n8n.
|
||||
10. Click the ***Create*** button to save your credentials in n8n.
|
||||
|
||||

|
||||
**Note:** If you're running your AWS instance in a different region, please update the ***Region*** field accordingly.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zJgHOSSwC4A" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
Before Width: | Height: | Size: 1.1 MiB |
31
docs/nodes/credentials/Autopilot/README.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
permalink: /credentials/autopilot
|
||||
description: Learn to configure credentials for the Autopilot node in n8n
|
||||
---
|
||||
|
||||
# Autopilot
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Autopilot.
|
||||
- [Autopilot](../../nodes-library/nodes/Autopilot/README.md)
|
||||
- [Autopilot Trigger](../../nodes-library/trigger-nodes/AutopilotTrigger/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create an [Autopilot](autopilothq.com) account.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Open your Autopilot [dashboard](https://app.autopilothq.com).
|
||||
2. Click on the gears icon on the left sidebar to open the ***Settings*** menu.
|
||||
3. Click on ***Autopilot API***.
|
||||
4. Click on the ***Generate*** button to create the API key.
|
||||
5. Copy the displayed API key.
|
||||
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'Autopilot API' credentials in n8n.
|
||||
7. Paste the API key in the ***API Key*** field in the 'Autopilot API' credentials in n8n.
|
||||
8. Click on the ***Create*** button to create the credentials.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zy8uVHpwVHM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
@ -15,16 +15,35 @@ Create a [Customer.io](https://customer.io/) account.
|
||||
|
||||
## Using Access Token
|
||||
|
||||
1. Open your Customer.io dashboard.
|
||||
1. Open your Customer.io [dashboard](https://fly.customer.io).
|
||||
2. Click on the user icon in the top right and select ***Account settings***.
|
||||
3. Click on ***API Credentials***.
|
||||
4. Click on the ***Create Tracking API Key*** button.
|
||||
5. Enter a name for the Tracking API Key in the ***Name*** field, select a workspace, and click on the ***Create Tracking API Key*** button.
|
||||
6. Use the displayed ***Site ID*** and ***API Key*** with your Customer.io API credentials in n8n.
|
||||
7. Next, click on the ***App API Keys*** tab in the 'Manage API Credentials' page.
|
||||
8. Click on the ***Create App API Key*** button.
|
||||
9. Enter a name for the App API Key in the ***Name*** field, select a workspace, and click on the ***Create App API Key*** button.
|
||||
10. Use the displayed API Key with your Customer.io API credentials in n8n.
|
||||
11. Click on the ***Save*** button to save your credentials.
|
||||
5. Enter a name for the Tracking API Key in the ***Name***.
|
||||
6. Select a workspace from the ***Workspace*** dropdown list.
|
||||
7. Click on the ***Create Tracking API Key*** button.
|
||||
8. Copy the displayed 'Site ID'.
|
||||
9. Enter the name for your credentials in the ***Credentials Name*** field in the 'Customer.io API' credentials in n8n.
|
||||
10. Paste the Site ID in the ***Tracking Site ID*** field in the 'Customer.io API' credentials in n8n.
|
||||
11. Copy the 'API Key' from the Manage API Credentials page.
|
||||
12. Paste the API key in the ***Tracking API Key*** field in the 'Customer.io API' credentials in n8n.
|
||||
13. Click on the ***App API Keys*** tab on the Manage API Credentials page.
|
||||
14. Click on the ***Create App API Key*** button.
|
||||
15. Enter a name for the App API Key in the ***Name*** field.
|
||||
16. Select a workspace from the ***Workspace*** dropdown list.
|
||||
17. Click on the ***Create App API Key*** button.
|
||||
18. Copy the displayed API key.
|
||||
19. Paste the API key in the ***App API Key*** field in the 'Customer.io API' credentials in n8n.
|
||||
20. Click on the ***Create*** button to create your credentials.
|
||||
|
||||

|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/LAFExR62-VA" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
## FAQs
|
||||
|
||||
### Why do I need the Tracking API Key and the App API Key?
|
||||
|
||||
Customer.io uses different API Keys for different endpoints. Based on the operation you want to perform, n8n uses the correct API key to connect to your Customer.io account.
|
||||
|
Before Width: | Height: | Size: 560 KiB |
29
docs/nodes/credentials/DeepL/README.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
permalink: /credentials/deepL
|
||||
description: Learn to configure credentials for the DeepL node in n8n
|
||||
---
|
||||
|
||||
# DeepL
|
||||
|
||||
You can use these credentials to authenticate the following nodes with DeepL.
|
||||
- [DeepL](../../nodes-library/nodes/DeepL/README.md)
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create a DeepL [developer](https://www.deepl.com/pro/change-plan#developer) account.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Open your DeepL [account](https://www.deepl.com/pro-account) page.
|
||||
2. Scroll down to the ***Authentication Key for DeepL API*** section.
|
||||
3. Copy the displayed 'API Key'.
|
||||
4. Enter the name for your credentials in the ***Credentials Name*** field in the 'DeepL API' credentials in n8n.
|
||||
5. Paste the API key in the ***API Key*** field in the 'DeepL API' credentials in n8n.
|
||||
6. Click on the ***Create*** button to create your credentials in n8n.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/y-yjqXBzCqc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
29
docs/nodes/credentials/Emelia/README.md
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
permalink: /credentials/emelia
|
||||
description: Learn to configure credentials for the Emelia node in n8n
|
||||
---
|
||||
|
||||
# Emelia
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Emelia.
|
||||
- [Emelia](../../nodes-library/nodes/Emelia/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create a [Emelia](https://emelia.io) account.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Open the Emelia [dashboard](https://app.emelia.io/) page.
|
||||
2. Click on the avatar on the top-right and select 'API Keys'.
|
||||
3. Click on the ***Generate new API key*** button.
|
||||
4. Click on the menu icon and select 'Copy API Key' from the dropdown list.
|
||||
5. Enter a name for your credentials in the ***Credentials Name*** field in the 'Emelia API' credentials in n8n.
|
||||
6. Paste the API key in the ***API Key*** field in the 'Emelia API' credentials in n8n.
|
||||
7. Click the ***Create*** button to create your credentials in n8n.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/XZ4wP1AI9eM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
30
docs/nodes/credentials/Lemlist/README.md
Normal file
@ -0,0 +1,30 @@
|
||||
---
|
||||
permalink: /credentials/lemlist
|
||||
description: Learn to configure credentials for the Lemlist node in n8n
|
||||
---
|
||||
|
||||
# Lemlist
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Lemlist.
|
||||
- [Lemlist](../../nodes-library/nodes/Lemlist/README.md)
|
||||
- [Lemlist Trigger](../../nodes-library/trigger-nodes/LemlistTrigger/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create an account on a [Lemlist](https://www.lemlist.com/) instance.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Open your Lemlist [dashboard](https://app.lemlist.com/).
|
||||
2. Click on the menu on the top left and select 'Settings' from the dropdown list.
|
||||
3. Click on ***Integrations*** under the ***Misc*** section from the left sidebar.
|
||||
4. Copy the API key displayed under the ***API*** section.
|
||||
5. Enter the name for your credentials in the ***Credentials Name*** field in the 'Lemlist API' credentials in n8n.
|
||||
6. Paste the API key in the ***API Key*** field in the 'Lemlist API' credentials in n8n.
|
||||
7. Click on the ***Create*** button to create your credentials.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/MWjHr2qw5XA" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
@ -10,15 +10,21 @@ You can use these credentials to authenticate the following nodes with LingvaNex
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create a [LingvaNex](https://lingvaNex.com) account.
|
||||
Create a [LingvaNex](https://lingvanex.com) account.
|
||||
|
||||
## Using API
|
||||
|
||||
1. Access your [LingvaNex user control panel](https://lingvanex.com/account/) page.
|
||||
2. Scroll to the ***API*** section at bottom of the page.
|
||||
3. Click on the ***Generate Key*** button.
|
||||
4. Enter a title in the ***Title*** field.
|
||||
5. Click on the ***Create*** button.
|
||||
6. Use the ***API Key*** with your LingavaNex node credentials in n8n.
|
||||
1. Open your LingvaNex [account](https://lingvanex.com/account/) page.
|
||||
2. Click on the ***Cloud API*** tab.
|
||||
3. Click on ***Payment / Subscription***. Note that you can use the limited Translation API without having to subscribe or add a payment method.
|
||||
4. Scroll to the ***Translation API*** section.
|
||||
5. Copy the displayed API key.
|
||||
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'LingvaNex API' credentials in n8n.
|
||||
7. Paste the API key in the ***API Key*** field in the 'LingvaNex API' credentials in n8n.
|
||||
8. Click on the ***Create*** button to create your credentials.
|
||||
|
||||

|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/u-gqbI-Ape8" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
|
Before Width: | Height: | Size: 2.0 MiB |
31
docs/nodes/credentials/PostHog/README.md
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
permalink: /credentials/postHog
|
||||
description: Learn to configure credentials for the PostHog node in n8n
|
||||
---
|
||||
|
||||
# PostHog
|
||||
|
||||
You can use these credentials to authenticate the following nodes with PostHog.
|
||||
- [PostHog](../../nodes-library/nodes/PostHog/README.md)
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create a [PostHog](https://posthog.com/) account or host PostHog on your server.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Open your PostHog dashboard.
|
||||
2. Click on ***Project*** on the left sidebar.
|
||||
3. Click on the ***Safety & Privacy*** tab.
|
||||
4. Scroll down to the ***Project API Key*** section and copy the displayed API key.
|
||||
5. Enter a name for your credentials in the ***Credentials Name*** field in the 'PostHog API' credentials in n8n.
|
||||
6. If you're hosting PostHog on your own server, update the URL of your PostHog instance in the ***URL*** field.
|
||||
7. Paste the API key in the ***API Key*** field in the 'PostHog API' credentials in n8n.
|
||||
8. Click on the ***Create*** button to create your credentials.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zK1sy6kUarE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
@ -1,17 +1,3 @@
|
||||
# Credentials
|
||||
|
||||
Information about different credentials in n8n.
|
||||
|
||||
## Redirect URI
|
||||
|
||||
When you are using OAuth2 authentication with a node in n8n, you must pass what is called a redirect URI to the respective node platform you are using (for instance, Slack or Google API).
|
||||
|
||||
This redirect URI is given to you by n8n and you can find it in the credentials menu when you are entering the OAuth2 data.
|
||||
|
||||

|
||||
|
||||
This redirect URI must be set by you in the node platform you are using as mentioned. In the below example we're setting it up for Slack.
|
||||
|
||||

|
||||
|
||||
|
||||
This section contains step-by-step information about authenticating the different nodes in n8n.
|
||||
|
||||
37
docs/nodes/credentials/Wise/README.md
Normal file
@ -0,0 +1,37 @@
|
||||
---
|
||||
permalink: /credentials/wise
|
||||
description: Learn to configure credentials for the Wise node in n8n
|
||||
---
|
||||
|
||||
# Wise
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Wise.
|
||||
- [Wise](../../nodes-library/nodes/Wise/README.md)
|
||||
- [Wise Trigger](../../nodes-library/trigger-nodes/WiseTrigger/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create a [Wise](https://wise.com/) account.
|
||||
|
||||
## Using API Token
|
||||
|
||||
1. Open your Wise [dashboard](https://wise.com/user/account/).
|
||||
2. Click on the username on the top right and select 'Settings' from the dropdown list.
|
||||
3. Scroll down to the bottom and click on ***API tokens***.
|
||||
4. Click on the ***Add new token*** button.
|
||||
5. Enter a name in the ***Name or description*** field.
|
||||
6. Click on the ***Create token*** button.
|
||||
7. Scroll down to the bottom and click on ***API tokens***.
|
||||
8. Click on ***Reveal key*** to reveal the newly generated API key.
|
||||
9. Enter your Wise account password in the ***Please enter your password*** field.
|
||||
10. Copy the displayed API key.
|
||||
11. Enter the name for your credentials in the ***Credentials Name*** field in the 'Wise API' credentials in n8n.
|
||||
12. Paste the API key in the ***API Token*** field in the 'Wise API' credentials in n8n.
|
||||
13. If you're using a Wise sandbox account, select 'Test' from the ***Environment*** dropdown list in the 'Wise API' credentials in n8n.
|
||||
14. Click on the ***Create*** button to create your credentials.
|
||||
|
||||
The following video demonstrates the steps mentioned above.
|
||||
|
||||
<div class="video-container">
|
||||
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/hys2lDEScUE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
</div>
|
||||
9
docs/nodes/nodes-library/README.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Nodes Library
|
||||
|
||||
This section contains information about all the nodes in n8n. Each node documentation contains information on the available resources and operations along with an example workflow.
|
||||
|
||||
This library is divided into three sections for the different kinds of nodes:
|
||||
|
||||
- [Core Nodes](./core-nodes/README.md)
|
||||
- [Nodes](./nodes/README.md)
|
||||
- [Trigger Nodes](./trigger-nodes/README.md)
|
||||
@ -1,3 +1,3 @@
|
||||
# Code Nodes
|
||||
|
||||
Information about different core nodes in n8n.
|
||||
This section contains information about all the core nodes in n8n. Each node documentation contains information on the available resources and operations along with an example workflow.
|
||||
|
||||
@ -71,3 +71,17 @@ return [
|
||||
:::
|
||||
|
||||

|
||||
|
||||
## FAQs
|
||||
|
||||
### How to identify that no items are left to be processed by the node?
|
||||
::: v-pre
|
||||
To identify if items are left to be processed by node use the following expression: `{{$node["SplitInBatches"].context["noItemsLeft"]}}`. This expression returns a boolean value. If there is data yet to be processed, the expression will return `false`, otherwise `true`.
|
||||
:::
|
||||
Refer to this [workflow](https://n8n.io/workflows/995) to try it out.
|
||||
|
||||
### How to get the current running index of the node?
|
||||
::: v-pre
|
||||
To get the current running index of the node, use the following expression: `{{$node["SplitInBatches"].context["currentRunIndex"];}}`.
|
||||
:::
|
||||
Refer to this [workflow](https://n8n.io/workflows/996) to try it out.
|
||||
|
||||
|
After Width: | Height: | Size: 187 KiB |
102
docs/nodes/nodes-library/nodes/APITemplateIo/README.md
Normal file
@ -0,0 +1,102 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.apiTemplateIo
|
||||
description: Learn how to use the APITemplate.io node in n8n
|
||||
---
|
||||
|
||||
# APITemplate.io
|
||||
|
||||
[APITemplate.io](https://apitemplate.io) allows you to auto-generate images and PDF documents.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/APITemplateIo/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Account
|
||||
- Get
|
||||
:::
|
||||
|
||||
::: details Image
|
||||
- Create
|
||||
:::
|
||||
|
||||
::: details PDF
|
||||
- Create
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create an invoice with the information received via a Typeform submission. You can also find the [workflow](https://n8n.io/workflows/989) on n8n.io. This example usage workflow would use the following nodes.
|
||||
- [Typeform Trigger](../../trigger-nodes/TypeformTrigger/README.md)
|
||||
- [APITemplate.io]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Typeform Trigger node
|
||||
|
||||
This node will trigger the workflow when a form is submitted. Make sure to create a form that collects the following information:
|
||||
- Bill To (Short Text)
|
||||
- Client's Email Address (Email)
|
||||
- Item Description (Short Text)
|
||||
- Item Price (Number)
|
||||
- Item Description (Short Text)
|
||||
- Item Price (Number)
|
||||
|
||||
1. Select 'Access Token' from the ***Authentication*** dropdown list.
|
||||
2. Enter the credentials for the Typeform Trigger node. You can find out how to do that [here](../../../credentials/Typeform/README.md).
|
||||
3. Select the invoice form from the ***Form*** dropdown list.
|
||||
4. Toggle ***Simplify Answers*** to `false`. By setting this option to false, the node returns the values for the fields with duplicate names.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node triggers the workflow when the form is submitted. We will pass this information to the next nodes in the workflow.
|
||||
|
||||

|
||||
|
||||
### 2. APITemplate.io node (create: pdf)
|
||||
|
||||
This node will generate an invoice using the information from the previous node. Create an invoice template in APITemplate.io, if you don't already have one.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the APITemplate.io node. You can find out how to do that [here](../../../credentials/APITemplateIo/README.md).
|
||||
2. Select 'PDF' from the ***Resource*** dropdown list.
|
||||
3. Select your invoice template from the ***Template ID*** dropdown list.
|
||||
4. Toggle ***JSON Parameters*** to `true`. By setting this option to true, the node allows us to write custom JSON data.
|
||||
5. Toggle ***Download*** to `true`.
|
||||
6. Click on the gears icon next to the ***Properties (JSON)*** field.
|
||||
7. Enter the following expression in the ***Edit Expression*** field:
|
||||
```json
|
||||
{
|
||||
"company": "n8n",
|
||||
"email": "{{$json["1"]["email"]}}",
|
||||
"invoice_no": "213223444",
|
||||
"invoice_date": "18-03-2021",
|
||||
"invoice_due_date": "17-04-2021",
|
||||
"address": "Berlin, Germany",
|
||||
"company_bill_to": "{{$json["0"]["text"]}}",
|
||||
"website": "https://n8n.io",
|
||||
"document_id": "889856789012",
|
||||
"items": [
|
||||
{
|
||||
"item_name": "{{$json["2"]["text"]}}",
|
||||
"price": "EUR {{$json["3"]["number"]}}"
|
||||
},
|
||||
{
|
||||
"item_name": "{{$json["4"]["text"]}}",
|
||||
"price": "EUR {{$json["5"]["number"]}}"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
8. Click on the ***Add Field*** button.
|
||||
9. Enter a file name in the ***File Name*** field.
|
||||
10. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates an invoice using the data from the previous node.
|
||||
|
||||

|
||||
|
||||
::: tip 💡 Activate workflow for production
|
||||
You'll need to save the workflow and then click on the Activate toggle on the top right of the screen to activate the workflow. Your workflow will then be triggered as specified by the settings in the Typeform Trigger node.
|
||||
:::
|
||||
|
After Width: | Height: | Size: 210 KiB |
BIN
docs/nodes/nodes-library/nodes/APITemplateIo/workflow.png
Normal file
|
After Width: | Height: | Size: 131 KiB |
|
After Width: | Height: | Size: 145 KiB |
BIN
docs/nodes/nodes-library/nodes/AWSComprehend/IF_node.png
Normal file
|
After Width: | Height: | Size: 138 KiB |
BIN
docs/nodes/nodes-library/nodes/AWSComprehend/Mattermost_node.png
Normal file
|
After Width: | Height: | Size: 162 KiB |
BIN
docs/nodes/nodes-library/nodes/AWSComprehend/NoOp_node.png
Normal file
|
After Width: | Height: | Size: 160 KiB |
104
docs/nodes/nodes-library/nodes/AWSComprehend/README.md
Normal file
@ -0,0 +1,104 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.awsComprehend
|
||||
description: Learn how to use the AWS Comprehend node in n8n
|
||||
---
|
||||
|
||||
# AWS Comprehend
|
||||
|
||||
[AWS Comprehend](https://aws.amazon.com/comprehend/) is a natural language processing (NLP) service that uses machine learning to find insights and relationships in a text.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/AWS/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Text
|
||||
- Identify the dominant language
|
||||
- Analyse the sentiment of the text
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to analyze the sentiment of feedback received via a Typeform submission and send a message on Mattermost if that feedback is negative. You can also find the [workflow](https://n8n.io/workflows/965) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Typeform Trigger](../../trigger-nodes/TypeformTrigger/README.md)
|
||||
- [AWS Comprehend]()
|
||||
- [IF](../../core-nodes/If/README.md)
|
||||
- [Mattermost](../../nodes/Mattermost/README.md)
|
||||
- [No Operation, do nothing](../../core-nodes/NoOperationDoNothing/README.md)
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Typeform Trigger node
|
||||
|
||||
This node will trigger the workflow when a feedback form is submitted. Make sure to create a feedback form for your event.
|
||||
|
||||
1. Select 'Access Token' from the ***Authentication*** dropdown list.
|
||||
2. Enter the credentials for the Typeform Trigger node. You can find out how to do that [here](../../../credentials/Typeform/README.md).
|
||||
3. Select the event feedback form from the ***Form*** dropdown list.
|
||||
4. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node triggers the workflow when feedback is submitted. We will pass this feedback to the next nodes in the workflow.
|
||||
|
||||

|
||||
|
||||
### 2. AWS Comprehend node (detectSentiment: text)
|
||||
|
||||
This node will analyze the sentiment of the feedback that we got from the previous node. We will pass the analysis score to the next node in the workflow.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the AWS Comprehend node. You can find out how to enter credentials for this node [here](../../../credentials/AWS/README.md).
|
||||
2. Select 'Detect Sentiment' from the ***Operation*** dropdown list.
|
||||
3. Click on the gears icon next to the ***Text*** field and click on ***Add Expression***.
|
||||
::: v-pre
|
||||
4. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > What did you think about the event? You can also add the following expression: `{{$json["What did you think about the event?"]}}`. If you want to analyze the sentiment for a different question, select that question instead.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node analyzes the sentiment of the feedback and gives a score based on that.
|
||||
|
||||

|
||||
|
||||
|
||||
### 3. IF node
|
||||
|
||||
This node will check if the sentiment we got from the previous node is negative. If the sentiment is negative, it will return true otherwise false.
|
||||
::: v-pre
|
||||
1. Click on ***Add Condition*** and select 'String'.
|
||||
2. Click on the gears icon next to the ***Value 1*** field and click on ***Add Expression***.
|
||||
3. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > Sentiment. You can also add the following expression: `{{$json["Sentiment"]}}`.
|
||||
4. Enter `NEGATIVE` in the ***Value 2*** field.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node checks the sentiment that we received from the previous node and returns `true` if the sentiment is negative.
|
||||
|
||||

|
||||
|
||||
### 4. Mattermost node (post: message)
|
||||
|
||||
This node will send the feedback and the analysis score to the `feedback` channel in Mattermost. If you have a different channel, use that instead.
|
||||
|
||||
1. Create a Mattermost node connected to the 'true' output of the IF node.
|
||||
2. You'll have to enter credentials for the Mattermost node. You can find out how to enter credentials for this node [here](../../../credentials/Mattermost/README.md).
|
||||
3. Select a channel from the ***Channel ID*** dropdown list.
|
||||
4. Click on the gears icon next to the ***Message*** field click on ***Add Expression***.
|
||||
::: v-pre
|
||||
5. Enter the following message in the ***Expression*** field: `You got new feedback with a score of {{$json["SentimentScore"]["Negative"]}}. Here is what it says:{{$node["Typeform Trigger"].json["What did you think about the event?"]}}`.
|
||||
6. Click on ***Execute Node*** to run the workflow.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node sends the feedback and the analysis score to the `feedback` channel in Mattermost.
|
||||
|
||||

|
||||
|
||||
### 5. NoOp node
|
||||
|
||||
Adding this node here is optional, as the absence of this node won't make a difference to the functioning of the workflow.
|
||||
|
||||
1. Create a ***NoOp*** node connected to the 'false' output of the IF node.
|
||||
2. Click on ***Execute Node*** to run the node.
|
||||
|
||||

|
||||
|
||||
::: tip 💡 Activate workflow for production
|
||||
This example workflow uses the Typeform Trigger node. You'll need to save the workflow and then click on the Activate toggle on the top right of the screen to activate the workflow. Your workflow will then be triggered when a new form is submitted.
|
||||
:::
|
||||
|
After Width: | Height: | Size: 157 KiB |
BIN
docs/nodes/nodes-library/nodes/AWSComprehend/workflow.png
Normal file
|
After Width: | Height: | Size: 194 KiB |
BIN
docs/nodes/nodes-library/nodes/Autopilot/Autopilot1_node.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
docs/nodes/nodes-library/nodes/Autopilot/Autopilot2_node.png
Normal file
|
After Width: | Height: | Size: 128 KiB |
BIN
docs/nodes/nodes-library/nodes/Autopilot/Autopilot3_node.png
Normal file
|
After Width: | Height: | Size: 132 KiB |
BIN
docs/nodes/nodes-library/nodes/Autopilot/Autopilot_node.png
Normal file
|
After Width: | Height: | Size: 114 KiB |
112
docs/nodes/nodes-library/nodes/Autopilot/README.md
Normal file
@ -0,0 +1,112 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.autopilot
|
||||
description: Learn how to use the Autopilot node in n8n
|
||||
---
|
||||
|
||||
# Autopilot
|
||||
|
||||
[Autopilot](https://www.autopilothq.com/) is a visual marketing software that allows you to automate and personalize your marketing across the entire customer journey.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Autopilot/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Contact
|
||||
- Create/Update a contact
|
||||
- Delete a contact
|
||||
- Get a contact
|
||||
- Get all contacts
|
||||
:::
|
||||
|
||||
::: details Contact Journey
|
||||
- Add contact to a list
|
||||
:::
|
||||
|
||||
::: details Contact List
|
||||
- Add contact to a list
|
||||
- Check if contact is on a list
|
||||
- Get all contacts on a list
|
||||
- Remove a contact from a list
|
||||
:::
|
||||
|
||||
::: details List
|
||||
- Create a list
|
||||
- Get all lists
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create a new list, add a new contact to that list, update the contact, and get all contacts in the list using the Autopilot node. You can also find the [workflow](https://n8n.io/workflows/990) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [Autopilot]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Start node
|
||||
|
||||
The Start node exists by default when you create a new workflow.
|
||||
|
||||
|
||||
### 2. Autopilot node (create: list)
|
||||
|
||||
This node will create a new list called `n8n-docs` in Autopilot.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Autopilot node. You can find out how to do that [here](../../../credentials/Autopilot/README.md).
|
||||
2. Select 'List' from the ***Resource*** dropdown list.
|
||||
3. Enter `n8n-docs` in the ***Name*** field.
|
||||
4. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new list with the name `n8n-docs`.
|
||||
|
||||

|
||||
|
||||
### 3. Autopilot1 node (upsert: contact)
|
||||
|
||||
This node creates a new contact and adds it to the list created in the previous node.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Enter the email address of the contact you want to add to the list in the ***Email*** field.
|
||||
3. Click on ***Add Field*** and select 'List ID' from the dropdown list.
|
||||
4. Click on the gears icon next to the ***List ID*** field and click on ***Add Expression***.
|
||||
5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > list_id. You can also add the following expression: `{{$json["list_id"]}}`.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node creates a new contact with the email address `harshil@n8n.io` and adds it to the list `n8n-docs` created in the previous node.
|
||||
|
||||

|
||||
|
||||
### 4. Autopilot2 node (update: contact)
|
||||
|
||||
This node updates the information of the contact that we created in the previous node.
|
||||
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Click on the gears icon next to the ***Email*** field and click on ***Add Expression***.
|
||||
3. Select the following in the ***Variable Selector*** section: Nodes > Autopilot1 > Parameters > email. You can also add the following expression: `{{$node["Autopilot1"].parameter["email"]}}`.
|
||||
4. Click on ***Add Field*** and select 'Company' from the dropdown list.
|
||||
5. Enter `n8n` in the ***Company*** field.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node updates the contact created in the previous node by adding the tag `reviewer` to it.
|
||||
|
||||

|
||||
|
||||
### 5. Autopilot3 node (getAll: contact)
|
||||
|
||||
This node returns all the contacts of the `n8n-docs` list that we created using the Autopilot node.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Contact List' from the ***Resource*** dropdown list.
|
||||
3. Select 'Get All' from the ***Operation*** dropdown list.
|
||||
4. Click on the gears icon next to the ***List ID*** field and click on ***Add Expression***.
|
||||
5. Select the following in the ***Variable Selector*** section: Nodes > Autopilot > Output Data > JSON > list_id. You can also add the following expression: `{{$node["Autopilot"].json["list_id"]}}`.
|
||||
6. Toggle ***Return All*** to true.
|
||||
7. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node returns all the contacts that are present in the list `n8n-docs`.
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Autopilot/workflow.png
Normal file
|
After Width: | Height: | Size: 132 KiB |
BIN
docs/nodes/nodes-library/nodes/DeepL/DeepL_node.png
Normal file
|
After Width: | Height: | Size: 148 KiB |
BIN
docs/nodes/nodes-library/nodes/DeepL/HTTPRequest_node.png
Normal file
|
After Width: | Height: | Size: 343 KiB |
59
docs/nodes/nodes-library/nodes/DeepL/README.md
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.deepL
|
||||
description: Learn how to use the DeepL node in n8n
|
||||
---
|
||||
|
||||
# DeepL
|
||||
|
||||
[DeepL](https://deepL.com) is a machine translation service that allows you to translate text to different languages.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/DeepL/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Resource
|
||||
- Translate
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to translate cocktail instructions to French. You can also find the [workflow](https://n8n.io/workflows/998) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [HTTP Request](../../core-nodes/HTTPRequest/README.md)
|
||||
- [DeepL]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Start node
|
||||
|
||||
The Start node exists by default when you create a new workflow.
|
||||
|
||||
### 2. HTTP Request node (GET)
|
||||
|
||||
This node will make a GET request to the API `https://www.thecocktaildb.com/api/json/v1/1/random.php` to fetch a random cocktail. This information gets passed on to the next node in the workflow.
|
||||
|
||||
1. Enter `https://www.thecocktaildb.com/api/json/v1/1/random.php` in the ***URL*** field.
|
||||
2. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node makes a GET request to the API and returns information about a random cocktail.
|
||||
|
||||

|
||||
|
||||
### 3. DeepL node (translate: language)
|
||||
|
||||
This node will translate the cocktail instructions that we got from the previous node to French. To translate the instructions in your language, select your language instead.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the DeepL node. You can find out how to do that [here](../../../credentials/DeepL/README.md).
|
||||
::: v-pre
|
||||
2. Click on the gears icon next to the ***Text*** field and click on ***Add Expression***.
|
||||
3. Select the following in the ***Variable Selector*** section: Current Nodes > Input Data > JSON > drinks > [item: 0] > strInstructions. You can also add the following expression: `{{$json["drinks"][0]["strInstructions"]}}`.
|
||||
4. Select 'French' from the ***Target Language*** dropdown list.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node translates the instructions of the cocktail to French.
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/DeepL/workflow.png
Normal file
|
After Width: | Height: | Size: 131 KiB |
BIN
docs/nodes/nodes-library/nodes/Emelia/Emelia1_node.png
Normal file
|
After Width: | Height: | Size: 135 KiB |
BIN
docs/nodes/nodes-library/nodes/Emelia/Emelia2_node.png
Normal file
|
After Width: | Height: | Size: 173 KiB |
BIN
docs/nodes/nodes-library/nodes/Emelia/Emelia_node.png
Normal file
|
After Width: | Height: | Size: 127 KiB |
86
docs/nodes/nodes-library/nodes/Emelia/README.md
Normal file
@ -0,0 +1,86 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.emelia
|
||||
description: Learn how to use the Emelia node in n8n
|
||||
---
|
||||
|
||||
# Emelia
|
||||
|
||||
[Emelia](https://emelia.io) is a cold-mailing tool.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Emelia/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Campaign
|
||||
- Add contact
|
||||
- Create a campaign
|
||||
- Get a campaign
|
||||
- Get all campaigns
|
||||
- Pause a campaign
|
||||
- Start a campaign
|
||||
:::
|
||||
|
||||
::: details Contact List
|
||||
- Add a contact
|
||||
- Get all contact lists
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create a campaign, add a contact, and get the campaign from Emelia. You can also find the [workflow](https://n8n.io/workflows/961) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [Emelia]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Start node
|
||||
|
||||
The Start node exists by default when you create a new workflow.
|
||||
|
||||
### 2. Emelia node (campaign: create)
|
||||
|
||||
This node will create a new campaign in Emelia.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Emelia node. You can find out how to do that [here](../../../credentials/Emelia/README.md).
|
||||
2. Select 'Create' from the ***Operation*** dropdown list.
|
||||
3. Enter the campaign name in the ***Campaign Name*** field.
|
||||
4. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new campaign.
|
||||
|
||||

|
||||
|
||||
### 3. Emelia1 node (campaign: addContact)
|
||||
|
||||
This node will add a contact to the campaign that we created in the previous node.
|
||||
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Add Contact' from the ***Operation*** dropdown list.
|
||||
3. Select the campaign from the ***Campaign ID*** dropdown list.
|
||||
4. Enter the contact's email address in the ***Contact Email*** field.
|
||||
5. Click on the ***Add Field*** button and select 'First Name'.
|
||||
6. Enter the first name in the ***First Name*** field.
|
||||
7. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node adds the contact to the campaign that we created in the previous node.
|
||||
|
||||

|
||||
|
||||
### 4. Emelia2 node (campaign: get)
|
||||
|
||||
This node will get the information about the campaign that we created earlier.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Get' from the ***Operation*** dropdown list.
|
||||
3. Click on the gears icon next to the ***Campaign ID*** field and click on ***Add Expression***.
|
||||
5. Select the following in the ***Variable Selector*** section: Nodes > Emelia > Output Data > JSON > _id. You can also add the following expression: `{{$node["Emelia"].json["_id"]}}`.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information of the campaign.
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Emelia/workflow.png
Normal file
|
After Width: | Height: | Size: 130 KiB |
BIN
docs/nodes/nodes-library/nodes/Lemlist/Airtable_node.png
Normal file
|
After Width: | Height: | Size: 158 KiB |
BIN
docs/nodes/nodes-library/nodes/Lemlist/Lemlist1_node.png
Normal file
|
After Width: | Height: | Size: 136 KiB |
BIN
docs/nodes/nodes-library/nodes/Lemlist/Lemlist_node.png
Normal file
|
After Width: | Height: | Size: 177 KiB |
103
docs/nodes/nodes-library/nodes/Lemlist/README.md
Normal file
@ -0,0 +1,103 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.lemlist
|
||||
description: Learn how to use the Lemlist node in n8n
|
||||
---
|
||||
|
||||
# Lemlist
|
||||
|
||||
[Lemlist](https://Lemlist.com) is an email outreach platform that allows you to automatically generate personalized images and videos and send personalized cold emails.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Lemlist/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Activity
|
||||
- Get all activities
|
||||
:::
|
||||
|
||||
::: details Campaign
|
||||
- Get all campaigns
|
||||
:::
|
||||
|
||||
::: details Lead
|
||||
- Create a lead
|
||||
- Delete a lead
|
||||
- Get a lead
|
||||
- Unsubscribe
|
||||
:::
|
||||
|
||||
::: details Team
|
||||
- Get a team
|
||||
:::
|
||||
|
||||
::: details Unsubscribes
|
||||
- Add
|
||||
- Delete
|
||||
- Get all
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to list emails from Airtable and create corresponding leads in Lemlist. You can also find the [workflow](https://n8n.io/workflows/983) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [Airtable](../Airtable/README.md)
|
||||
- [Lemlist]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Start node
|
||||
|
||||
The start node exists by default when you create a new workflow.
|
||||
|
||||
### 2. Airtable node (List)
|
||||
|
||||
This node will list all the records from Airtable. Create a table like [this](https://airtable.com/shruiCc4kttDVsTsD) in your Airtable base.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Airtable node. You can find out how to do that [here](../../../credentials/Airtable/README.md).
|
||||
2. Select the 'List' option from the ***Operation*** dropdown list.
|
||||
3. Enter the Base ID in the ***Base ID*** field. For obtaining the Base ID, head over to their [API page](https://airtable.com/api) and select the correct base. You’ll find the Base ID there.
|
||||
4. Enter the name of your table in the ***Table*** field.
|
||||
5. Click on the gears icon next to the ***Table*** field and click on ***Add Expression***.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information of the leads.
|
||||
|
||||

|
||||
|
||||
### 3. Lemlist node (create: lead)
|
||||
|
||||
This node will create new leads for a campaign in Lemlist.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Lemlist node. You can find out how to do that [here](../../../credentials/Lemlist/README.md).
|
||||
2. Select 'Lead' from the ***Resource*** dropdown list.
|
||||
3. Select a campaign from the ***Campaign ID*** dropdown list.
|
||||
4. Click on the gears icon next to the ***Email*** field and click on ***Add Expression***.
|
||||
::: v-pre
|
||||
5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > fields > Email. You can also add the following expression: `{{$json["fields"]["Email"]}}`.
|
||||
6. Click on the ***Add Field*** button and select 'First Name'.
|
||||
7. Click on the gears icon next to the ***First Name*** field and click on ***Add Expression***.
|
||||
8. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > fields > Name. You can also add the following expression: `{{$json["fields"]["Name"]}}`.
|
||||
9. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates new leads in Lemlist.
|
||||
|
||||

|
||||
|
||||
### 4. Lemlist node (get: lead)
|
||||
|
||||
This node will return the information of the leads that we created in the previous node.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Lead' from the ***Resource*** dropdown list.
|
||||
3. Select 'Get' from the ***Operation*** dropdown list.
|
||||
4. Click on the gears icon next to the ***Email*** field and click on ***Add Expression***.
|
||||
5. Select the following in the ***Variable Selector*** section: Nodes > Airtable > Output Data > JSON > fields > Email. You can also add the following expression: `{{$node["Airtable"].json["fields"]["Email"]}}`.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information about the leads we created in the previous node.
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Lemlist/workflow.png
Normal file
|
After Width: | Height: | Size: 125 KiB |
BIN
docs/nodes/nodes-library/nodes/PostHog/PostHog_node.png
Normal file
|
After Width: | Height: | Size: 120 KiB |
76
docs/nodes/nodes-library/nodes/PostHog/README.md
Normal file
@ -0,0 +1,76 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.postHog
|
||||
description: Learn how to use the PostHog node in n8n
|
||||
---
|
||||
|
||||
# PostHog
|
||||
|
||||
[PostHog](https://posthog.com) is an open-source product analytics platform. It provides tools to improve your product, such as session recording, heatmaps, and feature flags.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/PostHog/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Alias
|
||||
- Create an alias
|
||||
:::
|
||||
|
||||
::: details Event
|
||||
- Create an event
|
||||
:::
|
||||
|
||||
::: details Identity
|
||||
- Create an identity
|
||||
:::
|
||||
|
||||
::: details Track
|
||||
- Track a page
|
||||
- Track a screen
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create an event in PostHog when a request is made to a webhook URL. You can also find the [workflow](https://n8n.io/workflows/968) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Webhook](../../core-nodes/Webhook/README.md)
|
||||
- [PostHog]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Webhook node
|
||||
|
||||
This node will trigger the workflow. We will make a GET request to the test webhook URL and pass on a query parameter called `event`.
|
||||
|
||||
1. Click on ***Webhook URLs*** and select the 'Test' tab.
|
||||
2. Copy the displayed URL. We will make a GET request to this URL later on.
|
||||
3. Save the workflow to register the webhook.
|
||||
4. Click on ***Execute Node*** to run the node.
|
||||
5. In a new browser tab, paste the URL that you copied in the previous step and append `?event=login` to it. Your URL should look similar to the following URL:`https://your-n8n.url/webhook/path?event=login`. Here, we are passing a query parameter called `event` and assigning the value `login` to it.
|
||||
6. Press Enter (or Return) to make a request to the test webhook URL.
|
||||
|
||||
In the screenshot below, you will notice that the node triggers the workflow and receives a query parameter. We will use the value of the query parameter in the next node in the workflow.
|
||||
|
||||

|
||||
|
||||
### 2. PostHog node (create:customer)
|
||||
|
||||
This node will create a new event in PostHog.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the PostHog node. You can find out how to do that [here](../../../credentials/PostHog/README.md).
|
||||
2. Click on the gears icon next to the ***Event*** field and click on ***Add Expression***.
|
||||
::: v-pre
|
||||
3. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > query > event. You can also add the following expression: `{{$json["query"]["event"]}}`.
|
||||
:::
|
||||
4. Enter a distinct id in the ***Distinct ID*** field.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new event in PostHog.
|
||||
|
||||

|
||||
|
||||
::: tip 💡 Activate workflow for production
|
||||
This example workflow uses the Webhook node, which is a Trigger node. You'll need to save the workflow and then click on the Activate toggle on the top right of the screen to activate the workflow. Your workflow will then be triggered every time a GET request is sent to the ***Production*** webhook URL.
|
||||
:::
|
||||
BIN
docs/nodes/nodes-library/nodes/PostHog/Webhook_node.png
Normal file
|
After Width: | Height: | Size: 220 KiB |
BIN
docs/nodes/nodes-library/nodes/PostHog/workflow.png
Normal file
|
After Width: | Height: | Size: 124 KiB |
@ -1,3 +1,3 @@
|
||||
# Nodes
|
||||
|
||||
Information about different nodes in n8n.
|
||||
This section contains information about all the regular nodes in n8n. Each node documentation contains information on the available resources and operations along with an example workflow.
|
||||
|
||||
127
docs/nodes/nodes-library/nodes/Wise/README.md
Normal file
@ -0,0 +1,127 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.wise
|
||||
description: Learn how to use the Wise node in n8n
|
||||
---
|
||||
|
||||
# Wise
|
||||
|
||||
[Wise](https://wise.com) allows you to transfer money abroad with low-cost money transfers, receive money with international account details, and track transactions on your phone.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Wise/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Account
|
||||
- Retrieve balances for all account currencies of this user
|
||||
- Retrieve all currencies in the borderless account of this user
|
||||
- Retrieve the statement for the borderless account of this user
|
||||
:::
|
||||
|
||||
::: details Exchange Rate
|
||||
- Get
|
||||
:::
|
||||
|
||||
::: details Profile
|
||||
- Get a profile
|
||||
- Get all profiles
|
||||
:::
|
||||
|
||||
::: details Recipient
|
||||
- Get all recipients
|
||||
:::
|
||||
|
||||
::: details Quote
|
||||
- Create a quote
|
||||
- Get a quote
|
||||
:::
|
||||
|
||||
::: details Transfer
|
||||
- Create a transfer
|
||||
- Delete a transfer
|
||||
- Execute a transfer
|
||||
- Get a transfer
|
||||
- Get all transfers
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create a quote and a transfer, execute the transfer, and get the information of the transfer using the Wise node. You can also find the [workflow](https://n8n.io/workflows/992) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [Wise]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Start node
|
||||
|
||||
The start node exists by default when you create a new workflow.
|
||||
|
||||
### 2. Wise node (create: quote)
|
||||
|
||||
This node will create a new quote in Wise.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Wise node. You can find out how to do that [here](../../../credentials/Wise/README.md).
|
||||
2. Select 'Quote' from the ***Resource*** dropdown list.
|
||||
3. Select 'Create' from the ***Operation*** dropdown list.
|
||||
4. Select a profile from the ***Profile ID*** dropdown list.
|
||||
5. Select a target account from the ***Target Account ID*** dropdown list.
|
||||
6. Enter an amount in the ***Amount*** field.
|
||||
7. Enter the source currency in the ***Source Currency*** field.
|
||||
8. Enter the target currency in the ***Target Currency*** field.
|
||||
9. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new quote.
|
||||
|
||||

|
||||
|
||||
### 3. Wise1 node (create: transfer)
|
||||
|
||||
This node will create a new transfer for the quote that we created in the previous node.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Transfer' from the ***Resource*** dropdown list.
|
||||
3. Select a profile from the ***Profile ID*** dropdown list.
|
||||
4. Click on the gears icon next to the ***Quote ID*** field and click on ***Add Expression***.
|
||||
5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > id. You can also add the following expression: `{{$json["id"]}}`.
|
||||
6. Select the target account from the ***Target Account ID*** dropdown list.
|
||||
7. Click on the ***Add Field*** button.
|
||||
8. Enter a description in the ***Reference*** field.
|
||||
9. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node creates a new transfer for the quote that we created in the previous node.
|
||||
|
||||

|
||||
|
||||
### 4. Wise2 node (execute: transfer)
|
||||
|
||||
This node will execute the transfer that we created in the previous node.
|
||||
:::v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Transfer' from the ***Resource*** dropdown list.
|
||||
3. Select 'Execute' from the ***Operation*** dropdown list.
|
||||
4. Select a profile from the ***Profile ID*** dropdown list.
|
||||
5. Click on the gears icon next to the ***Transfer ID*** field and click on ***Add Expression***.
|
||||
6. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > id. You can also add the following expression: `{{$json["id"]}}`.
|
||||
7. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns the executes the transfer that we created in the previous node.
|
||||
|
||||

|
||||
|
||||
### 5. Wise3 node (get: transfer)
|
||||
|
||||
This node will return the information of the transfer that we executed in the previous node.
|
||||
:::v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Transfer' from the ***Resource*** dropdown list.
|
||||
3. Select 'Get' from the ***Operation*** dropdown list.
|
||||
4. Click on the gears icon next to the ***Transfer ID*** field and click on ***Add Expression***.
|
||||
5. Select the following in the ***Variable Selector*** section: Nodes > Wise1 > Output Data > JSON > id. You can also add the following expression: `{{$node["Wise1"].json["id"]}}`.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information about the transfer that we executed in the previous node.
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Wise/Wise1_node.png
Normal file
|
After Width: | Height: | Size: 157 KiB |
BIN
docs/nodes/nodes-library/nodes/Wise/Wise2_node.png
Normal file
|
After Width: | Height: | Size: 124 KiB |
BIN
docs/nodes/nodes-library/nodes/Wise/Wise3_node.png
Normal file
|
After Width: | Height: | Size: 136 KiB |
BIN
docs/nodes/nodes-library/nodes/Wise/Wise_node.png
Normal file
|
After Width: | Height: | Size: 262 KiB |
BIN
docs/nodes/nodes-library/nodes/Wise/workflow.png
Normal file
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 147 KiB |
|
After Width: | Height: | Size: 129 KiB |
@ -0,0 +1,86 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.autopilotTrigger
|
||||
description: Learn how to use the Autopilot Trigger node in n8n
|
||||
---
|
||||
|
||||
# Autopilot Trigger
|
||||
|
||||
[Autopilot](https://www.autopilothq.com/) is a visual marketing software that allows you to automate and personalize your marketing across the entire customer journey.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Autopilot/README.md).
|
||||
:::
|
||||
|
||||
## Events
|
||||
|
||||
- Contact added
|
||||
- Contact added to a list
|
||||
- Contact entered to a segment
|
||||
- Contact left a segment
|
||||
- Contact removed from a list
|
||||
- Contact unsubscribed
|
||||
- Contact updated
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to receive updates when a new contact gets added in Autopilot and add them to a base in Airtable. You can also find the [workflow](https://n8n.io/workflows/991) on n8n.io. This example usage workflow would use the following node.
|
||||
- [Autopilot Trigger]()
|
||||
- [Set](../../core-nodes/Set/README.md)
|
||||
- [Airtable](../../nodes/Airtable/README.md)
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Autopilot Trigger
|
||||
|
||||
The Autopilot Trigger node will trigger the workflow when a new contact gets added in Autopilot.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Autopilot Trigger node. You can find out how to do that [here](../../../credentials/Autopilot/README.md).
|
||||
2. Select 'Contact Added' from the ***Events*** dropdown list.
|
||||
3. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information of the new contact that was added to Autopilot. This output gets passed on to the next node in the workflow.
|
||||
|
||||

|
||||
|
||||
### 2. Set node
|
||||
|
||||
We will use the Set node to ensure that only the data that we set in this node gets passed on to the next nodes in the workflow.
|
||||
::: v-pre
|
||||
1. Click on ***Add Value*** and select 'String' from the dropdown list.
|
||||
2. Enter `First Name` in the ***Name*** field.
|
||||
3. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
4. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > contact > FirstName. You can also add the following expression: `{{$json["contact"]["FirstName"]}}`.
|
||||
5. Enter `First Name` in the ***Name*** field.
|
||||
6. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
7. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > contact > LastName. You can also add the following expression: `{{$json["contact"]["LastName"]}}`.
|
||||
8. Click on ***Add Value*** and select 'String' from the dropdown list.
|
||||
9. Enter `Email` in the ***Name*** field.
|
||||
10. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
11. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > contact > Email. You can also add the following expression: `{{$json["contact"]["Email"]}}`.
|
||||
12. Toggle ***Keep Only Set*** to `true`. We set this option to true to ensure that only the data that we have set in this node get passed on to the next nodes in the workflow.
|
||||
13. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node uses the data from the previous node and returns the data that we set for the workflow.
|
||||
|
||||

|
||||
|
||||
### 3. Airtable node
|
||||
|
||||
This node will store the data coming from the previous node in a table in Airtable.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Airtable node. You can find out how to do that [here](../../../credentials/Airtable/README.md).
|
||||
2. Select 'Append' from the ***Operation*** dropdown list.
|
||||
3. Enter the base ID in the ***Base ID*** field. For obtaining the Base ID, head over to their [API page](https://airtable.com/api) and select the correct base. You’ll find the Base ID under the Introduction section.
|
||||
4. In n8n, paste the ID of the base in the ***Base ID*** field.
|
||||
5. Enter the table name in the ***Table*** name field.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node adds the information of a new contact from the previous node in a table in Airtable.
|
||||
|
||||

|
||||
|
||||
::: tip 💡 Activate workflow for production
|
||||
You'll need to save the workflow and then click on the Activate toggle on the top right of the screen to activate the workflow. Your workflow will then be triggered as specified by the settings in the Autopilot Trigger node.
|
||||
:::
|
||||
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 126 KiB |
|
After Width: | Height: | Size: 126 KiB |
|
After Width: | Height: | Size: 162 KiB |
@ -0,0 +1,69 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.lemlistTrigger
|
||||
description: Learn how to use the Lemlist Trigger node in n8n
|
||||
---
|
||||
|
||||
# Lemlist Trigger
|
||||
|
||||
[Lemlist](https://Lemlist.com) is an email outreach platform that allows you to automatically generate personalized images and videos and send personalized cold emails.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Lemlist/README.md).
|
||||
:::
|
||||
|
||||
## Events
|
||||
|
||||
- Email Bounced
|
||||
- Email Clicked
|
||||
- Email Opened
|
||||
- Email Replied
|
||||
- Email Send Failed
|
||||
- Email Sent
|
||||
- Email Unsubscribed
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to send a message on Mattermost when a lead replies to your email. You can also find the [workflow](https://n8n.io/workflows/984) on n8n.io. This example usage workflow would use the following node.
|
||||
- [Lemlist Trigger]()
|
||||
- [Mattermost](../../nodes/Mattermost/README.md)
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Lemlist Trigger
|
||||
|
||||
The Lemlist Trigger node will trigger the workflow when a lead sends a reply to the campaign `Docs campaign`. If you have a different campaign, use that instead.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Lemlist Trigger node. You can find out how to do that [here](../../../credentials/Lemlist/README.md).
|
||||
2. Select 'Email Replied' from the ***Events*** dropdown list.
|
||||
3. Click on ***Add Field*** and select 'Campaign ID'.
|
||||
4. Select 'Docs campaign' from the ***Campaign ID*** dropdown list.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information of the reply that was sent by a lead. This output is passed on to the next node in the workflow.
|
||||
|
||||

|
||||
|
||||
## 2. Mattermost node (post: message)
|
||||
|
||||
This node will send a message to the `Leads` channel in Mattermost. If you have a different channel, use that instead.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Mattermost node. You can find out how to enter credentials for this node [here](../../../credentials/Mattermost/README.md).
|
||||
2. Select a channel from the ***Channel ID*** dropdown list.
|
||||
3. Click on the gears icon next to the ***Message*** field click on ***Add Expression***.
|
||||
::: v-pre
|
||||
4. Enter the following message in the ***Expression*** field:
|
||||
```
|
||||
{{$json["firstName"]}} has replied back to your {{$json["campaignName"]}}. Below is the reply:
|
||||
> {{$json["text"]}}
|
||||
```
|
||||
5. Click on ***Execute Node*** to run the workflow.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node sends a message with a reply to the `Leads` channel in Mattermost.
|
||||
|
||||

|
||||
|
||||
::: tip 💡 Activate workflow for production
|
||||
You'll need to save the workflow and then click on the Activate toggle on the top right of the screen to activate the workflow. Your workflow will then be triggered as specified by the settings in the Lemlist Trigger node.
|
||||
:::
|
||||
|
After Width: | Height: | Size: 140 KiB |
@ -1,3 +1,3 @@
|
||||
# Trigger Nodes
|
||||
|
||||
Information about different trigger nodes in n8n.
|
||||
This section contains information about all the trigger nodes in n8n. Each node documentation contains information on the available resources and operations along with an example workflow.
|
||||
|
||||
|
After Width: | Height: | Size: 162 KiB |
103
docs/nodes/nodes-library/trigger-nodes/WiseTrigger/README.md
Normal file
@ -0,0 +1,103 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.wiseTrigger
|
||||
description: Learn how to use the Wise Trigger node in n8n
|
||||
---
|
||||
|
||||
# Wise Trigger
|
||||
|
||||
[Wise](https://wise.com) allows you to transfer money abroad with low-cost money transfers, receive money with international account details, and track transactions on your phone.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Wise/README.md).
|
||||
:::
|
||||
|
||||
## Events
|
||||
|
||||
- Triggered every time a balance account is credited
|
||||
- Triggered every time a transfer's list of active cases is updated
|
||||
- Triggered every time a transfer's status is updated
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to receive updates from Wise and add information of a transfer to a base in Airtable. You can also find the [workflow](https://n8n.io/workflows/993) on n8n.io. This example usage workflow would use the following nodes.
|
||||
- [Wise Trigger]()
|
||||
- [Wise](../../nodes/Wise/README.md)
|
||||
- [Set](../../core-nodes/Set/README.md)
|
||||
- [Airtable](../../nodes/Airtable/README.md)
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Wise Trigger node (transferStateChange)
|
||||
|
||||
This node will trigger the workflow when the status of your transfer changes.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Wise Trigger node. You can find out how to do that [here](../../../credentials/Wise/README.md).
|
||||
2. Select 'Personal' from the ***Profile*** dropdown list.
|
||||
3. Select 'Transfer State Changed' from the ***Event*** dropdown list.
|
||||
4. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node triggers the workflow when a new order gets created.
|
||||
|
||||

|
||||
|
||||
### 2. Wise node (get: transfer)
|
||||
|
||||
This node will get the information about the transfer.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Transfer' from the ***Resource*** dropdown list.
|
||||
3. Select 'Get' from the ***Operation*** dropdown list.
|
||||
4. Click on the gears icon next to the ***Transfer ID*** field.
|
||||
5. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > data > resource > id. You can also add the following expression: `{{$json["data"]["resource"]["id"]}}`.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node returns the information of the transfer.
|
||||
|
||||

|
||||
|
||||
### 3. Set node
|
||||
|
||||
We will use the Set node to ensure that only the data that we set in this node gets passed on to the next nodes in the workflow. We will set the value of `Transfer ID`, `Date`, `Reference`, and `Amount` in this node.
|
||||
::: v-pre
|
||||
1. Click on ***Add Value*** and select 'String' from the dropdown list.
|
||||
2. Enter `Transfer ID` in the ***Name*** field.
|
||||
3. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
4. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > id. You can also add the following expression: `{{$json["id"]}}`.
|
||||
5. Click on ***Add Value*** and select 'String' from the dropdown list.
|
||||
6. Enter `Date` in the ***Name*** field.
|
||||
7. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
8. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > created. You can also add the following expression: `{{$json["created"]}}`.
|
||||
9. Click on ***Add Value*** and select 'String' from the dropdown list.
|
||||
10. Enter `Reference` in the ***Name*** field.
|
||||
11. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
12. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > reference. You can also add the following expression: `{{$json["reference"]}}`.
|
||||
13. Click on ***Add Value*** and select 'String' from the dropdown list.
|
||||
10. Enter `Amount` in the ***Name*** field.
|
||||
11. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***.
|
||||
12. Select the following in the ***Variable Selector*** section: Current Node > Input Data > JSON > sourceValue. You can also add the following expression: `{{$json["sourceValue"]}}`.
|
||||
13. Toggle ***Keep Only Set*** to `true`. We set this option to true to ensure that only the data that we have set in this node get passed on to the next nodes in the workflow.
|
||||
14. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node sets the values of `Transfer ID`, `Date`, `Reference`, and `Amount`. These values are passed to the next node in the workflow.
|
||||
|
||||

|
||||
|
||||
### 4. Airtable node (Append)
|
||||
|
||||
This node will append the data that we set in the previous node to a table. Create a table like [this](https://airtable.com/shrZQQCRtQPBYTmUe) in your Airtable base.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Airtable node. You can find out how to do that [here](../../../credentials/Airtable/README.md).
|
||||
2. Select 'Append' from the ***Operation*** dropdown list.
|
||||
3. Enter the Base ID in the ***Base ID*** field. For obtaining the Base ID, head over to their [API page](https://airtable.com/api) and select the correct base. You’ll find the Base ID there.
|
||||
4. Enter the name of your table in the ***Table*** field.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node appends the data that we had set in the previous node.
|
||||
|
||||

|
||||
|
||||
::: tip 💡 Activate workflow for production
|
||||
You'll need to save the workflow and then click on the Activate toggle on the top right of the screen to activate the workflow. Your workflow will then be triggered as specified by the settings in the Wise Trigger node.
|
||||
:::
|
||||
BIN
docs/nodes/nodes-library/trigger-nodes/WiseTrigger/Set_node.png
Normal file
|
After Width: | Height: | Size: 158 KiB |
|
After Width: | Height: | Size: 178 KiB |
BIN
docs/nodes/nodes-library/trigger-nodes/WiseTrigger/Wise_node.png
Normal file
|
After Width: | Height: | Size: 144 KiB |
BIN
docs/nodes/nodes-library/trigger-nodes/WiseTrigger/workflow.png
Normal file
|
After Width: | Height: | Size: 138 KiB |
@ -9,11 +9,11 @@ Interested in learning more about n8n? You've come to the right place.
|
||||
- [Workflow](workflow.md)
|
||||
- [Configuration](configuration.md)
|
||||
- [Security](security.md)
|
||||
- [Docker](docker.md)
|
||||
- [Server Setup](server-setup.md)
|
||||
- [CLI commands for n8n](start-workflows-via-cli.md)
|
||||
- [JavaScript Code Snippets](javascript-code-snippets.md)
|
||||
- [Glossary](glossary.md)
|
||||
- [Scaling n8n](scaling-n8n.md)
|
||||
- [Function and Function Items Nodes](function-nodes.md)
|
||||
- [Troubleshooting](troubleshooting.md)
|
||||
- [Data](data/data-structure.md)
|
||||
@ -2,6 +2,86 @@
|
||||
|
||||
🛠 = Version contains a breaking change. Check out the list of all the breaking changes [here](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md).
|
||||
|
||||
## n8n@0.112.0
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.111.0...n8n@0.112.0) for this version.<br />
|
||||
**Release date:** 2021-03-19
|
||||
|
||||
- New nodes
|
||||
- DeepL
|
||||
- Enhanced nodes
|
||||
- TheHive: Added Mark as Read and Mark as Unread operations and added Ignore SSL Issues parameter to the credentials
|
||||
- Bug fixes
|
||||
- AWS SES: Fixed an issue to map CC addresses correctly
|
||||
- Salesforce: Fixed an issue with custom object for Get All operations and fixed an issue with the first name field for the Create and Update operations for the Lead resource
|
||||
- Strava: Fixed an issue with the access tokens not getting refreshed
|
||||
- TheHive: Fixed an issue with the case resolution status
|
||||
- Fixed an issue with importing separate decrypted credentials
|
||||
- Fixed issues with the sub-workflows not finishing
|
||||
- Fixed an issue with the sub-workflows running on the main process
|
||||
- Fixed concurrency issues with sub-workflows
|
||||
|
||||
## n8n@0.111.0 🛠
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.110.3...n8n@0.111.0) for this version.<br />
|
||||
**Release date:** 2021-03-12
|
||||
|
||||
- New nodes
|
||||
- Autopilot
|
||||
- Autopilot Trigger
|
||||
- Wise
|
||||
- Wise Trigger
|
||||
- Enhanced nodes
|
||||
- Box: Added Get operation to the Folder resource
|
||||
- Dropbox: Added Search operation to the File resource. All operations are now performed relative to the user's root directory. For more details, check out the entry in the [breaking changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md#01110) page
|
||||
- Facebook Graph API: Added new API versions
|
||||
- Google Drive: Added Update operation to the File resource
|
||||
- HubSpot: Added the Deal Description option
|
||||
- Kafka: Added the SASL mechanism
|
||||
- Monday.com: Added Move operation to Board Item resource
|
||||
- MongoDB: Added Date field to the Insert and Update operations
|
||||
- Micrsoft SQL: Added connection timeout parameter to credentials
|
||||
- Salesforce: Added Mobile Phone field to the Lead resource
|
||||
- Spotify: Added Create a Playlist operation to Playlist resource and Get New Releases to the Album resource
|
||||
- Bug fixes
|
||||
- Airtable: Fixed a bug with updating and deleting records
|
||||
- Added the functionality to expose metrics to Prometheus. Read more about that [here](configuration.md#prometheus)
|
||||
- Updated fallback values to match the value type
|
||||
- Added the functionality to display debugging information for pending workflows on exit
|
||||
- Fixed an issue with queue mode for the executions that should not be saved
|
||||
- Fixed an issue with workflows crashing and displaying `Unknown` status in the execution list
|
||||
- Fixed an issue to prevent crashing while saving execution data when the `data` field has over 64KB in MySQL
|
||||
- Updated `jws-rsa` to version `1.12.1`
|
||||
|
||||
## n8n@0.110.3
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.110.0...n8n@0.110.3) for this version.<br />
|
||||
**Release date:** 2021-03-04
|
||||
|
||||
- Bug fixes
|
||||
- APITemplate.io: Fixed an issue with the naming of the node
|
||||
|
||||
## n8n@0.110.0
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.109.0...n8n@0.110.0) for this version.<br />
|
||||
**Release date:** 2021-03-04
|
||||
|
||||
- New nodes
|
||||
- APITemplate.io
|
||||
- Bubble
|
||||
- Lemlist
|
||||
- Lemlist Trigger
|
||||
- Enhanced nodes
|
||||
- Microsoft Teams: Added option to reply to a message
|
||||
- Bug fixes
|
||||
- Dropbox: Fixed an issue with parsing the response with the Upload operation
|
||||
- Gmail: Fixed an issue with the scope for the Service Account authentication method and fixed an issue with the label filter
|
||||
- Google Drive: Fixed an issue with the missing Parent ID field for the Create operation and fixed an issue with the Permissions field
|
||||
- HelpScout: Fixed an issue with sending tags when creating a conversation
|
||||
- HTTP Request: Fixed an issue with the raw data and file response
|
||||
- HubSpot: Fixed an issue with the OAuth2 credentials
|
||||
- Added support for Date & Time in the IF node and the Switch node
|
||||
- Fixed an issue with mouse selection when zooming in or out
|
||||
- Fixed an issue with current executing workflows when using queues for Postgres
|
||||
- Fixed naming and description for the `N8N_SKIP_WEBHOOK_DEREGISTRATION_SHUTDOWN` environment variable
|
||||
- Fixed an issue with auto-refresh of the execution list
|
||||
|
||||
## n8n@0.109.0
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.108.0...n8n@0.109.0) for this version.<br />
|
||||
**Release date:** 2021-02-22
|
||||
|
||||
@ -252,6 +252,25 @@ webhook URLs get registred with the external services.
|
||||
export WEBHOOK_TUNNEL_URL=https://n8n.example.com/
|
||||
```
|
||||
|
||||
## Prometheus
|
||||
|
||||
In order to collect and expose metrics, n8n uses the
|
||||
[prom-client](https://www.npmjs.com/package/prom-client) library.
|
||||
|
||||
The `/metrics` endpoint is disabled by default, but it is possible to enable it using the `N8N_METRICS` environment variable.
|
||||
|
||||
```bash
|
||||
export N8N_METRICS=true
|
||||
```
|
||||
|
||||
It is also possible to overwrite the prefix of the metric names by setting the `N8N_METRICS_PREFIX` environment variable.
|
||||
|
||||
```bash
|
||||
export N8N_METRICS_PREFIX=n8n_
|
||||
```
|
||||
|
||||
**Note:** At the moment, n8n does not support metrics for webhooks.
|
||||
|
||||
|
||||
## Overwrites for credentials
|
||||
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
# Docker
|
||||
|
||||
Detailed information about how to run n8n in Docker can be found in the README
|
||||
of the [Docker Image](https://github.com/n8n-io/n8n/blob/master/docker/images/n8n/README.md).
|
||||
|
||||
A basic step by step example setup of n8n with docker-compose and Let's Encrypt is available on the
|
||||
[Server Setup](server-setup.md) page.
|
||||
@ -109,3 +109,13 @@ If the Execution data of the workflow should be saved when it succeeds.
|
||||
### Save Manual Executions
|
||||
|
||||
If executions started from the Editor UI should be saved.
|
||||
|
||||
## Retry Failed Workflow Executions
|
||||
|
||||
If your workflow execution fails, you can retry the execution. To retry a failed workflow execution, follow the steps mentioned below:
|
||||
|
||||
1. Click on ***Executions*** in the left sidebar.
|
||||
2. For the workflow execution you want to retry, click on the refresh icon under the ***Status*** column.
|
||||
3. Select either of the following options to retry the execution:
|
||||
- ***Retry with currently saved workflow***: Once you make changes to your workflow, you can select this option to execute the workflow with the previous execution data.
|
||||
- ***Retry with original workflow***: If you want to retry the execution without making changes to your workflow, you can select this option to retry the execution with the previous execution data.
|
||||
|
||||