Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pushover node documentation #239

Merged
merged 1 commit into from Oct 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/nodes/credentials/Pushover/README.md
@@ -0,0 +1,24 @@
---
permalink: /credentials/pushover
description: Learn to configure credentials for the Pushover node in n8n
---

# Pushover

You can use these credentials to authenticate the following nodes with Pushover.
- [Pushover](../../nodes-library/nodes/Pushover/README.md)

## Prerequisites

Create a [Pushover](https://pushover.net) account.

## Using API Key

1. Access the [Pushover dashboard](https://pushover.net/).
2. Scroll down to the bottom and click on ***Create an Application/API Token***.
3. Enter the name of your application in the ***Name*** field.
4. Read the 'Terms of Services' and the 'Guide to Being Friendly to our API' and if you agree to them check the checkbox.
5. Click on the ***Create Application*** button.
6. Use this ***API Key*** with your Pushover node credentials in n8n.

![Getting Pushover credentials](./using-api-key.gif)
Binary file added docs/nodes/credentials/Pushover/using-api-key.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 72 additions & 0 deletions docs/nodes/nodes-library/nodes/Pushover/README.md
@@ -0,0 +1,72 @@
---
permalink: /nodes/n8n-nodes-base.pushover
description: Learn how to use the Pushover node in n8n
---

# Pushover

[Pushover](https://www.pushover.net/) is a simple push notification service that integrates easily into web apps, network monitors, shell scripts, servers, and anything else that needs to send alerts to your Android, iPhone, iPad, and Desktop.

::: tip 🔑 Credentials
You can find authentication information for this node [here](../../../credentials/Pushover/README.md).
:::

## Basic Operations

::: details Message
- Push
:::

## Example Usage

This workflow allows you to send daily weather updates via a push notification using the Pushover node. You can also find the [workflow](https://n8n.io/workflows/740) on n8n.io. This example usage workflow uses the following nodes.
- [Cron](../../core-nodes/Cron/README.md)
- [OpenWeatherMap](../../nodes/OpenWeatherMap/README.md)
- [Pushover]()

The final workflow should look like the following image.

![A workflow with the Pushover 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. Pushover node (push: message)

This node will send a notification with the weather update, which was sent by the previous node.

1. First of all, you'll have to enter credentials for the Pushover node. You can find out how to do that [here](../../../credentials/Pushover/README.md).
2. Enter a user key in the ***User Key*** field. You can find your user key from the [Pushover Dashboard](https://www.pushover.net/).
3. 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. Select 'Normal Priority' from the ***Priority*** dropdown list. This will trigger sound, vibration, and display an alert according to the user's device settings.
7. Click on ***Add Field*** and select 'Title' from the dropdown list.
8. Enter `Today's Weather` in the ***Title*** field.
9. Click on ***Execute Node*** to run the node.
:::

In the screenshot below, you will notice that the node sends a notification to a device with the weather update, which was sent by the previous node.

![Using the Pushover node to send weather updates via SMS](./Pushover_node.png)
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.