diff --git a/docs/nodes/credentials/Pushcut/README.md b/docs/nodes/credentials/Pushcut/README.md new file mode 100644 index 000000000..4bd876ac4 --- /dev/null +++ b/docs/nodes/credentials/Pushcut/README.md @@ -0,0 +1,24 @@ +--- +permalink: /credentials/pushcut +description: Learn to configure credentials for the Pushcut node in n8n +--- + +# Pushcut + +You can use these credentials to authenticate the following nodes with Pushcut. +- [Pushcut](../../nodes-library/nodes/Pushcut/README.md) +- [Pushcut Trigger](../../nodes-library/trigger-nodes/PushcutTrigger/README.md) + +## Prerequisites + +Download the [Pushcut](https://www.pushcut.io) app. + +## Using API Key + +1. Access the Pushcut application on your device. +2. Click on the ***Account*** button. +3. Click on the ***Add API Key*** under the ***INTEGRATIONS*** section. +4. Click on the ***Generate*** button. +5. Use the ***API Key*** with your Pushcut node credentials in n8n. + +![Getting Pushcut credentials](./using-api-key.gif) diff --git a/docs/nodes/credentials/Pushcut/using-api-key.gif b/docs/nodes/credentials/Pushcut/using-api-key.gif new file mode 100644 index 000000000..0d353750d Binary files /dev/null and b/docs/nodes/credentials/Pushcut/using-api-key.gif differ diff --git a/docs/nodes/nodes-library/nodes/Pushcut/Cron_node.png b/docs/nodes/nodes-library/nodes/Pushcut/Cron_node.png new file mode 100644 index 000000000..696421bd2 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Pushcut/Cron_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Pushcut/OpenWeatherMap_node.png b/docs/nodes/nodes-library/nodes/Pushcut/OpenWeatherMap_node.png new file mode 100644 index 000000000..47676fe08 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Pushcut/OpenWeatherMap_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Pushcut/Pushcut_node.png b/docs/nodes/nodes-library/nodes/Pushcut/Pushcut_node.png new file mode 100644 index 000000000..ad3afe0e4 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Pushcut/Pushcut_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Pushcut/README.md b/docs/nodes/nodes-library/nodes/Pushcut/README.md new file mode 100644 index 000000000..3a7c4d122 --- /dev/null +++ b/docs/nodes/nodes-library/nodes/Pushcut/README.md @@ -0,0 +1,76 @@ +--- +permalink: /nodes/n8n-nodes-base.pushcut +description: Learn how to use the Pushcut node in n8n +--- + +# Pushcut + +[Pushcut](https://pushcut.io) is an app for iOS that lets you create smart notifications to kick off shortcuts, URLs, and online automation. + +::: tip 🔑 Credentials +You can find authentication information for this node [here](../../../credentials/Pushcut/README.md). +::: + +## Basic Operations + +::: details Notification +- Send +::: + +## Example Usage + +This workflow allows you to send daily weather updates via a push notification using the Pushcut node. You can also find the [workflow](https://n8n.io/workflows/843) on n8n.io. This example usage workflow uses the following nodes. +- [Cron](../../core-nodes/Cron/README.md) +- [OpenWeatherMap](../../nodes/OpenWeatherMap/README.md) +- [Pushcut]() + +The final workflow should look like the following image. + +![A workflow with the Pushcut 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. Pushcut node (send: notification) + +This node will send a push notification with the weather update, which was sent by the previous node. + +1. First of all, you'll have to enter credentials for the Pushcut node. You can find out how to do that [here](../../../credentials/Pushcut/README.md). +2. Select a notification from the ***Notification Name*** dropdown list. +3. Click on ***Add Field*** and select 'Title' from the dropdown list. +4. Enter `Today's Weather Update` in the ***Title*** field. +5. Click on ***Add Field*** and select 'Text' from the dropdown list. +6. Click on the gears icon next to the ***Text*** field and click on ***Add Expression***. +::: v-pre +7. Enter the following message in the ***Expression*** field: `Hey! The temperature outside is {{$node["OpenWeatherMap"].json["main"]["temp"]}}°C.`. +8. Click on ***Execute Node*** to run the node. +::: + +In the screenshot below, you will notice that the node sends a push notification to your device with the weather update. + +![Using the Pushcut node to send weather updates via a push notification](./Pushcut_node.png) + +::: tip 💡 Activate workflow for production +This example workflow uses the Cron 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 as specified by the settings in the Cron node. +::: diff --git a/docs/nodes/nodes-library/nodes/Pushcut/workflow.png b/docs/nodes/nodes-library/nodes/Pushcut/workflow.png new file mode 100644 index 000000000..d45ed4b15 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Pushcut/workflow.png differ