diff --git a/docs/nodes/credentials/Gotify/README.md b/docs/nodes/credentials/Gotify/README.md new file mode 100644 index 000000000..ee01d0d11 --- /dev/null +++ b/docs/nodes/credentials/Gotify/README.md @@ -0,0 +1,31 @@ +--- +permalink: /credentials/gotify +description: Learn to configure credentials for the Gotify node in n8n +--- + +# Gotify + +You can use these credentials to authenticate the following nodes with Gotify. +- [Gotify](../../nodes-library/nodes/Gotify/README.md) + +## Prerequisites + +Install [Gotify](https://gotify.net/docs/install) on your server. + +## Using API Token + +***Note:*** To create a message, the App API Token is required. To delete or retrieve all messages, you need the Client API Token. + +1. Access your Gotify dashboard. +2. Click on ***APPS*** in the navigation menu. +3. Click on the ***CREATE APPLICATION*** button. +4. Enter an application name in the ***Name*** field. +5. Click on the ***CREATE*** button. +6. Click on ***CLIENTS*** in the navigation menu. +7. Click on the ***CREATE CLIENT*** button. +8. Enter a name for the client in the ***Name*** field. +9. Click on the ***CREATE*** button. +10. Use this app token, client token, and the host URL with your Gotify API credentials in n8n. +11. Click the ***Save*** button to save your credentials in n8n. + +![Getting Gotify credentials](./using-api.gif) diff --git a/docs/nodes/credentials/Gotify/using-api.gif b/docs/nodes/credentials/Gotify/using-api.gif new file mode 100644 index 000000000..4d495504b Binary files /dev/null and b/docs/nodes/credentials/Gotify/using-api.gif differ diff --git a/docs/nodes/nodes-library/nodes/Gotify/Cron_node.png b/docs/nodes/nodes-library/nodes/Gotify/Cron_node.png new file mode 100644 index 000000000..95a352415 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Gotify/Cron_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Gotify/Gotify_node.png b/docs/nodes/nodes-library/nodes/Gotify/Gotify_node.png new file mode 100644 index 000000000..8feba67e0 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Gotify/Gotify_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Gotify/OpenWeatherMap_node.png b/docs/nodes/nodes-library/nodes/Gotify/OpenWeatherMap_node.png new file mode 100644 index 000000000..a5b71c880 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Gotify/OpenWeatherMap_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Gotify/README.md b/docs/nodes/nodes-library/nodes/Gotify/README.md new file mode 100644 index 000000000..7b81efc4f --- /dev/null +++ b/docs/nodes/nodes-library/nodes/Gotify/README.md @@ -0,0 +1,72 @@ +--- +permalink: /nodes/n8n-nodes-base.gotify +description: Learn how to use the Gotify node in n8n +--- + +# Gotify + +[Gotify](https://gotify.net/) is a server for sending and receiving messages. + +::: tip 🔑 Credentials +You can find authentication information for this node [here](../../../credentials/Gotify/README.md). +::: + +## Basic Operations + +::: details Message +- Create +- Delete +- Get All +::: + +## Example Usage + +This workflow allows you to send daily weather updates via a message using the Gotify node. You can also find the [workflow](https://n8n.io/workflows/774) on n8n.io. This example usage workflow uses the following nodes. +- [Cron](../../core-nodes/Cron/README.md) +- [OpenWeatherMap](../../nodes/OpenWeatherMap/README.md) +- [Gotify]() + +The final workflow should look like the following image. + +![A workflow with the Gotify node](./workflow.png) + +### 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. + +![Using the Cron node to trigger the workflow daily at 9 am](./Cron_node.png) + +### 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. + +![Using the OpenWeatherMap node to get weather updates for Berlin](./OpenWeatherMap_node.png) + +### 3. Gotify node (create: message) + +This node will send a message with the weather update. + +1. First of all, you'll have to enter credentials for the Gotify node. You can find out how to do that [here](../../../credentials/Gotify/README.md). +2. Click on the gears icon next to the ***Message*** field and click on ***Add Expression***. +::: v-pre +3. Enter the following message in the ***Expression*** field: `Hey! The temperature outside is {{$node["OpenWeatherMap"].json["main"]["temp"]}}°C.`. +4. Click on ***Add Field*** and select 'Title' from the dropdown list. +5. Enter `Today's Weather Update` in the ***Title*** field. +6. Click on ***Execute Node*** to run the node. +::: + +In the screenshot below, you will notice that the node sends a message with the weather update. + +![Using the Gotify node to send weather updates via a message](./Gotify_node.png) diff --git a/docs/nodes/nodes-library/nodes/Gotify/workflow.png b/docs/nodes/nodes-library/nodes/Gotify/workflow.png new file mode 100644 index 000000000..a35cdf1ba Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Gotify/workflow.png differ