Apprise Logo

Apprise API

Management for Config ID: cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff

Getting Started
  1. Verify your Apprise API Status: click here
  2. Here is where you can store your Apprise configuration associated with the key: cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff 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.au.yeesey.com/cfg/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff
  4. 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).
  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.
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.au.yeesey.com/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff/?tags=all
Send one or more attachments like this: 
apprise --body="Test Message" \

          apprises://apprise.au.yeesey.com/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff/?tags=all \

          --attach=/path/to/an/attachment.jpeg \ 

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

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.au.yeesey.com/get/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff
You may also create an Apprise configuration file that contains this line somewhere in it: 
include https://apprise.au.yeesey.com/get/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff
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.au.yeesey.com/notify/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff
Send one or more attachments like this: 
curl -X POST \

              -F "tags=all" \

              -F "body=Test Message" \

              -F attach1=@Screenshot-1.png \

              -F attach2=@/my/path/to/Apprise.doc \

              https://apprise.au.yeesey.com/notify/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff
Sends a notification to our endpoints with an attachment 

      curl -X POST \

          -F "tag=all" \ 

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

          "https://apprise.au.yeesey.com/notify/cf8f5639432cbafedefbf443622d9e9324af50f0b099159f1a8b9fc8b38e74ff"

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: