diff --git a/Notify_apprise_api.md b/Notify_apprise_api.md index 842937a..a84a1de 100644 --- a/Notify_apprise_api.md +++ b/Notify_apprise_api.md @@ -1,12 +1,10 @@ ## 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. +The idea is to allow users to use Apprise and hit an existing Apprise API server. ### Syntax The syntax is as follows: @@ -63,4 +61,14 @@ apprise -vv -t "Test Message Title" -b "Test Message Body" \ # in the event we're hosting our Apprise API here instead 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 ``` \ No newline at end of file