Getting Started
- Verify your Apprise API Status:
-
The following is your Apprise Configuration ID:
For some examples on how to build a development environment around this: click here.5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd -
In the future you can return to this configuration screen at any time by placing the following into your browser:
https://apprise-api.sargas.freemyip.com/cfg/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd -
Use the settings Configuration section to prepare and save your Apprise configuration.lightbulb_outlineYou can always refer to the build Apprise URL Builder if you're having troubles assembling your URL(s).
- Use the web Review section to review what was parsed/detected from your defined configuration.
-
Use the announcement Notifications section to test out your saved configuration.lightbulb_outline: The number also provided in the announcement Notifications tab identifies how many notifications will be sent (based on tags/configuration provided) when using this section.
Working Remotely With Your Configuration
Using The Apprise CLI
The following command would cause apprise to directly notify all of your services:
apprise --body="Test Message" \
apprises://apprise-api.sargas.freemyip.com/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd/?tags=all
apprise --body="Test Message" \
apprises://apprise-api.sargas.freemyip.com/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd/?tags=all \
--attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png
--attach=/path/to/an/attachment.jpeg
The following command would cause apprise to retrieve the configuration loaded and send a test notification to all of your added services:
apprise --body="Test Message" --tag=all \
--config=https://apprise-api.sargas.freemyip.com/cfg/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd
include https://apprise-api.sargas.freemyip.com/cfg/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd
By leveraging the include directive, it will automatically be referenced for future calls to the apprise tool. All future calls using Apprise now simplify to:
apprise --body="Test Message" --tag=all
Using CURL
The following command would cause the Apprise API to notify all of your services:
curl -X POST \
-F "body=Test Message" \
-F "tags=all" \
https://apprise-api.sargas.freemyip.com/notify/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd
curl requires all local files be prefixed with @. You can an add attachment like this:
curl -X POST \
-F "tags=all" \
-F "body=Test Message" \
-F attach=@Screenshot-1.png \
https://apprise-api.sargas.freemyip.com/notify/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd
attach1 and attach2:
curl -X POST \
-F "tags=all" \
-F "body=Test Message" \
-F attach1=@Screenshot-1.png \
-F attach2=@/my/path/to/Apprise.doc \
https://apprise-api.sargas.freemyip.com/notify/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd
curl -X POST \
-F "tag=all" \
-F "attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png" \
https://apprise-api.sargas.freemyip.com/notify/5664966737b5dca78face25f4c3989b5afe373112306bbf70a5bdf418accebdd
Configuration
Define your configuration below:
info
Once you have successfully loaded at least one Apprise URL on the settings Configuration section, your loaded entries will display here.
Loaded Configuration
- Review the parsed destinations below before sending.
- Select a tag (🏷️) on any entry to include it in announcement Notifications.
- Use send to run a quick test and inspect the full debug output for that entry.
- Need more destinations? Add or update them in settings Configuration.
Notifications
You can send a notification using the loaded configuration:
No Notification Targets Selected
Choose one or more tags from the Tags dropdown, select target entries from the web Review section, or add more entries in the settings Configuration section.