Merge branch 'master' into docs/sendy
@ -31,3 +31,4 @@
|
||||
- [n8n basics 2/3 - Simple Workflow](https://www.youtube.com/watch?v=ovlxledZfM4)
|
||||
- [n8n basics 3/3 - Transforming JSON](https://www.youtube.com/watch?v=wGAEAcfwV8w)
|
||||
- [n8n nodes - Using Google Sheets and Google API](https://www.youtube.com/watch?v=KFqx8OmkqVE)
|
||||
- [Raspberry Pi as a local server for self-hosting applications like n8n](https://cri.dev/posts/2020-09-12-Raspberry-Pi-as-a-local-server-for-self-hosting-applications/)
|
||||
|
||||
24
docs/nodes/credentials/Matrix/README.md
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
permalink: /credentials/matrix
|
||||
description: Learn to configure credentials for the Matrix node in n8n
|
||||
---
|
||||
|
||||
# Matrix
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Matrix.
|
||||
- [Matrix](../../nodes-library/nodes/Matrix/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create an account on a Matrix server.
|
||||
|
||||
## Using Access Token
|
||||
|
||||
1. Access the Matrix server.
|
||||
2. Click on your username in the top left corner.
|
||||
3. Select 'All settings' from the dropdown list.
|
||||
4. Click on ***Help & About*** in the left sidebar.
|
||||
5. Scroll down to the ***Advanced*** section.
|
||||
6. Click on ***click to reveal*** next to 'Access Token'.
|
||||
7. Copy the 'Homeserver URL' under the ***Advanced*** section if you are using a custom server.
|
||||
8. Use this Homeserver URL and Access Token with your Matrix node credentials in n8n.
|
||||
@ -22,3 +22,5 @@ Create a [Mindee](https://mindee.com) account.
|
||||
6. Enter a name for the token.
|
||||
7. Click on ***Add new key***.
|
||||
8. Use this API key with your Mindee node credentials in n8n.
|
||||
|
||||

|
||||
BIN
docs/nodes/credentials/Mindee/using-api-key.gif
Normal file
|
After Width: | Height: | Size: 3.9 MiB |
@ -18,28 +18,36 @@ 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 dashboard.
|
||||
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 'Build' in the top right.
|
||||
5. Click on 'Create New App' button.
|
||||
6. Enter app name and select your desired workspace.
|
||||
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 circle button in the OAuth section to connect a Slack account to n8n.
|
||||
10. Click the ***Save*** button to save your credentials in n8n.
|
||||
9. Click on the 'Permissions' button in the ***Add features and functionality*** section.
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## Using Access Token
|
||||
|
||||
1. Access your Slack dashboard.
|
||||
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 'Start Building'.
|
||||
6. Enter app name and select your desired workspace.
|
||||
7. Scroll down and you will see your authentication information under the ***App Credentials*** section.
|
||||
8. Use your Verification Token with your Slack node credentials in n8n.
|
||||
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. 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. Use your Verification Token with your Slack node credentials in n8n.
|
||||
|
||||

|
||||
|
||||
19
docs/nodes/credentials/Vonage/README.md
Normal file
@ -0,0 +1,19 @@
|
||||
---
|
||||
permalink: /credentials/vonage
|
||||
description: Learn to configure credentials for the Vonage node in n8n
|
||||
---
|
||||
|
||||
# Vonage
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Vonage.
|
||||
- [Vonage](../../nodes-library/nodes/Vonage/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Create a [Vonage](https://vonage.com) account.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Access the [Vonage dashboard](https://dashboard.nexmo.com/).
|
||||
2. Copy the ***API key*** and the ***API Secret*** from the dashboard.
|
||||
3. Use this ***API Key*** and ***API Secret*** with your Vonage node credentials in n8n.
|
||||
17
docs/nodes/credentials/Wekan/README.md
Normal file
@ -0,0 +1,17 @@
|
||||
---
|
||||
permalink: /credentials/wekan
|
||||
description: Learn to configure credentials for the Wekan node in n8n
|
||||
---
|
||||
|
||||
# Wekan
|
||||
|
||||
You can use these credentials to authenticate the following nodes with Wekan.
|
||||
- [Wekan](../../nodes-library/nodes/Wekan/README.md)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Install [Wekan](https://github.com/wekan/wekan/wiki) on your server.
|
||||
|
||||
## Using API Key
|
||||
|
||||
1. Use the Wekan username, password, and URL with your Wekan node credentials in n8n.
|
||||
@ -20,3 +20,5 @@ Create a [Wufoo](https://wufoo.com) account.
|
||||
4. Click on ***Account*** from the top right corner and select 'My Account' from the dropdown list.
|
||||
5. Copy the ***Subdomain***.
|
||||
6. Use this ***API Key*** and ***Subdomain*** with your Wufoo Trigger node credentials in n8n.
|
||||
|
||||

|
||||
BIN
docs/nodes/credentials/Wufoo/using-api-key.gif
Normal file
|
After Width: | Height: | Size: 471 KiB |
@ -5,6 +5,6 @@ description: Learn how to use the No Operation, do nothing node in n8n
|
||||
|
||||
# No Operation, do nothing
|
||||
|
||||
The No Operation, do nothing node is used when you don't want to perform any operations. The purpose of this node is to make the workflow easier to read and understand where the flow of data stops. This can sometimes help with others a better understanding of the workflow, visually.
|
||||
The No Operation, do nothing node is used when you don't want to perform any operations. The purpose of this node is to make the workflow easier to read and understand where the flow of data stops. This can sometimes help others with a better understanding of the workflow, visually.
|
||||
|
||||
As an example, checkout how this node is being used in the [Creating Your First Workflow](../../../../getting-started/creating-your-first-workflow.md) guide.
|
||||
|
||||
BIN
docs/nodes/nodes-library/nodes/Matrix/IF_node.png
Normal file
|
After Width: | Height: | Size: 165 KiB |
BIN
docs/nodes/nodes-library/nodes/Matrix/Matrix1_node.png
Normal file
|
After Width: | Height: | Size: 109 KiB |
BIN
docs/nodes/nodes-library/nodes/Matrix/Matrix2_node.png
Normal file
|
After Width: | Height: | Size: 184 KiB |
BIN
docs/nodes/nodes-library/nodes/Matrix/Matrix3_node.png
Normal file
|
After Width: | Height: | Size: 126 KiB |
BIN
docs/nodes/nodes-library/nodes/Matrix/Matrix4_node.png
Normal file
|
After Width: | Height: | Size: 134 KiB |
BIN
docs/nodes/nodes-library/nodes/Matrix/Matrix_node.png
Normal file
|
After Width: | Height: | Size: 138 KiB |
BIN
docs/nodes/nodes-library/nodes/Matrix/NoOp_node.png
Normal file
|
After Width: | Height: | Size: 120 KiB |
167
docs/nodes/nodes-library/nodes/Matrix/README.md
Normal file
@ -0,0 +1,167 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.matrix
|
||||
description: Learn how to use the Matrix node in n8n
|
||||
---
|
||||
|
||||
# Matrix
|
||||
|
||||
[Matrix](https://matrix.org) is an open standard for interoperable, decentralized, real-time communication over IP.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Matrix/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Account
|
||||
- Get current user's account information
|
||||
:::
|
||||
|
||||
::: details Event
|
||||
- Get a single event by ID
|
||||
:::
|
||||
|
||||
::: details Media
|
||||
- Send media to a chat room
|
||||
:::
|
||||
|
||||
::: details Message
|
||||
- Send a message to a room
|
||||
- Get all messages from a room
|
||||
:::
|
||||
|
||||
::: details Room
|
||||
- New chat room with defined settings
|
||||
- Invite a user to a room
|
||||
- Join a new room
|
||||
- Kick a user from a room
|
||||
- Leave a room
|
||||
:::
|
||||
|
||||
::: details Room Member
|
||||
- Get all members
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create a room, invite members from a different room, and send a message to the room that we created using the Matrix node. You can also find the [workflow](https://n8n.io/workflows/724) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [Matrix]()
|
||||
- [IF](../../core-nodes/IF/README.md)
|
||||
- [No Operation, do nothing](../../core-nodes/NoOperationDoNothing/README.md)
|
||||
|
||||
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. Matrix node (create: room)
|
||||
|
||||
This node will create a new room called `n8n` on the Matrix server.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Matrix node. You can find out how to do that [here](../../../credentials/Matrix/README.md).
|
||||
::: v-pre
|
||||
2. Select 'Room' from the ***Resource*** dropdown list.
|
||||
3. Enter `n8n` in the ***Room Name*** field. You can also enter a different name for the room.
|
||||
4. Enter an alias for the room in the ***Room Alias*** field.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node creates a room `n8n` with an alias `#discussion-n8n:matrix.org`.
|
||||
|
||||

|
||||
|
||||
### 3. Matrix1 node (me: account)
|
||||
|
||||
This node will get your account information from the Matrix server. We are doing this because Matrix will send an invite to all members of the room, including you. Since you are already a member of the room, you will get an error. We will use the data from this node later on to make sure that you don't send an invite to yourself.
|
||||
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Account' from the ***Resource*** dropdown list.
|
||||
3. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node returns your user ID.
|
||||
|
||||

|
||||
|
||||
### 3. Matrix2 node (getAll: roomMember)
|
||||
|
||||
This node will return the information of all the members in a room.
|
||||
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Room Member' from the ***Resource*** dropdown list.
|
||||
3. Select a room from the ***Room ID*** dropdown list. We will invite the members of this room later on in the workflow.
|
||||
4. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information of all the members in the room that we specified. The output of this node will be passed on to the next nodes in the workflow.
|
||||
|
||||

|
||||
|
||||
### 4. IF node
|
||||
|
||||
This node will compare your user ID with the user ID of other members. If the user IDs are not equal, the output will be true.
|
||||
|
||||
::: 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: Nodes > Matrix1 > Output Data > JSON > user_id. You can also add the following expression: `{{$node["Matrix1"].json["user_id"]}}`.
|
||||
4. Select 'Not Equal' from the ***Operation*** dropdown list.
|
||||
5. Click on the gears icon next to the ***Value 2*** field and click on ***Add Expression***.
|
||||
6. Select the following in the ***Variable Selector*** section: Nodes > Matrix2 > Output Data > JSON > user_id. You can also add the following expression: `{{$node["Matrix2"].json["user_id"]}}`.
|
||||
7. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node returns the information of all the members of the room except your own.
|
||||
|
||||

|
||||
|
||||
### 4. Matrix3 node (invite: room)
|
||||
|
||||
This node will send an invitation to the members returned by the previous node to join the room that we created using the Matrix node.
|
||||
|
||||
::: v-pre
|
||||
1. Connect the node to the 'true' output of the IF node
|
||||
2. Select the credentials that you entered in the previous node.
|
||||
3. Select 'Room' from the ***Resource*** dropdown list.
|
||||
4. Select 'Invite' from the ***Operation*** dropdown list.
|
||||
5. Click on the gears icon next to the ***Room ID*** field and click on ***Add Expression***.
|
||||
6. Select the following in the ***Variable Selector*** section: Nodes > Matrix > Output Data > JSON > room_id. You can also add the following expression: `{{$node["Matrix"].json["room_id"]}}`.
|
||||
7. Click on the gears icon next to the ***User ID*** field and click on ***Add Expression***.
|
||||
8. Select the following in the ***Variable Selector*** section: Nodes > IF > Output Data > JSON > user_id. You can also add the following expression: `{{$node["IF"].json["user_id"]}}`.
|
||||
9. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node sends an invite to join the `n8n` room to the members of the other room.
|
||||
|
||||

|
||||
|
||||
### 5. Matrix4 node (create: message)
|
||||
|
||||
This node will send a message to the new room that we created using the Matrix node.
|
||||
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Click on the gears icon next to the ***Room ID*** field and click on ***Add Expression***.
|
||||
3. Select the following in the ***Variable Selector*** section: Nodes > Matrix > Output Data > JSON > room_id. You can also add the following expression: `{{$node["Matrix"].json["room_id"]}}`.
|
||||
4. Enter a message in the ***Text*** field.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node sends a message to the room that we created with the Matrix node.
|
||||
|
||||

|
||||
|
||||
### 6. 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. We've added this as it can sometimes help others with a better understanding of the workflow, visually.
|
||||
|
||||
::: v-pre
|
||||
1. Create a ***NoOp*** node connected to the 'false' output of the IF node.
|
||||
2. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Matrix/workflow.png
Normal file
|
After Width: | Height: | Size: 183 KiB |
@ -42,7 +42,7 @@ The Start node exists by default when you create a new workflow.
|
||||
|
||||
### 2. Sendy node (add: subscriber)
|
||||
|
||||
This node will add a subscriber to a list in Sendy. If you don't have a list in Sendy, make sure to create one.
|
||||
This node will add a subscriber to a list in Sendy. If you don't already have a list in Sendy, make sure to create one.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Sendy node. You can find out how to do that [here](../../../credentials/Sendy/README.md).
|
||||
2. Enter the subscriber's email address in the ***Email*** field.
|
||||
@ -51,13 +51,13 @@ This node will add a subscriber to a list in Sendy. If you don't have a list in
|
||||
5. Enter the name of the subscriber in the ***Name*** field.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node adds a subscriber with their name to the list we specify.
|
||||
In the screenshot below, you will notice that the node adds a subscriber with their name to the list that we specify.
|
||||
|
||||

|
||||
|
||||
### 3. Sendy1 node (create: campaign)
|
||||
|
||||
This node will create a campaign with the title 'Welcome to n8n' and send it to the subscribers of the list we specify.
|
||||
This node will create a campaign with the title 'Welcome to n8n' and send it to the subscribers of the list that we specify.
|
||||
::: v-pre
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Campaign' from the ***Resource*** dropdown list.
|
||||
@ -73,6 +73,6 @@ This node will create a campaign with the title 'Welcome to n8n' and send it to
|
||||
12. Select the following in the ***Variable Selector*** section: Nodes > Sendy > Parameters > listId. You can also add the following expression: `{{$node["Sendy"].parameter["listId"]}}`.
|
||||
13. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
In the screenshot below, you will notice that the node creates the campaign with the title `Welcome to n8n` and sends it to the list we specify.
|
||||
In the screenshot below, you will notice that the node creates the campaign with the title `Welcome to n8n` and sends it to the list that we specify.
|
||||
|
||||

|
||||
|
||||
BIN
docs/nodes/nodes-library/nodes/Vonage/Cron_node.png
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
docs/nodes/nodes-library/nodes/Vonage/OpenWeatherMap_node.png
Normal file
|
After Width: | Height: | Size: 196 KiB |
70
docs/nodes/nodes-library/nodes/Vonage/README.md
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.vonage
|
||||
description: Learn how to use the Vonage node in n8n
|
||||
---
|
||||
|
||||
# Vonage
|
||||
|
||||
[Vonage](https://vonage.com/) provides unified communications, contact centers, and programmable communications APIs.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Vonage/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details SMS
|
||||
- Send
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to send daily weather updates via an SMS message using the Vonage node. You can also find the [workflow](https://n8n.io/workflows/723) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Cron](../../core-nodes/Cron/README.md)
|
||||
- [OpenWeatherMap](../../nodes/OpenWeatherMap/README.md)
|
||||
- [Vonage]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
### 1. Cron node
|
||||
|
||||
The Cron node will trigger the workflow daily at 9 AM.
|
||||
|
||||
1. Click on ***Add Cron Time***.
|
||||
2. Set hours to 9 in the ***Hour*** field.
|
||||
3. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the Cron node is configured to trigger the workflow every day at 9 AM.
|
||||
|
||||

|
||||
|
||||
### 2. OpenWeatherMap node (Current Weather)
|
||||
|
||||
This node will return data about the current weather in Berlin. To get the weather updates for your city, you can enter the name of your city instead.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the OpenWeatherMap node. You can find out how to do that [here](../../../credentials/OpenWeatherMap/README.md).
|
||||
2. Enter `berlin` in the ***City*** field.
|
||||
3. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node returns data about the current weather in Berlin.
|
||||
|
||||

|
||||
|
||||
### 3. Vonage node (send: sms)
|
||||
|
||||
This node will send an SMS with the weather update, which was sent by the previous node.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Vonage node. You can find out how to do that [here](../../../credentials/Vonage/README.md).
|
||||
2. Enter a Vonage phone number or the brand name in the ***From*** field.
|
||||
3. Enter the receiver's phone number in the ***To*** field.
|
||||
4. Click on the gears icon next to the ***Message*** field and click on ***Add Expression***.
|
||||
::: v-pre
|
||||
5. Enter the following message in the ***Expression*** field: `Hey! The temperature outside is {{$node["OpenWeatherMap"].json["main"]["temp"]}}°C.`.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
:::
|
||||
|
||||
In the screenshot below, you will notice that the node sends an SMS to the phone number that we specified with the weather update, which was sent by the previous node.
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Vonage/Vonage_node.png
Normal file
|
After Width: | Height: | Size: 187 KiB |
BIN
docs/nodes/nodes-library/nodes/Vonage/workflow.png
Normal file
|
After Width: | Height: | Size: 147 KiB |
164
docs/nodes/nodes-library/nodes/Wekan/README.md
Normal file
@ -0,0 +1,164 @@
|
||||
---
|
||||
permalink: /nodes/n8n-nodes-base.wekan
|
||||
description: Learn how to use the Wekan node in n8n
|
||||
---
|
||||
|
||||
# Wekan
|
||||
|
||||
[Wekan](https://wekan.github.io/) is an open-source kanban board that allows a card-based task and to-do management.
|
||||
|
||||
::: tip 🔑 Credentials
|
||||
You can find authentication information for this node [here](../../../credentials/Wekan/README.md).
|
||||
:::
|
||||
|
||||
## Basic Operations
|
||||
|
||||
::: details Board
|
||||
- Create a new board
|
||||
- Delete a board
|
||||
- Get the data of a board
|
||||
- Get all user boards
|
||||
:::
|
||||
|
||||
::: details Card
|
||||
- Create a new card
|
||||
- Delete a card
|
||||
- Get a card
|
||||
- Update a card
|
||||
:::
|
||||
|
||||
::: details Card Comment
|
||||
- Create a comment on a card
|
||||
- Delete a comment from a card
|
||||
- Get a card comment
|
||||
- Get all card comments
|
||||
:::
|
||||
|
||||
::: details Checklist
|
||||
- Create a new checklist
|
||||
- Delete a checklist
|
||||
- Get the data of a checklist
|
||||
- Returns all checklists for the card
|
||||
:::
|
||||
|
||||
::: details Checklist Item
|
||||
- Delete a checklist item
|
||||
- Get a checklist item
|
||||
- Update a checklist item
|
||||
:::
|
||||
|
||||
::: details List
|
||||
- Create a new list
|
||||
- Delete a list
|
||||
- Get the data of a list
|
||||
- Get all board lists
|
||||
:::
|
||||
|
||||
## Example Usage
|
||||
|
||||
This workflow allows you to create a board and two lists called `To Do` and `Done` using the Wekan node. It also allows you to create a card and update the list ID of the card, enabling you to move it from the `To Do` list to the `Done` list. You can also find the [workflow](https://n8n.io/workflows/728) on n8n.io. This example usage workflow uses the following nodes.
|
||||
- [Start](../../core-nodes/Start/README.md)
|
||||
- [Wekan]()
|
||||
|
||||
The final workflow should look like the following image.
|
||||
|
||||

|
||||
|
||||
::: v-pre
|
||||
### 1. Start node
|
||||
|
||||
The start node exists by default when you create a new workflow.
|
||||
:::
|
||||
|
||||
### 2. Wekan node (create: board)
|
||||
|
||||
This node will create a board called `Documentation` in Wekan. To create a board with a different name, you can enter the name of your board instead.
|
||||
|
||||
1. First of all, you'll have to enter credentials for the Wekan node. You can find out how to do that [here](../../../credentials/Wekan/README.md).
|
||||
::: v-pre
|
||||
2. Select 'Board' from the ***Resource*** dropdown list.
|
||||
3. Enter `Documentation` in the ***Title*** field.
|
||||
4. Select the owner of the board from the ***Owner*** dropdown list.
|
||||
5. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new board with the title `Documentation`.
|
||||
:::
|
||||
|
||||

|
||||
|
||||
::: v-pre
|
||||
### 3. Wekan1 node (create: list)
|
||||
|
||||
This node will create a list with the title `To Do` in the `Documentation` board, which was created using the previous node.
|
||||
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'List' from the ***Resource*** dropdown list.
|
||||
3. Click on the gears icon next to the ***Board ID*** field and click on ***Add Expression***.
|
||||
4. Select the following in the ***Variable Selector*** section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan"].json["_id"]}}`.
|
||||
5. Enter `To Do` in the ***Title*** field.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new list called `To Do` in the `Documentation` board.
|
||||
:::
|
||||
|
||||

|
||||
|
||||
::: v-pre
|
||||
### 4. Wekan2 node (create: list)
|
||||
|
||||
This node will create a list with the title `Done` in the `Documentation` board, which was created using the Wekan node.
|
||||
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'List' from the ***Resource*** dropdown list.
|
||||
3. Click on the gears icon next to the ***Board ID*** field and click on ***Add Expression***.
|
||||
4. Select the following in the ***Variable Selector*** section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan"].json["_id"]}}`.
|
||||
5. Enter `Done` in the ***Title*** field.
|
||||
6. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new list called `Done` in the `Documentation` board.
|
||||
:::
|
||||
|
||||

|
||||
|
||||
::: v-pre
|
||||
### 5. Wekan3 node (create: card)
|
||||
|
||||
This node will create a card in the `Documentation` board under the list titled `To Do`, which was created using the Wekan1 node.
|
||||
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Click on the gears icon next to the ***Board ID*** field and click on ***Add Expression***.
|
||||
3. Select the following in the ***Variable Selector*** section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan"].json["_id"]}}`.
|
||||
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 > Wekan1 > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan1"].json["_id"]}}`.
|
||||
6. Enter `Document Wekan node` in the ***Title*** field.
|
||||
7. Select 'Default' from the ***Swimlane ID*** dropdown list.
|
||||
8. Select an author from the ***Author ID*** dropdown list.
|
||||
9. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node creates a new card with the title `Document Wekan node` in the `To Do` list of the `Documentation` board.
|
||||
:::
|
||||
|
||||

|
||||
|
||||
::: v-pre
|
||||
### 6. Wekan4 node (update: card)
|
||||
|
||||
This node will update the list ID of the card created by the previous node and move it from the `To Do` list to the `Done` list.
|
||||
|
||||
1. Select the credentials that you entered in the previous node.
|
||||
2. Select 'Update' from the ***Operation*** dropdown list.
|
||||
3. Click on the gears icon next to the ***Board ID*** field and click on ***Add Expression***.
|
||||
4. Select the following in the ***Variable Selector*** section: Nodes > Wekan > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan"].json["_id"]}}`.
|
||||
5. Click on the gears icon next to the ***List ID*** field and click on ***Add Expression***.
|
||||
6. Select the following in the ***Variable Selector*** section: Nodes > Wekan1 > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan1"].json["_id"]}}`.
|
||||
7. Click on the gears icon next to the ***Card ID*** field and click on ***Add Expression***.
|
||||
8. Select the following in the ***Variable Selector*** section: Nodes > Wekan3 > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan3"].json["_id"]}}`.
|
||||
9. Click on the ***Add Field*** button and select 'List ID'.
|
||||
10. Click on the gears icon next to the ***List ID*** field and click on ***Add Expression***.
|
||||
11. Select the following in the ***Variable Selector*** section: Nodes > Wekan2 > Output Data > JSON > _id. You can also add the following expression: `{{$node["Wekan2"].json["_id"]}}`.
|
||||
12. Click on ***Execute Node*** to run the node.
|
||||
|
||||
In the screenshot below, you will notice that the node updates the list id of the card that we created in the previous node and moves it from the `To Do` list to the `Done` list.
|
||||
:::
|
||||
|
||||

|
||||
BIN
docs/nodes/nodes-library/nodes/Wekan/Wekan1_node.png
Normal file
|
After Width: | Height: | Size: 117 KiB |
BIN
docs/nodes/nodes-library/nodes/Wekan/Wekan2_node.png
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/nodes/nodes-library/nodes/Wekan/Wekan3_node.png
Normal file
|
After Width: | Height: | Size: 160 KiB |
BIN
docs/nodes/nodes-library/nodes/Wekan/Wekan4_node.png
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
docs/nodes/nodes-library/nodes/Wekan/Wekan_node.png
Normal file
|
After Width: | Height: | Size: 140 KiB |
BIN
docs/nodes/nodes-library/nodes/Wekan/workflow.png
Normal file
|
After Width: | Height: | Size: 139 KiB |
@ -1,5 +1,57 @@
|
||||
# Changelog
|
||||
|
||||
## n8n@0.90.0
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.89.2...n8n@0.90.0) for this version.<br />
|
||||
**Release date:** 2020-10-23
|
||||
|
||||
- Bug Fixes
|
||||
- Google Translate: Fixed an issue with the rendering of the image in n8n.io
|
||||
|
||||
## n8n@0.89.2
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.89.1...n8n@0.89.2) for this version.<br />
|
||||
**Release date:** 2020-10-22
|
||||
|
||||
- Bug Fixes
|
||||
- Strava Trigger: Fixed a typo in the node name
|
||||
|
||||
## n8n@0.89.1
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.89.0...n8n@0.89.1) for this version.<br />
|
||||
**Release date:** 2020-10-22
|
||||
|
||||
- Removed debug messages
|
||||
|
||||
## n8n@0.89.0
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.88.1...n8n@0.89.0) for this version.<br />
|
||||
**Release date:** 2020-10-22
|
||||
|
||||
- New Nodes
|
||||
- Pushover
|
||||
- Strava
|
||||
- Strava Trigger
|
||||
- Google Translate
|
||||
- Bug Fixes
|
||||
- HTTP Request: Fixed an issue with the POST request method for the 'File' response format
|
||||
- Fixed issue with displaying non-active workflows as active
|
||||
- Fixed an issue related to multiple-webhooks
|
||||
|
||||
## n8n@0.88.1
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.88.0...n8n@0.88.1) for this version.<br />
|
||||
**Release date:** 2020-10-16
|
||||
|
||||
- Bug Fixes
|
||||
- HTTP Request: Fixed an issue with the Form-Data Mutipart and the RAW/Custom Body Content Types
|
||||
|
||||
## n8n@0.88.0
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.87.2...n8n@0.88.0) for this version.<br />
|
||||
**Release date:** 2020-10-16
|
||||
|
||||
- Enhanced Fixes
|
||||
- Matrix: Added support for specifying a Matrix Homeserver URL
|
||||
- Salesforce: Added Custom Object resource and Custom Fields and Sort options
|
||||
- Bug Fixes
|
||||
- AWS SES: Fixed an issue with the Send Template operation for the Email resource
|
||||
- AWS SNS Trigger: Fixed an issue with the Subscriptions topic
|
||||
|
||||
## n8n@0.87.2
|
||||
For a comprehensive list of changes, check out the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.87.1...n8n@0.87.2) for this version.<br />
|
||||
**Release date:** 2020-10-15
|
||||
|
||||
@ -178,7 +178,7 @@ export NODE_FUNCTION_ALLOW_BUILTIN=crypto
|
||||
# Allows usage of only crypto and fs
|
||||
export NODE_FUNCTION_ALLOW_BUILTIN=crypto,fs
|
||||
|
||||
# Allow usage of external npm modules. Wildcard matching is not supported.
|
||||
# Allow usage of external npm modules.
|
||||
export NODE_FUNCTION_ALLOW_EXTERNAL=moment,lodash
|
||||
```
|
||||
|
||||
|
||||
@ -124,7 +124,7 @@ The expression would resolve to something similar to the following.
|
||||
```
|
||||
|
||||
|
||||
### 4. First and last days of the last month
|
||||
### 4. Get first and last days of the last month
|
||||
|
||||
Use the following snippet to get the first and last days of the last month.
|
||||
|
||||
@ -142,6 +142,7 @@ items[0].json.first_day_last_month = first_day_last_month;
|
||||
items[0].json.last_day_last_month = last_day_last_month;
|
||||
return items;
|
||||
```
|
||||
|
||||
The output will be similar to the following.
|
||||
|
||||
```js
|
||||
@ -176,3 +177,135 @@ The expression would resolve to something similar to the following.
|
||||
// Last day of the last month
|
||||
2020-09-30T22:00:00.000Z
|
||||
```
|
||||
|
||||
## Workflow Data
|
||||
|
||||
You can use the `$workflow` variable to get information about the current workflow in n8n. Please note that you'll have to save your workflow to obtain its name and ID.
|
||||
|
||||
### 1. Get workflow ID
|
||||
|
||||
#### Function node
|
||||
|
||||
```js
|
||||
const workflowId = $workflow.id;
|
||||
|
||||
items[0].json.workflowId = workflowId;
|
||||
return items;
|
||||
```
|
||||
|
||||
The output will be similar to the following.
|
||||
|
||||
```js
|
||||
[
|
||||
{
|
||||
"workflowId": "225"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
In case you haven't saved your workflow, this will be the output.
|
||||
|
||||
```js
|
||||
[
|
||||
{
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
#### Expression editor
|
||||
|
||||
```js
|
||||
{{$workflow.id}}
|
||||
```
|
||||
|
||||
The expression would resolve to something similar to the following.
|
||||
|
||||
```js
|
||||
225
|
||||
```
|
||||
|
||||
In case you haven't saved your workflow, this would resolve to something similar to the following.
|
||||
|
||||
```js
|
||||
[not found]
|
||||
```
|
||||
|
||||
### 2. Get workflow name
|
||||
|
||||
#### Function node
|
||||
|
||||
```js
|
||||
const workflowName = $workflow.name;
|
||||
|
||||
items[0].json.workflowName = workflowName;
|
||||
return items;
|
||||
```
|
||||
|
||||
The output will be similar to the following.
|
||||
|
||||
```js
|
||||
[
|
||||
{
|
||||
"workflowName": "A name for my workflow"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
In case you haven't saved your workflow, this will be the output.
|
||||
|
||||
```js
|
||||
[
|
||||
{
|
||||
"workflowName": ""
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
#### Expression editor
|
||||
|
||||
```js
|
||||
{{$workflow.name}}
|
||||
```
|
||||
|
||||
The expression would resolve to something similar to the following.
|
||||
|
||||
```js
|
||||
A name for my workflow
|
||||
```
|
||||
|
||||
In case you haven't saved your workflow, this wouldn't resolve to anything.
|
||||
|
||||
### 3. Get workflow status
|
||||
|
||||
`$workflow.active` returns a boolean value. You can convert it to a string by using the `toString()` method.
|
||||
|
||||
#### Function node
|
||||
|
||||
```js
|
||||
const isActive = $workflow.active;
|
||||
|
||||
items[0].json.isActive = isActive;
|
||||
return items;
|
||||
```
|
||||
|
||||
The output will be similar to the following.
|
||||
|
||||
```js
|
||||
[
|
||||
{
|
||||
"isActive": false
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
#### Expression editor
|
||||
|
||||
```js
|
||||
{{$workflow.active}}
|
||||
```
|
||||
|
||||
The expression would resolve to something similar to the following.
|
||||
|
||||
```js
|
||||
false
|
||||
```
|
||||
|
||||
@ -16,10 +16,19 @@ This can vary depending on the Linux distribution used. Example bellow is for Ub
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install apt-transport-https ca-certificates curl software-properties-common
|
||||
sudo apt install apt-transport-https ca-certificates curl software-properties-common -y
|
||||
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
|
||||
|
||||
# Depending on Version:
|
||||
|
||||
# Ubuntu 18.04:
|
||||
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"
|
||||
|
||||
# Ubuntu 20.04
|
||||
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable"
|
||||
|
||||
sudo apt update
|
||||
sudo apt upgrade -y
|
||||
sudo apt install docker-ce -y
|
||||
```
|
||||
|
||||
@ -40,7 +49,7 @@ Check before what version the latestand replace "1.24.1" with that version accor
|
||||
https://github.com/docker/compose/releases
|
||||
|
||||
```bash
|
||||
sudo curl -L https://github.com/docker/compose/releases/download/1.24.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
|
||||
sudo curl -L https://github.com/docker/compose/releases/download/1.27.4/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
```
|
||||
|
||||
|
||||