-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(pushover): add basic documentation
- Loading branch information
Showing
6 changed files
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Pushover | ||
|
||
## URL Reference | ||
|
||
*pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]* | ||
|
||
## Getting the keys from Pushover | ||
|
||
At your [Pushover dashboard](https://pushover.net/) you can view your __`userKey`__ in the top right. | ||
![Screenshot 1](pushover/po-1.png) | ||
|
||
The `Name` column of the device list is what is used to refer to your devices (__`device1`__ etc.) | ||
![Screenshot 4](pushover/po-4.png) | ||
|
||
At the bottom of the same page there are links your _applications_, where you can find your __`apiToken`__ | ||
![Screenshot 2](pushover/po-2.png) | ||
|
||
The __`apiToken`__ is displayed at the top of the application page. | ||
![Screenshot 3](pushover/po-3.png) | ||
|
||
## Optional parameters | ||
|
||
You can optionally specify the __`title`__ and __`priority`__ parameters in the URL: | ||
*pushover://shoutrrr:__`token`__@__`userKey`__/?devices=__`device`__&title=Custom+Title&priority=1* | ||
|
||
__Note:__ Only supply priority values between -1 and 1, since 2 requires additional parameters that are not supported yet. | ||
|
||
Please refer to the [Pushover API documentation]() for more information. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.