Config ID a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
Getting Started
  1. Verify your Apprise API Status:

  2. The following is your Apprise Configuration ID: 

    a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
    For some examples on how to build a development environment around this: click here.

  3. In the future you can return to this configuration screen at any time by placing the following into your browser: 
    https://apprise.the-endroad.com/cfg/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
  4. 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).
  5. Use the web Review section to review what was parsed/detected from your defined configuration.
  6. 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.the-endroad.com/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f/?tags=all
Send one or more attachments like this: 
apprise --body="Test Message" \

                   apprises://apprise.the-endroad.com/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f/?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.the-endroad.com/cfg/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
You may also create an Apprise configuration file that contains this line somewhere in it: 
include https://apprise.the-endroad.com/cfg/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
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.the-endroad.com/notify/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
When sending attachments, 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.the-endroad.com/notify/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
When sending more than one attachment, you must uniquely assign each attachment to a new ID. The example below leverages 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.the-endroad.com/notify/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
Sends a notification to our endpoints with an attachment and no body specified: 
curl -X POST \

                   -F "tag=all" \ 

                   -F "attach=https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png" \ 

                   https://apprise.the-endroad.com/notify/a3aedeb86af3331edc42e7a13b31256f3c2354add4435cef2083bf25e36f755f
Configuration

Define your configuration below:

Apprise URL Builder build

Once you have successfully loaded at least one Apprise URL on the settings Configuration section, your loaded entries will display here.

Loaded Configuration

0 notification(s) selected for sending

  • 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.
Clear Form restore_page