The Apprise API
Apprise allows you to send a notification to almost all of the most popular notification services available to us today such as: Telegram, Discord, Slack, Amazon SNS, Gotify, etc. This API provides a simple gateway to directly access it via an HTTP interface.
- chevron_rightThis project was designed to be incredibly light weight.
- chevron_rightConfiguration can be persistently stored for retrieval.
Stateless Endpoints
Those who wish to treat this API as nothing but a sidecar and/or microservice to their project only need to use the following URL.
URL | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
/notify/ |
Used to notify one one or more specified Apprise URLs. See the Apprise Wiki if you need help
constructing your URL(s).
|
Persistent Store Endpoints
Those wishing to use the persistent store may do so. This section is a set it and forget it type deal. Set your configuration once and just trigger notifications later on demand with light-weight API calls.
All endpoints that expect posted data can be received in either JSON or in it's standard
encoding.
You must pass along the Content-Type
as application/json
in order for it to be
interpreted
properly.
URL | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
/add/ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a |
Used to add a new Apprise configuration or a set of URLs and associates them with configuration
identified with the id of ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a. See the Apprise Wiki if you need help
constructing your URLs.
|
||||||||||
/del/ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a |
There are no arguments required. If configuration id of ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a exists and has data associated with
it, it will be removed.
|
||||||||||
/get/ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a |
This feature can be used by Apprise itself. It provides a means of remotely fetching it's
the configuration associated with the configuration identified through the id of ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a.
|
||||||||||
/notify/ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a |
Notifies the URLs associated with configuration identified by the id of ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a.
|
Endpoint Notes
The Configuration ID (ef89f9b7b4432197a39bb3c90903c96d46953ce0da8a3282a3ddca4155b2a23a) you plan to associate your configuration with:
- Can not have spaces and/or special characters in it. Both a dash (
-
) and underscore (_
) are the only exceptions to this rule. - Must start with at least 2 alpha/numeric characters.
- Can not exceed 64 characters in total length.