extern/apprise-api
1
0
Fork 0
mirror of https://github.com/caronc/apprise-api.git synced 2024-12-13 18:31:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improved README.md documentation

Browse Source
This commit is contained in:
Chris Caron 2024-02-17 21:36:58 -05:00
parent 16be9da9d4
commit 7814f5fe12
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -168,6 +168,13 @@ curl -X POST -d 'urls=mailto://user:pass@gmail.com' \
curl -X POST -d '{"urls": "mailto://user:pass@gmail.com", "body":"test message"}' \ curl -X POST -d '{"urls": "mailto://user:pass@gmail.com", "body":"test message"}' \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
http://localhost:8000/notify http://localhost:8000/notify
# attach= is an alias of attachment=
# Send a notification with a URL based attachment
curl -X POST \
-F 'urls=mailto://user:pass@gmail.com' \
-F attach=attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png \
http://localhost:8000/notify
``` ```
You can also send notifications that are URLs. Apprise will download the item so that it can send it along to all end points that should be notified about it. You can also send notifications that are URLs. Apprise will download the item so that it can send it along to all end points that should be notified about it.
@ -252,6 +259,13 @@ curl -X POST \
-F attach1=@Screenshot-1.png \ -F attach1=@Screenshot-1.png \
-F attach2=@/my/path/to/Apprise.doc \ -F attach2=@/my/path/to/Apprise.doc \
http://localhost:8000/notify/abc123 http://localhost:8000/notify/abc123
# attach= is an alias of attachment=
# Send a notification with a URL based attachment
curl -X POST \
-F 'urls=mailto://user:pass@gmail.com' \
-F attach=attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png \
http://localhost:8000/notify/abc123
``` ```
🏷️ You can also leverage *tagging* which allows you to associate one or more tags with your Apprise URLs. By doing this, notifications only need to be referred to by their easy to remember notify tag name such as `devops`, `admin`, `family`, etc. You can very easily group more than one notification service under the same *tag* allowing you to notify a group of services at once. This is accomplished through configuration files ([documented here](https://github.com/caronc/apprise/wiki/config)) that can be saved to the persistent storage previously associated with a `{KEY}`. 🏷️ You can also leverage *tagging* which allows you to associate one or more tags with your Apprise URLs. By doing this, notifications only need to be referred to by their easy to remember notify tag name such as `devops`, `admin`, `family`, etc. You can very easily group more than one notification service under the same *tag* allowing you to notify a group of services at once. This is accomplished through configuration files ([documented here](https://github.com/caronc/apprise/wiki/config)) that can be saved to the persistent storage previously associated with a `{KEY}`.