extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 22:11:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_simplepush (markdown)

Chris Caron 2019-09-07 18:32:49 -04:00
parent bab2fcbbd6
commit 818d0fcdfd
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Notify_simplepush.md

@ -6,17 +6,20 @@
SimplePush is a pretty straight forward messaging system you can get for your Android Device through their App [here](https://play.google.com/store/apps/details?id=io.tymm.simplepush).
You can optionally add additional notification encryption in the settings where it provides you with a **{salt}** value and allows you to configure/set your own encryption **{password}**.
### Syntax
Valid authentication syntaxes are as follows:
* **spush**://**{apikey}**/
* `spush://{apikey}/`
* `spush://{salt}:{password}@{apikey}/`
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| apikey | Yes | This is required for your account to work. You will be provided one from your SimplePush account.
| event | No | Optionally specify an event on the URL.
| encrypt | No | SimplePush offers a method of encrypting the message and title during transmission. The messages are already transmitted on a secure https:// connection therefore this overhead has been made optional. It is disabled by default.
| salt | No | Should you choose to encrypt your connection (by setting **encrypt=Yes**), you can also specify your own `salt` which is used to encrypt your message. If a `salt` isn't specified then a default value of `4B5AA3109F438E02` is used instead.
| password | No | SimplePush offers a method of further encrypting the message and title during transmission (on top of the secure channel it's already sent on). This is the Encryption password set. You must provide the `salt` value with the `ppassword` in order to work.
| salt | No | The salt is provided to you by SimplePush and is the second part of the additional encryption you can use with this service. You must provide a `password` with the `salt` value in order to work.
#### Example
Send a SimplePush notification: