mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' into creds/google

Browse Source
This commit is contained in:
Tanay Pant 2021-02-02 17:11:51 +01:00
commit cbc92fe13e
42 changed files with 473 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/.vuepress/config.js
View File

@ -75,7 +75,7 @@ module.exports = {
{
description: $page => getDescription($page.frontmatter.description, $page.frontmatter.permalink),
title: ($page, $site) => `${$page.title} | n8n ${$site.title}`,
image: () => 'https://n8n.io/n8n-logo.png',
image: () => '/assets/img/n8n-docs.png',
modifiedAt: $page => $page.lastUpdated && new Date($page.lastUpdated),
url: (_, $site, path) => ($site.themeConfig.domain || '') + path,
}

BIN
docs/.vuepress/public/assets/img/n8n-docs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 51 KiB

20
docs/nodes/credentials/Airtable/README.md
View File

@ -13,13 +13,19 @@ You can use these credentials to authenticate the following nodes with Airtable.
Create an [Airtable](https://airtable.com/) account.
## Using Access Token
## Using API Key
1. Open your Airtable dashboard.
2. Click on your user icon in the top right of the window.
3. Click on the Account button.
4. Under the API section, click "Generate API key".
5. Use this API key with your Airtable node credentials in n8n.
1. Open your Airtable [dashboard](https://airtable.com/).
2. Click on the user icon on the top right and select 'Account' from the dropdown list.
3. Under the ***API*** section, click on the ***Generate API key*** button.
4. Copy the displayed API key.
5. Enter a name for your credentials in the ***Credentials Name*** field in the 'Airtable API' credentials in n8n.
6. Paste the API key in the ***API Key*** field in the 'Airtable API' credentials in n8n.
7. Click on the ***Create*** button to create the credentials.
![Getting Airtable credentials](./using-access-token.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/yPP3ZnynNck" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/Airtable/using-access-token.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 139 KiB

4
docs/nodes/credentials/Beeminder/README.md
View File

@ -14,12 +14,12 @@ Create a [Beeminder](https://Beeminder.io/account) account.
## Using API Key
1. Access your [Beeminder dashboard](https://beeminder.com/home).
1. Open your [Beeminder dashboard](https://beeminder.com/home).
2. Click on your avatar at the top-right corner.
3. Select 'ACCOUNT SETTINGS' from the dropdown list.
4. Scroll up and click on the ***APPS & API*** tab.
5. Copy the ***Auth Token*** displayed in the ***API*** section.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'Beeminder API' credentials in n8n.
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'Beeminder API' credentials in n8n.
7. Enter your username in the ***User*** field.
8. Paste the Auth Token in the ***Auth Token*** field.
9. Click on the ***Save*** button to save your credentials.

48
docs/nodes/credentials/Clickup/README.md
View File

@ -19,24 +19,46 @@ Create a [ClickUp](https://www.clickup.com/) account.
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your ClickUp account to n8n.
:::
1. Open your ClickUp dashboard.
1. Open your ClickUp [dashboard](https://app.clickup.com).
2. Click on your profile icon in the bottom left.
3. Click on ***Integrations*** under your workspace profile.
4. Click on ***ClickUp API***.
5. Click on ***+ Create an App***.
6. Enter a name in the ***App Name*** field.
7. Copy the ***OAuth Callback URL*** from n8n and paste it in the ***Redirect URL(s)*** field.
8. Use the provided ***Client ID*** and ***Client Secret*** with your ClickUp OAuth2 API credentials in n8n.
9. Click on the circle button in the OAuth section to connect a ClickUp account to n8n.
10. Click the ***Save*** button to save your credentials in n8n.
5. Click on the ***+ Create an App*** button under the ***ClikcUp API*** section.
6. Enter the name of your app in the ***App Name*** field.
7. Copy the 'OAuth Callback URL' provided in the 'ClickUp OAuth2 API' credentials in n8n.
8. Paste it in the ***Redirect URL(s)*** field.
9. Click on the ***Create App*** button.
10. Copy the displayed client ID.
11. Enter a name for your credentials in the ***Credentials Name*** field in the 'ClickUp OAuth2 API' credentials in n8n.
12. Paste the client ID in the ***Client ID*** field in the 'ClickUp OAuth2 API' credentials in n8n.
13. Copy the client secret from ClickUp.
14. Paste the client secret in the ***Client Secret*** field in the 'ClickUp OAuth2 API' credentials in n8n.
15. Click on the circle button in the OAuth section to connect a ClickUp account to n8n.
16. Click the ***Save*** button to save your credentials in n8n.
![Getting ClickUp credentials](./using-oauth.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/jPD0p8n-Ddk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
The following video demonstrates the steps to authenticate the ClickUp node on [n8n.cloud](https://n8n.cloud).
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/1CjF_cPNSzM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Open your ClickUp dashboard.
2. Click on your profile icon in the bottom left and click on ***Apps***.
3. Click on ***Generate*** under API Token.
4. Use the API Token with your ClickUp node credentials in n8n.
1. Open the ClickUp [dashboard](https://app.clickup.com).
2. Click on your profile icon in the bottom left.
3. Click on ***Apps*** under your user profile.
4. Click on the ***Generate*** button under the ***API Token*** section.
5. Click on the ***Copy*** button to copy the token.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'ClickUp API' credentials in n8n.
7. Paste the token in the ***Access Token*** field in the 'ClickUp API' credentials in n8n.
8. Click on the ***Create*** button to create the credentials.
![Getting ClickUp credentials](./using-access-token.gif)
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/FMc8uiFT-Eo" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/Clickup/using-access-token.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 240 KiB

BIN
docs/nodes/credentials/Clickup/using-oauth.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 619 KiB

45
docs/nodes/credentials/Github/README.md
View File

@ -20,7 +20,7 @@ Create a [GitHub](https://github.com/) account.
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your GitHub account to n8n.
:::
1. Access your GitHub dashboard.
1. Open your GitHub [dashboard](https://github.com).
2. Click on your user icon in the top right.
3. Click on ***Settings***.
4. Click on ***Developer settings***.
@ -28,24 +28,47 @@ You'll only need to enter the Credentials Name and click on the circle button in
6. Click on the ***Register a new application*** button.
7. Enter the ***Application name*** and ***Homepage URL***.
8. Copy the ***OAuth Callback URL*** from n8n and paste it in the ***Authorization callback URL*** field.
9. Use the provided ***Client ID*** and ***Client Secret*** with your GitHub node credentials in n8n.
10. Click on the circle button in the OAuth section to connect a GitHub account to n8n.
11. Click the ***Save*** button to save your credentials in n8n.
9. Click on the ***Register application*** button.
10. Copy the displayed 'Client ID'.
11. Enter the name for your credentials in the ***Credentials Name*** field in the 'Github OAuth2 API' credentials in n8n.
12. Paste the client ID in the ***Client ID*** field in the 'Github OAuth2 API' credentials in n8n.
13. On your application page, click on the ***Generate a new client secret*** button.
14. Copy the displayed 'Client Secret'.
15. Paste the client secret in the ***Client Secret*** field in the 'Github OAuth2 API' credentials in n8n.
16. Click on the circle button in the OAuth section to connect a GitHub account to n8n.
17. Click the ***Save*** button to save your credentials in n8n.
![Getting GitHub OAuth credentials](./using-oauth.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/O1kEes6mQcs" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
The following video demonstrates the steps to authenticate the GitHub node on [n8n.cloud](https://n8n.cloud).
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/WtjRxIVVCIg" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Access your GitHub dashboard.
1. Open your GitHub [dashboard](https://github.com).
2. Click on your user icon in the top right.
3. Click on ***Settings***.
4. Click on ***Developer settings***.
5. Select ***Personal access tokens***.
6. Click on ***Generate new token***.
7. Select the relevant scopes from the ***Select scopes*** section.
8. Click on the ***Generate token*** button.
8. Use the ***Personal access token*** with your GitHub node credentials in n8n.
9. Click the ***Save*** button to save your credentials in n8n.
7. Enter a note in the ***Note*** field.
8. Select the relevant scopes from the ***Select scopes*** section.
9. Scroll down to the bottom and click on the ***Generate token*** button.
10. Copy the displayed 'Personal access token'.
11. Enter the name for your credentials in the ***Credentials Name*** field in the 'Github API' credentials in n8n.
12. Enter your GitHub username in the ***User*** field in the 'Github API' credentials in n8n.
13. Paste the access token in the ***Access Token*** field in the 'Github API' credentials in n8n.
14. Click the ***Create*** button to save your credentials in n8n.
![Getting GitHub Access Token](./using-access-token.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zookYdMldt4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/Github/using-access-token.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.7 MiB

BIN
docs/nodes/credentials/Github/using-oauth.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 395 KiB

50
docs/nodes/credentials/Mautic/README.md
View File

@ -15,20 +15,44 @@ Create an account on a [Mautic](https://www.mautic.org/) instance.
## Using OAuth
1. Log in to your Mautic account.
2. Click on the gear icon in the top right.
3. Select 'API Credentials' in the dropdown menu.
4. Click on the 'New' button.
5. Select the 'OAuth 2' option from the *Authorization Protocol* dropdown list.
6. Copy the 'OAuth Callback URL' provided in the Mautic OAuth2 API credentials in n8n and paste it in the 'Redirect URI' field in the Mautic credential page.
7. Fill out any other necessary information and click 'Apply'.
8. Click the *Save & Close* button to save your credentials in Mautic.
9. Use the displayed 'Client ID' and the 'Client Secret' with your Mautic OAuth API credentials in n8n.
10. Click on the circle button in the OAuth section to connect a Mautic account to n8n.
11. Click the *Save* button to save your credentials in n8n.
1. Open your Mautic dashboard.
2. Click on the gear icon on the top right and select ***API Credentials***.
3. Click on the ***+ New*** button on the top right.
4. Select 'OAuth 2' from the ***Authorization Protocol*** dropdown list.
5. Enter the name of the credentials in the ***Name*** field.
6. Copy the 'OAuth Callback URL' provided in the 'Mautic OAuth2 API' credentials in n8n.
7. Paste it in the ***Redirect URI*** field on the Mautic credentials page.
8. Click on the ***Apply*** button.
9. Enter the name for your credentials in the ***Credentials Name*** field in the 'Mautic OAuth2 API' credentials in n8n.
10. Copy the ***Client ID*** from the Mautic credentials page.
11. Paste it in the ***Client ID*** field in the 'Mautic OAuth2 API' credentials in n8n.
12. Copy the ***Client Secret*** from the Mautic credentials page.
13. Paste it in the ***Client Secret*** field in the 'Mautic OAuth2 API' credentials in n8n.
14. Enter the URL of your Mautic instance in the ***URL*** field.
15. Click on the circle button in the OAuth section to connect a Mautic account to n8n.
16. Click on the ***Save*** button to save your credentials.
![Getting Mautic OAuth credentials](./using-oauth.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/vEL0wJ2_91E" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Credentials
Use your Mautic username and password as the Mautic API node credentials in n8n.
1. Open your Mautic dashboard.
2. Click on the gear icon on the top right and select ***Configuration***.
3. Select 'API Settings' from the left sidebar.
4. Select 'Yes' under the ***Enable HTTP basic auth?*** section.
5. Click on the ***Apply*** button.
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'Mautic API' credentials in n8n.
7. Enter the URL of your Mautic instance in the ***URL*** field in the 'Mautic API' credentials in n8n.
8. Enter your Mautic username in the ***Username*** field in the 'Mautic API' credentials in n8n.
9. Enter your Mautic password in the ***Password*** field in the 'Mautic API' credentials in n8n.
10. 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/077wqv1rPLs" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/Mautic/using-oauth.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.2 MiB

53
docs/nodes/credentials/PipeDrive/README.md
View File

@ -15,36 +15,51 @@ Create a [Pipedrive](https://pipedrive.com/) account.
## Using OAuth
::: tip ⛅️ Note for n8n.cloud users
<!-- ::: tip ⛅️ Note for n8n.cloud users
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Pipedrive account to n8n.
:::
::: -->
1. Create a [Developer Sandbox Account](https://pipedrive.readme.io/docs/developer-sandbox-account).
2. Access your Pipedrive Dashboard.
3. Click on your user profile in the top right and select 'Tools and apps' from the dropdown list.
2. Open your Pipedrive Dashboard.
3. Click on your user profile in the top right and select 'Tools and integrations' from the dropdown list.
4. From the sidebar under the ***Tools*** section, select 'Marketplace manager'.
5. Click on the ***Create new app*** button.
6. Select either 'Yes' or 'No' when asked if you would like to publish your app on the Pipedrive marketplace.
7. Click on the ***Next*** button.
8. Enter a name in the ***App name*** field.
8. Enter the name of the app in the ***App name*** field.
9. Copy the 'OAuth Callback URL' provided in the 'Pipedrive OAuth2 API' credentials in n8n.
10. On the Pipedrive app creation page, scroll down to the ***OAuth & Access scopes*** section and paste the URL in the ***Callback URL*** field.
11. Click on the ***Save*** button on the top.
12. Select your app from the 'Marketplace Manager'
13. Scroll down to ***OAuth & Access scopes*** section and copy the ***Client ID*** and ***Client Secret***.
14. Use these credentials with your Pipedrive node credentials in n8n.
15. Click on the circle button in the OAuth section to connect a Pipedrive account to n8n.
16. Click on the ***Save*** button to save your credentials.
11. Based on your use-case, select the scopes from the ***Access scopes*** section.
12. Scroll up and click on the ***Save*** button on the top.
13. Select your app from the 'Marketplace manager'
14. Scroll down to ***OAuth & Access scopes*** section and copy the ***Client ID***.
15. Enter the name for your credentials in the ***Credentials Name*** field in the 'Pipedrive OAuth2 API' credentials in n8n.
16. Paste the client ID in the ***Client ID*** field in the 'Pipedrive OAuth2 API' credentials in n8n.
17. On the Pipedrive application page, click on the ***Show*** button next to ***Client Secret***.
18. Copy the ***Client Secret***.
19. Paste the client secret in the ***Client Secret*** field in the 'Pipedrive OAuth2 API' credentials in n8n.
20. Click on the circle button in the OAuth section to connect a Pipedrive account to n8n.
21. Click on the ***Save*** button to save your credentials.
![Getting Pipedrive OAuth credentials](./using-oauth.gif)
The following video demonstrates the steps mentioned above.
## Using Access Token
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/xyRPA-yX9so" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
1. Access your Pipedrive Dashboard.
## Using API Token
1. Open your Pipedrive Dashboard.
2. Click on your user profile in the top right.
3. Select 'Settings' from the dropdown list.
4. Click on the 'API' tab.
5. Click on the ***Generate new token*** button.
6. Use the displayed token with your Pipedrive node credentials in n8n.
3. Select 'Personal preferences' from the dropdown list.
4. Click on the ***API*** tab.
5. Click on the ***Copy*** button to copy the API Token.
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'Pipedrive API' credentials in n8n.
7. Paste the API token in the ***API Token*** field in the 'Pipedrive API' credentials in n8n.
8. Click on the ***Create*** button to save your credentials.
![Getting Pipedrive Access Token](./using-access-token.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/uBdmHiFW7Do" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/PipeDrive/using-access-token.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 302 KiB

BIN
docs/nodes/credentials/PipeDrive/using-oauth.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 12 MiB

33
docs/nodes/credentials/SendGrid/README.md Normal file
View File

@ -0,0 +1,33 @@
---
permalink: /credentials/sendgrid
description: Learn to configure credentials for the SendGrid node in n8n
---
# SendGrid
You can use these credentials to authenticate the following nodes with SendGrid.
- [SendGrid](../../nodes-library/nodes/SendGrid/README.md)
## Prerequisites
Create a [SendGrid](https://SendGrid.com/) account.
## Using API Key
1. Open your SendGrid [dashboard](https://app.sendgrid.com/).
2. Click on ***Settings*** on the left sidebar.
3. Click on ***API Keys***.
4. Click on the ***Create API Key*** button.
5. Enter the name of the key in the ***API Key Name*** field.
6. Click on the ***Create & View*** button.
7. Click on the displayed API key to copy the key.
8. Enter the name for your credentials in the ***Credentials Name*** field in the 'SendGrid API' credentials in n8n.
9. Paste the 'API Key' in the ***API Key*** field.
10. Click on the ***Create*** button to save 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/jlHBMHbd_Jc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

78
docs/nodes/credentials/Slack/README.md
View File

@ -18,38 +18,58 @@ Create a [Slack](https://slack.com/) account.
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Slack account to n8n.
:::
1. Access your Slack workspace.
2. Click on your workspace name in the top left.
3. Click the 'Settings & administration' option, and then 'Manage apps'.
4. Click on the 'Build' button in the top right.
5. Click on the 'Start Building' button if this is your first Slack app, else click on the 'Create New App' button.
6. Enter an app name and select your desired workspace.
7. Scroll down and you will see your authentication information under the ***App Credentials*** section.
8. Copy and paste ***Client ID*** and ***Client Secret*** in the Slack OAuth2 API credentials in n8n.
9. Click on the 'Permissions' button in the ***Add features and functionality*** section.
1. Open the [Slack API](https://api.slack.com/) page.
2. Click on the ***Start Building*** button.
3. Enter the name of the app in the ***App Name*** field.
4. Select a workspace from the ***Development Slack Workspace*** dropdown list.
5. Click on the ***Create App*** button.
6. Scroll down to the ***App Credentials*** section.
7. Copy and paste ***Client ID*** and ***Client Secret*** in the 'Slack OAuth2 API' credentials in n8n.
8. On the Basic Information page, scroll up to the ***Add features and functionality*** section and click on 'Permissions'.
9. Click on the ***Add New Redirect URL*** in the ***Redirect URLs***.
10. Copy the 'OAuth Callback URL' provided in the 'Slack OAuth2 API' credentials in n8n.
11. Click on the ***Add New Redirect URL*** in the ***Redirect URLs*** section in the Slack OAuth & Permissions page.
12. Paste the 'OAuth Callback URL' in the field and click on the ***Save URLs*** button.
13. Scroll down and add any scopes you plan to use under the ***User Token Scopes*** section.
14. If you're building a bot, add the required scopes for the bot under the ***Bot Token Scopes*** section.
15. Click on the circle button in the OAuth section to connect a Slack account to n8n.
16. Click the ***Save*** button to save your credentials in n8n.
11. Paste the URL in the ***Redirect URLs*** field and click on the ***Add*** button.
12. Click on the ***Save URLs*** button.
13. Scroll down to the ***Scopes*** section.
14. Add the required scopes under the ***Bot Token Scopes*** section. You can refer to the list of scopes on the [Scopes and permissions](https://api.slack.com/scopes) documentation on Slack.
15. Enter a name for your credentials in the ***Credentials Name*** field in the 'Slack OAuth2 API' credentials in n8n.
16. Click on the circle button in the OAuth section to connect a Slack account to n8n.
17. Click the ***Save*** button to save your credentials in n8n.
18. On the Slack OAuth & Permissions page, scroll up to the ***OAuth Tokens & Redirect URLs*** section and click on the ***Install to Workspace*** button.
19. Click on the ***Allow*** button.
![Getting Slack OAuth credentials](./using-oauth.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/ewjfY-XQ2Mo" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
The following video demonstrates the steps to authenticate the Slack node on [n8n.cloud](https://n8n.cloud).
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/RHhaDb1KI2o" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Access your Slack workspace.
2. Click on your username in the top left.
3. Click the 'Settings & administration' option, and then 'Manage apps'.
4. Click on ***Build*** in the top right.
5. Click on the ***Start Building*** button if this is your first Slack app, else click on the ***Create an App*** button.
6. Enter an app name and select your desired workspace.
7. Click on the 'Permissions' button in the ***Add features and functionality*** section.
8. Scroll down and add any scopes you plan to use under the ***User Token Scopes*** section.
9. If you're building a bot, add the required scopes for the bot under the ***Bot Token Scopes*** section.
10. Click on the ***Install to Workspace*** button in the ***OAuth Tokens & Redirect URLs*** section.
11. Click on the ***Allow*** button to install the app in your workspace.
12. Use the displayed Access Token with your Slack node credentials in n8n.
1. Open the [Slack API](https://api.slack.com/) page.
2. Click on the ***Start Building*** button.
3. Enter the name of the app in the ***App Name*** field.
4. Select a workspace from the ***Development Slack Workspace*** dropdown list.
5. Click on the ***Create App*** button.
6. Click on 'Permissions' in the ***Add features and functionality*** section.
7. Scroll down to the ***Scopes*** section.
8. If you want your app to act on behalf of users that authorize the app, add the required scopes under the ***User Token Scopes*** section.
9. If you're building a bot, add the required scopes under the ***Bot Token Scopes*** section. You can refer to the list of scopes on the [Scopes and permissions](https://api.slack.com/scopes) documentation on Slack.
10. Scroll up to the ***OAuth Tokens & Redirect URLs*** section and click on the ***Install to Workspace*** button.
11. Click on the ***Allow*** button.
12. Copy the displayed 'OAuth Access Token' under the ***OAuth Tokens for Your Team*** section.
13. Paste it in the ***Access Token*** field in the 'Slack API' credentials in n8n.
14. Enter a name for your credentials in the ***Credentials Name*** field in the 'Slack API' credentials in n8n.
15. Click the ***Save*** button to save your credentials in n8n.
![Getting Slack credentials](./using-access-token.gif)
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/8x3BzKhl_ek" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

BIN
docs/nodes/credentials/Slack/using-access-token.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 3.3 MiB

BIN
docs/nodes/credentials/Slack/using-oauth.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 8.6 MiB

8
docs/nodes/credentials/Zendesk/README.md
View File

@ -15,7 +15,7 @@ Create a [Zendesk](https://zendesk.com/) account.
## Using OAuth
1. Access your Zendesk dashboard.
1. Open your Zendesk dashboard.
2. Click on the gear icon on the left.
3. Click on 'API' under the ***CHANNELS*** section in the sidebar.
4. Click on the ***OAuth Clients*** tab.
@ -37,11 +37,13 @@ Create a [Zendesk](https://zendesk.com/) account.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/ieNHkgUVNhM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Access your Zendesk dashboard.
1. Open your Zendesk dashboard.
2. Click on the gear icon on the left.
3. Click on 'API' under the ***CHANNELS*** section in the sidebar.
4. If ***Token access*** is disabled, click on the switch to toggle it to 'Enabled'.
@ -57,7 +59,9 @@ The following video demonstrates the steps mentioned above.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/AvduoHrFJdQ" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## FAQs

1
docs/nodes/nodes-library/core-nodes/Crypto/README.md
View File

@ -18,6 +18,7 @@ You can configure further options for each action by selecting the type of encry
- Type
- MD5
- SHA256
- SHA384
- SHA512
- Encoding
- BASE64

5
docs/nodes/nodes-library/core-nodes/FunctionItem/README.md
View File

@ -34,7 +34,10 @@ return item;
### Method: getBinaryData()
Returns all the binary data (all keys) of the item which gets currently processed.
```json
item.filename = getBinaryData().attachment_0.fileName;
return item;
```
### Method: setBinaryData(binaryData)

11
docs/nodes/nodes-library/core-nodes/Webhook/README.md
View File

@ -17,6 +17,12 @@ Webhook nodes can be used as triggers for workflows when we want to receive data
While building or testing a workflow, we recommend that you use a test webhook URL. Using a test webhook ensures that you can view the incoming data in the Editor UI, which is useful for debugging. Make sure that you click on the *Execute Node* button to register the webhook before sending the data to the test webhook. The test webhook stays active for 120 seconds.
🎥 The following playlist will help you learn how to use the Webhook node in n8n.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed//videoseries?list=PLlET0GsrLUL5niZQDjW56b_AxpvnEZyps" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Node Reference
First of all, in the parameters section, we have the Webhook URLs. Clicking on that will reveal the URLs for the webhook. Here you have two options, let’s understand the difference between them.
@ -122,6 +128,7 @@ Save the workflow and execute it again by clicking on the ***Execute Workflow***
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.
:::
## FAQs
### Where to find the Webhook URLs?
@ -148,7 +155,9 @@ The [HTTP Request](../HTTPRequest/README.md) node is used to make HTTP requests
Here is a video demonstrating how to send a request to a Webhook based workflow using the HTTP Request node:
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/WLIDTRJGfWw" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube-nocookie.com/embed/WLIDTRJGfWw" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
### How to use cURL to trigger the Webhook node?

2
docs/nodes/nodes-library/nodes/Beeminder/README.md
View File

@ -1,5 +1,5 @@
---
permalink: /nodes/n8n-nodes-base.Beeminder
permalink: /nodes/n8n-nodes-base.beeminder
description: Learn how to use the Beeminder node in n8n
---

8
docs/nodes/nodes-library/nodes/GitHub/README.md
View File

@ -41,8 +41,16 @@ You can find authentication information for this node [here](../../../credential
- Creates a new release
:::
::: details Review
- Create a new review
- Get a review for a pull request
- Get all revies for a pull request
- Update a review
:::
::: details User
- Returns the repositories of a user
- Invite a user to an organization
:::
## Example Usage

8
docs/nodes/nodes-library/nodes/GoogleDrive/README.md
View File

@ -13,6 +13,14 @@ You can find authentication information for this node [here](../../../credential
## Basic Operations
::: details Drive
- Create a drive
- Delete a drive
- Get a drive
- List all drives
- Update a drive
:::
::: details File
- Copy a file
- Delete a file

4
docs/nodes/nodes-library/nodes/Nextcloud/README.md
View File

@ -29,6 +29,10 @@ You can find authentication information for this node [here](../../../credential
- Move a folder
:::
::: details User
- Invite a user to a Nextcloud organization
:::
## Example Usage
This workflow allows you to create a folder in Nextcloud, upload a file into that folder, and list the contents of the folder. You can also find the [workflow](https://n8n.io/workflows/620) on n8n.io. This example usage workflow would use the following nodes.

94
docs/nodes/nodes-library/nodes/SendGrid/README.md Normal file
View File

@ -0,0 +1,94 @@
---
permalink: /nodes/n8n-nodes-base.sendGrid
description: Learn how to use the SendGrid node in n8n
---
# SendGrid
[SendGrid](https://SendGrid.co) provides a cloud-based service that assists businesses with email delivery.
::: tip 🔑 Credentials
You can find authentication information for this node [here](../../../credentials/SendGrid/README.md).
:::
## Basic Operations
::: details Contact
- Create/Update a contact
- Delete a contact
- Get a contact by ID
- Get all contacts
:::
::: details List
- Create a list
- Delete a list
- Get a list
- Get all lists
- Update a list
:::
## Example Usage
This workflow allows you to create, update and get a contact using the SendGrid node. You can also find the [workflow](https://n8n.io/workflows/901) on n8n.io. This example usage workflow uses the following nodes.
- [Start](../../core-nodes/Start/README.md)
- [SendGrid]()
The final workflow should look like the following image.
![A workflow with the SendGrid node](./workflow.png)
### 1. Start node
The Start node exists by default when you create a new workflow.
### 2. SendGrid node (upsert:contact)
This node will create a contact in SendGrid.
1. First of all, you'll have to enter credentials for the SendGrid node. You can find out how to do that [here](../../../credentials/SendGrid/README.md).
2. Select 'Contact' from the ***Resource*** dropdown list.
3. Select 'Create/Update' from the ***Operation*** dropdown list.
4. Enter an email address in the ***Email*** field.
5. Click on the ***Add Field*** button and select 'First Name'.
6. Enter the name of the contact in the ***First Name*** field.
7. Click on ***Execute Node*** to run the node.
In the screenshot below, you will notice that the node creates contact with their first name.
![Using the SendGrid node to create a new contact](./SendGrid_node.png)
### 3. SendGrid1 node (upsert:contact)
This node will update the contact that we created in the previous node.
::: v-pre
1. Select the credentials that you entered in the previous node.
2. Select 'Contact' from the ***Resource*** dropdown list.
3. Select 'Create/Update' 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 > SendGrid > Parameters > email. You can also add the following expression: `{{$node["SendGrid"].parameter["email"]}}`.
6. Click on the ***Add Field*** button and select 'Last Name'.
7. Enter the last name of the contact in the ***Last Name*** field.
8. Click on ***Execute Node*** to run the node.
:::
In the screenshot below, you will notice that the node updates the contact that we created in the previous node.
![Using the SendGrid node to update a contact](./SendGrid1_node.png)
### 4. SendGrid2 node (get:contact)
This node will return the information of the contact that we created using the SendGrid node.
::: v-pre
1. Select the credentials that you entered in the previous node.
2. Select 'Contact' from the ***Resource*** dropdown list.
3. Select 'Get' from the ***Operation*** dropdown list.
4. Select 'Email' from the ***By*** dropdown list.
5. Click on the gears icon next to the ***Email*** field and click on ***Add Expression***.
6. Select the following in the ***Variable Selector*** section: Nodes > SendGrid > Parameters > email. You can also add the following expression: `{{$node["SendGrid"].parameter["email"]}}`.
7. Click on ***Execute Node*** to run the node.
:::
In the screenshot below, you will notice that the node returns the information of the contact that we created using the SendGrid node.
![Using the SendGrid node to get information of a contact](./SendGrid2_node.png)

BIN
docs/nodes/nodes-library/nodes/SendGrid/SendGrid1_node.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 131 KiB

BIN
docs/nodes/nodes-library/nodes/SendGrid/SendGrid2_node.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 131 KiB

BIN
docs/nodes/nodes-library/nodes/SendGrid/SendGrid_node.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 128 KiB

BIN
docs/nodes/nodes-library/nodes/SendGrid/workflow.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 122 KiB

3
docs/nodes/nodes-library/nodes/Slack/README.md
View File

@ -40,7 +40,10 @@ You can find authentication information for this node [here](../../../credential
:::
::: details Message
- Delete a message
- Get the permanent link of a message
- Post a message in a channel
- Post an ephemeral message to a user in a channel
- Update a message
:::

4
docs/nodes/nodes-library/nodes/Trello/README.md
View File

@ -5,7 +5,7 @@ description: Learn how to use the Trello node in n8n
# Trello
[Trello](https://trello.com/) is a web-based Kanban-style list-making application which is a subsidiary of Atlassian. Users can create their task boards with different columns and move the tasks between them.
[Trello](https://trello.com/) is a web-based Kanban-style list-making application which is a subsidiary of Atlassian. Users can create their task boards with different columns and move the tasks between them.
::: tip 🔑 Credentials
You can find authentication information for this node [here](../../../credentials/Trello/README.md).
@ -59,6 +59,8 @@ You can find authentication information for this node [here](../../../credential
- Archive/Unarchive a list
- Create a new list
- Get the data of a list
- Get all the lists
- Get all the cards in a list
- Update a list
:::

9
docs/nodes/nodes-library/nodes/Wekan/README.md
View File

@ -62,7 +62,7 @@ This workflow allows you to create a board and two lists called `To Do` and `Don
The final workflow should look like the following image.
![A workflow with the Wekan node](./workflow.png)
![A workflow with the Wekan node](./workflow.png)
::: v-pre
### 1. Start node
@ -162,3 +162,10 @@ In the screenshot below, you will notice that the node updates the list id of th
:::
![Using the Wekan node to update the card](./Wekan4_node.png)
## FAQs
### How to load all the parameters for the node?
To load all the parameters, for example, Author ID, you need to give admin permissions to the user. Refer to the [Wekan documentation](https://github.com/wekan/wekan/wiki/Features#members-click-member-initials-or-avatar--permissions-adminnormalcomment-only) to learn how to change permissions.

51
docs/reference/changelog.md
View File

@ -2,6 +2,55 @@
🛠 = 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.105.0
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.104.2...n8n@0.105.0) for this version.<br />
**Release date:** 2021-02-01
- New nodes
- Discourse
- SecurityScorecard
- TimescaleDB
- Enhanced nodes
- Affinity: Added List and List Entry resource
- Asana: Added Project IDs option to the Create operation of the Task resource
- Hubspot Trigger: Added support for multiple subscriptions
- Jira: Added Issue Attachment resource and added custom fields to Create and Update operations of the Issue resource
- Todoist: Added Section option
- Bug fixes
- SIGNL4: Fixed an issue with the attachment functionality
- Added variable `$mode` to check the mode in which the workflow is being executed
## n8n@0.104.2
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.104.1...n8n@0.104.2) for this version.<br />
**Release date:** 2021-01-27
- Fixed an issue with the credentials parameters that have the same name
## n8n@0.104.1
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.104.0...n8n@0.104.1) for this version.<br />
**Release date:** 2021-01-26
- Fixed a bug with expressions in credentials
## n8n@0.104.0 🛠
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.103.1...n8n@0.104.0) for this version.<br />
**Release date:** 2021-01-26
- New nodes
- Compression
- Enhanced nodes
- GitHub: Added Invite operation to the User resource
- EmailReadImap: Increased the authentication timeout
- Mautic: Added Custom Fields option to the Create and Update operations of the Contact resource. Also, the Mautic OAuth credentials have been updated. Now you don't have to enter the Authorization URL and the Access Token URL
- Nextcloud: Added User resource
- Slack: Added Get Permalink and Delete operations to the Message resource
- Webhook: Added support for request parameters in webhook paths
- Bug fixes
- Google Drive: Fixed the default value for the Send Notification Email option
- Added support for expressions to credentials
- Removed support for MongoDB as a database for n8n. For more details, check out the entry in the [breaking changes](https://github.com/n8n-io/n8n/blob/master/packages/cli/BREAKING-CHANGES.md#01040) page
## n8n@0.103.1
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.103.0...n8n@0.103.1) for this version.<br />
**Release date:** 2021-01-21
@ -25,7 +74,7 @@ For a comprehensive list of changes, check out the [commits](https://github.com/
- AWS Lambda: Fixed an issue with signature
- AWS SNS: Fixed an issue with signature
- Fixed an issue with nodes not executing if two input gets passed and one of them didn't return any data
- The code editor can be closed either by clicking on the close (X) button or using the `ESC` key
- The code editor does not get closed when clicked anywhere outside the editor
- Added CLI commands to [export](start-workflows-via-cli.md#export-workflows-and-credentials) and [import](start-workflows-via-cli.md#import-workflows-and-credentials) credentials and workflows
- The title in the browser tab now resets for new workflows

26
docs/reference/contributing.md
View File

@ -20,11 +20,35 @@ n8n users come from a wide range of backgrounds, experience levels, and interest
You can participate in the [forum](https://community.n8n.io/) and help the community members out with their questions.
When sharing workflows in the community forum for debugging, use code blocks. Use triple backticks (```) to wrap the workflow JSON in a code block.
The following video demonstrates the steps of sharing workflows on the community forum.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/dVC8yLqUvCE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Contribute a workflow 🧬
You can publish workflows on [n8n.io](https://n8n.io/workflows) to help other users to get started.
To share a workflow, follow these steps.
1. Sign in to [n8n.io](https://n8n.io/login).
2. Open the [workflows](https://n8n.io/workflows) page.
3. Click on the ***+ Share New Workflow*** button.
4. Enter the name of your workflow in the ***Name*** field. The name of a workflow makes it easy for others to understand the purpose of the workflow.
5. Enter a detailed description of the workflow in the ***Description*** field. Make sure the description contains information about the nodes used in the workflow.
6. Add a screenshot of the workflow in the description.
7. In n8n, select all the nodes in your workflow (Ctrl + A) and copy them (Ctrl + C).
8. Delete the existing code in the ***Workflow Code*** field and paste your workflow in it (Ctrl + V).
9. Click on the ***Publish Workflow to Share*** button to share your workflow.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/wcoirYBEgYc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Contribute to the docs 📚
@ -39,7 +63,7 @@ We have the following process for guest contributions to our [Medium publication
3. After you submit the piece, one of our team members would start a first edit (we usually do this in Google docs), where they'll try running through the article to check if everything is clear and easy to follow.
4. Once all the questions or comments are resolved, we'll do a final review before publishing the article on our Medium publication.
Depending on the length of the article and the changes that might be required, there would be a bit of a back and forth and the whole process might take somewhere between a couple of days to a week or two.
Depending on the length of the article and the changes that might be required, there would be a bit of a back and forth and the whole process might take somewhere between a couple of days to a week or two.
## Contribute to n8n 🔨

28
docs/reference/data/database.md
View File

@ -10,34 +10,6 @@ The following environment variables get used by all databases:
- `DB_TABLE_PREFIX` (default: '') - Prefix for table names
## MongoDB
::: danger
Use PostgresDB, if possible! MongoDB has problems saving large
amounts of data in a document, among other issues. So, support
will be dropped in the future.
:::
To use MongoDB as the database, you can provide the following environment variables like
in the example below:
- `DB_TYPE=mongodb`
- `DB_MONGODB_CONNECTION_URL=<CONNECTION_URL>`
Replace the following placeholders with the actual data:
- MONGO_DATABASE
- MONGO_HOST
- MONGO_PORT
- MONGO_USER
- MONGO_PASSWORD
```bash
export DB_TYPE=mongodb
export DB_MONGODB_CONNECTION_URL=mongodb://MONGO_USER:MONGO_PASSWORD@MONGO_HOST:MONGO_PORT/MONGO_DATABASE
n8n start
```
## PostgresDB
To use PostgresDB as the database, you can provide the following environment variables

6
docs/reference/function-nodes.md
View File

@ -22,3 +22,9 @@ possible via the methods `getBinaryData` and `setBinaryData`.
Both nodes support promises. So instead of returning the item or items directly, it is also possible to
return a promise which resolves accordingly.
#### Comparison
| Data to access | Function | FunctionItem |
| :-------------------------- | :--------------------- | :--------------- |
| JSON data | items\[_index_\].json | item |
| Binary data | items\[_index_\].binary | getBinaryData() |

5
docs/reference/reference.md
View File

@ -11,7 +11,10 @@ Interested in learning more about n8n? You've come to the right place.
- [Security](security.md)
- [Docker](docker.md)
- [Server Setup](server-setup.md)
- [Use n8n via CLI](start-workflows-via-cli.md)
- [CLI commands for n8n](start-workflows-via-cli.md)
- [JavaScript Code Snippets](javascript-code-snippets.md)
- [Glossary](glossary.md)
- [Function and Function Items Nodes](function-nodes.md)
- [Troubleshooting](troubleshooting.md)
- [Data](data/data-structure.md)
- [Contributing](contributing.md)

BIN
docs/reference/using-code-block.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 148 KiB