github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_apprise_api (markdown)

master
Chris Caron 2021-10-14 20:26:04 -04:00
parent 8970ad2005
commit 54b7412247
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Notify_apprise_api.md

@ -1,13 +1,11 @@
## Apprise API Notifications
* **Source**: n/a
* **Source**: https://github.com/caronc/apprise-api
* **Icon Support**: No
* **Attachment Support**: yes
* **Message Format**: Text
* **Message Limit**: 32768 Characters per message
The idea is to allow users to use Apprise and hit an existing Apprise API server.
**Note:** this is a wee bit redundant because you can already use the CLI and point it's configuration to an existing Apprise API server (using the `--config` on the CLI or `AppriseConfig()` class via it's own internal API). The idea is to allow people who already use 3rd party websites that don't support the `--config` option to still be able to point back to their own self hosted Apprise API server if they wish to.
### Syntax
The syntax is as follows:
- `apprise://{host}/{token}`
@ -64,3 +62,13 @@ apprise -vv -t "Test Message Title" -b "Test Message Body" \
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"apprise://localhost:8080/path/apprise/?+X-Token=abcdefg&+X-Apprise=is%20great"
```
**Note:** this service is a little redundant because you can already use the CLI and point it's configuration to an existing Apprise API server (using the `--config` on the CLI or `AppriseConfig()` class via it's own internal API).
```bash
# A simple example of the Apprise CLI using a Config file instead:
# pulling down previously stored configuration
# Assuming our {hostname} is localhost
# Assuming our {port} is 8080
# Assuming our {token} is apprise
apprise --body="test message" --config=http://localhost:8080/get/apprise
```