Config ID:
Send one or more attachments like this:
You may also create an Apprise configuration file that contains this line somewhere in it:
When sending attachments,
When sending more than one attachment, you must uniquely assign each attachment to a new ID. The example below leverages
Sends a notification to our endpoints with an attachment and no body specified:
86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
Getting Started
- Verify your Apprise API Status: autorenew
-
The following is your Apprise Configuration ID:
For some examples on how to build a development environment around this: click here.86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf -
In the future you can return to this configuration screen at any time by placing the following into your browser:
https://apprise.whalrus.dev/cfg/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf -
Use the settings Configuration section to prepare and save your Apprise configuration.lightbulb_outlineYou can always refer to the Apprise Wiki 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.whalrus.dev/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf/?tags=all
apprise --body="Test Message" \
apprises://apprise.whalrus.dev/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf/?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.whalrus.dev/cfg/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
include https://apprise.whalrus.dev/cfg/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
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.whalrus.dev/notify/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
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.whalrus.dev/notify/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
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.whalrus.dev/notify/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
curl -X POST \
-F "tag=all" \
-F "attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png" \
https://apprise.whalrus.dev/notify/86b8530c70326453c087f797f53adb975795fbdb768db1cf23ca2f67dabefdbf
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
Tip: Click on a tag (🏷️) to pre-select it in the announcementNotifications section.
You can send a notification using the loaded configuration:
APPRISE LIBRARY v1.9.6