Apprise
Apprise - Push Notifications that work with just about every platform!
Under MIT License
By caronc
Apprise - Push Notifications that work with just about every platform!
Under MIT License
By caronc
ap·prise / verb
To inform or tell (someone). To make one aware of something.
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.
Developers who wish to provide a notification service no longer need to research each and every one out there. They no longer need to try to adapt to the new ones that comeout thereafter. They just need to include this one library and then they can immediately gain access to almost all of the notifications services available to us today.
System Administrators and DevOps who wish to send a notification now no longer need to find the right tool for the job. Everything is already wrapped and supported within the apprise command line tool (CLI) that ships with this product.
The section identifies all of the services supported by this library. Check out the wiki for more information on the supported modules here.
The table below identifies the services this tool supports and some example service urls you need to use in order to take advantage of it. Click on any of the services listed below to get more details on how you can configure Apprise to access them.
| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| Boxcar | boxcar:// | (TCP) 443 | boxcar://hostnameboxcar://hostname/@tagboxcar://hostname/device_tokenboxcar://hostname/device_token1/device_token2/device_tokenNboxcar://hostname/@tag/@tag2/device_token
| Discord | discord:// | (TCP) 443 | discord://webhook_id/webhook_tokendiscord://[email protected]_id/webhook_token
| Emby | emby:// or embys:// | (TCP) 8096 | emby://[email protected]/emby://user:[email protected]
| Enigma2 | enigma2:// or enigma2s:// | (TCP) 80 or 443 | enigma2://hostname
| Faast | faast:// | (TCP) 443 | faast://authorizationtoken
| FCM | fcm:// | (TCP) 443 | fcm://[email protected]/DEVICE_IDfcm://[email protected]/#TOPICfcm://[email protected]/DEVICE_ID1/#topic1/#topic2/DEVICE_ID2/
| Flock | flock:// | (TCP) 443 | flock://tokenflock://[email protected]://app_token/u:useridflock://app_token/g:channel_idflock://app_token/u:userid/g:channel_id
| Gitter | gitter:// | (TCP) 443 | gitter://token/roomgitter://token/room1/room2/roomN
| Google Chat | gchat:// | (TCP) 443 | gchat://workspace/key/token
| Gotify | gotify:// or gotifys:// | (TCP) 80 or 443 | gotify://hostname/tokengotifys://hostname/token?priority=high
| Growl | growl:// | (UDP) 23053 | growl://hostnamegrowl://hostname:portnogrowl://[email protected]://[email protected]:portNote: you can also use the get parameter version which can allow the growl request to behave using the older v1.x protocol. An example would look like: growl://hostname?version=1
| Home Assistant | hassio:// or hassios:// | (TCP) 8123 or 443 | hassio://hostname/accesstokenhassio://[email protected]/accesstokenhassio://user:[email protected]:port/accesstokenhassio://hostname/optional/path/accesstoken
| IFTTT | ifttt:// | (TCP) 443 | ifttt://webhooksID/Eventifttt://webhooksID/Event1/Event2/EventNifttt://webhooksID/Event1/?+Key=Valueifttt://webhooksID/Event1/?-Key=value1
| Join | join:// | (TCP) 443 | join://apikey/devicejoin://apikey/device1/device2/deviceN/join://apikey/groupjoin://apikey/groupA/groupB/groupNjoin://apikey/DeviceA/groupA/groupN/DeviceN/
| KODI | kodi:// or kodis:// | (TCP) 8080 or 443 | kodi://hostnamekodi://[email protected]://user:[email protected]:port
| Kumulos | kumulos:// | (TCP) 443 | kumulos://apikey/serverkey
| LaMetric Time | lametric:// | (TCP) 443 | lametric://[email protected]_ipaddrlametric://[email protected]:portlametric://[email protected]_secret
| Mailgun | mailgun:// | (TCP) 443 | mailgun://[email protected]/apikeymailgun://[email protected]/apikey/emailmailgun://[email protected]/apikey/email1/email2/emailNmailgun://[email protected]/apikey/?name="From%20User"
| Matrix | matrix:// or matrixs:// | (TCP) 80 or 443 | matrix://hostnamematrix://[email protected]://user:[email protected]:port/#room_aliasmatrixs://user:[email protected]:port/!room_idmatrixs://user:[email protected]:port/#room_alias/!room_id/#room2matrixs://[email protected]:port/?webhook=matrixmatrix://user:[email protected]/?webhook=slack&format=markdown
| Mattermost | mmost:// or mmosts:// | (TCP) 8065 | mmost://hostname/authkeymmost://hostname:80/authkeymmost://[email protected]:80/authkeymmost://hostname/authkey?channel=channelmmosts://hostname/authkeymmosts://[email protected]/authkey
| Microsoft Teams | msteams:// | (TCP) 443 | msteams://TokenA/TokenB/TokenC/
| MQTT | mqtt:// or mqtts:// | (TCP) 1883 or 8883 | mqtt://hostname/topicmqtt://[email protected]/topicmqtts://user:[email protected]:9883/topic
| Nextcloud | ncloud:// or nclouds:// | (TCP) 80 or 443 | ncloud://adminuser:[email protected]/Usernclouds://adminuser:[email protected]/User1/User2/UserN
| Notica | notica:// | (TCP) 443 | notica://Token/
| Notifico | notifico:// | (TCP) 443 | notifico://ProjectID/MessageHook/
| Office 365 | o365:// | (TCP) 443 | o365://TenantID:AccountEmail/ClientID/ClientSecreto365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmailo365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail1/TargetEmail2/TargetEmailN
| OneSignal | onesignal:// | (TCP) 443 | onesignal://[email protected]/PlayerIDonesignal://TemplateID:[email protected]/UserIDonesignal://[email protected]/#IncludeSegmentonesignal://[email protected]/Email
| Opsgenie | opsgenie:// | (TCP) 443 | opsgenie://APIKeyopsgenie://APIKey/UserIDopsgenie://APIKey/#Teamopsgenie://APIKey/*Scheduleopsgenie://APIKey/^Escalation
| ParsePlatform | parsep:// or parseps:// | (TCP) 80 or 443 | parsep://AppID:[email protected]://AppID:[email protected]
| PopcornNotify | popcorn:// | (TCP) 443 | popcorn://ApiKey/ToPhoneNopopcorn://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/popcorn://ApiKey/ToEmailpopcorn://ApiKey/ToEmail1/ToEmail2/ToEmailN/popcorn://ApiKey/ToPhoneNo1/ToEmail1/ToPhoneNoN/ToEmailN
| Prowl | prowl:// | (TCP) 443 | prowl://apikeyprowl://apikey/providerkey
| PushBullet | pbul:// | (TCP) 443 | pbul://accesstokenpbul://accesstoken/#channelpbul://accesstoken/A_DEVICE_IDpbul://accesstoken/[email protected]://accesstoken/#channel/#channel2/[email protected]/DEVICE
| Pushjet | pjet:// or pjets:// | (TCP) 80 or 443 | pjet://hostname/secretpjet://hostname:port/secretpjets://[email protected]/secretpjets://hostname:port/secret
| Push (Techulus) | push:// | (TCP) 443 | push://apikey/
| Pushed | pushed:// | (TCP) 443 | pushed://appkey/appsecret/pushed://appkey/appsecret/#ChannelAliaspushed://appkey/appsecret/#ChannelAlias1/#ChannelAlias2/#ChannelAliasNpushed://appkey/appsecret/@UserPushedIDpushed://appkey/appsecret/@UserPushedID1/@UserPushedID2/@UserPushedIDN
| Pushover | pover:// | (TCP) 443 | pover://[email protected]://[email protected]/DEVICEpover://[email protected]/DEVICE1/DEVICE2/DEVICENNote: you must specify both your user_id and token
| PushSafer | psafer:// or psafers:// | (TCP) 80 or 443 | psafer://privatekeypsafers://privatekey/DEVICEpsafer://privatekey/DEVICE1/DEVICE2/DEVICEN
| Reddit | reddit:// | (TCP) 443 | reddit://user:[email protected]_id/app_secret/subredditreddit://user:[email protected]_id/app_secret/sub1/sub2/subN
| Rocket.Chat | rocket:// or rockets:// | (TCP) 80 or 443 | rocket://user:[email protected]/RoomID/Channelrockets://user:[email protected]:443/#Channel1/#Channel1/RoomIDrocket://user:[email protected]/#Channelrocket://[email protected]://[email protected]/@User/#Channel
| Ryver | ryver:// | (TCP) 443 | ryver://Organization/Tokenryver://[email protected]/Token
| SendGrid | sendgrid:// | (TCP) 443 | sendgrid://APIToken:FromEmail/sendgrid://APIToken:FromEmail/ToEmailsendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
| SimplePush | spush:// | (TCP) 443 | spush://apikeyspush://salt:[email protected]://apikey?event=Apprise
| Slack | slack:// | (TCP) 443 | slack://TokenA/TokenB/TokenC/slack://TokenA/TokenB/TokenC/Channelslack://[email protected]/TokenB/TokenC/Channelslack://[email protected]/TokenB/TokenC/Channel1/Channel2/ChannelN
| SMTP2Go | smtp2go:// | (TCP) 443 | smtp2go://[email protected]/apikeysmtp2go://[email protected]/apikey/emailsmtp2go://[email protected]/apikey/email1/email2/emailNsmtp2go://[email protected]/apikey/?name="From%20User"
| Streamlabs | strmlabs:// | (TCP) 443 | strmlabs://AccessToken/strmlabs://AccessToken/?name=name&identifier=identifier&amount=0¤cy=USD
| SparkPost | sparkpost:// | (TCP) 443 | sparkpost://[email protected]/apikeysparkpost://[email protected]/apikey/emailsparkpost://[email protected]/apikey/email1/email2/emailNsparkpost://[email protected]/apikey/?name="From%20User"
| Spontit | spontit:// | (TCP) 443 | spontit://[email protected]/spontit://[email protected]/Channelspontit://[email protected]/Channel1/Channel2/ChannelN
| Syslog | syslog:// | (UDP) 514 (if hostname specified) | syslog://syslog://Facilitysyslog://hostnamesyslog://hostname/Facility
| Telegram | tgram:// | (TCP) 443 | tgram://bottoken/ChatIDtgram://bottoken/ChatID1/ChatID2/ChatIDN
| Twitter | twitter:// | (TCP) 443 | twitter://CKey/CSecret/AKey/ASecrettwitter://[email protected]/CSecret/AKey/ASecrettwitter://CKey/CSecret/AKey/ASecret/User1/User2/User2twitter://CKey/CSecret/AKey/ASecret?mode=tweet
| Twist | twist:// | (TCP) 443 | twist://pasword:logintwist://password:login/#channeltwist://password:login/#team:channeltwist://password:login/#team:channel1/channel2/#team3:channel
| XBMC | xbmc:// or xbmcs:// | (TCP) 8080 or 443 | xbmc://hostnamexbmc://[email protected]://user:[email protected]:port
| XMPP | xmpp:// or xmpps:// | (TCP) 5222 or 5223 | xmpp://[email protected]://user:[email protected]://user:[email protected]:[email protected]/resourcexmpps://[email protected]/[email protected], [email protected]/resource
| Webex Teams (Cisco) | wxteams:// | (TCP) 443 | wxteams://Token
| Zulip Chat | zulip:// | (TCP) 443 | zulip://[email protected]/Tokenzulip://[email protected]/Token/Streamzulip://[email protected]/Token/Email
| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| AWS SNS | sns:// | (TCP) 443 | sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNosns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo1/+PhoneNo2/+PhoneNoNsns://AccessKeyID/AccessSecretKey/RegionName/Topicsns://AccessKeyID/AccessSecretKey/RegionName/Topic1/Topic2/TopicN
| ClickSend | clicksend:// | (TCP) 443 | clicksend://user:[email protected]://user:[email protected]/ToPhoneNo2/ToPhoneNoN
| D7 Networks | d7sms:// | (TCP) 443 | d7sms://user:[email protected]://user:[email protected]/ToPhoneNo2/ToPhoneNoN
| DingTalk | dingtalk:// | (TCP) 443 | dingtalk://token/dingtalk://token/ToPhoneNodingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/
| Kavenegar | kavenegar:// | (TCP) 443 | kavenegar://ApiKey/ToPhoneNokavenegar://[email protected]/ToPhoneNokavenegar://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| MessageBird | msgbird:// | (TCP) 443 | msgbird://ApiKey/FromPhoneNomsgbird://ApiKey/FromPhoneNo/ToPhoneNomsgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| MSG91 | msg91:// | (TCP) 443 | msg91://AuthKey/ToPhoneNomsg91://[email protected]/ToPhoneNomsg91://AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Nexmo | nexmo:// | (TCP) 443 | nexmo://ApiKey:[email protected]://ApiKey:[email protected]/ToPhoneNonexmo://ApiKey:[email protected]/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Sinch | sinch:// | (TCP) 443 | sinch://ServicePlanId:[email protected]://ServicePlanId:[email protected]/ToPhoneNosinch://ServicePlanId:[email protected]/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/sinch://ServicePlanId:[email protected]/ToPhoneNosinch://ServicePlanId:[email protected]/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Twilio | twilio:// | (TCP) 443 | twilio://AccountSid:[email protected]://AccountSid:[email protected]/ToPhoneNotwilio://AccountSid:[email protected]/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/twilio://AccountSid:[email protected]/ToPhoneNo?apikey=Keytwilio://AccountSid:[email protected]/ToPhoneNotwilio://AccountSid:[email protected]/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| Linux DBus Notifications | dbus://qt://glib://kde:// | n/a | dbus://qt://glib://kde://
| Linux Gnome Notifications | gnome:// | n/a | gnome://
| MacOS X Notifications | macosx:// | n/a | macosx://
| Windows Notifications | windows:// | n/a | windows://
| Service ID | Default Port | Example Syntax |
| ---------- | ------------ | -------------- |
| mailto:// | (TCP) 25 | mailto://userid:[email protected]://domain.com?user=userid&pass=passwordmailto://domain.com:2525?user=userid&pass=passwordmailto://[email protected]&pass=passwordmailto://mySendingUsername:[email protected][email protected]://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply
| mailtos:// | (TCP) 587 | mailtos://userid:[email protected]://domain.com?user=userid&pass=passwordmailtos://domain.com:465?user=userid&pass=passwordmailtos://[email protected]&pass=passwordmailtos://mySendingUsername:[email protected][email protected]://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply
Apprise have some email services built right into it (such as yahoo, fastmail, hotmail, gmail, etc) that greatly simplify the mailto:// service. See more details here.
| Post Method | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| JSON | json:// or jsons:// | (TCP) 80 or 443 | json://hostnamejson://[email protected]://user:[email protected]:portjson://hostname/a/path/to/post/to
| XML | xml:// or xmls:// | (TCP) 80 or 443 | xml://hostnamexml://[email protected]://user:[email protected]:portxml://hostname/a/path/to/post/to
The easiest way is to install this package is from pypi:bash
pip install apprise
A small command line tool is also provided with this package called apprise. If you know the server url's you wish to notify, you can simply provide them all on the command line and send your notifications that way:
```bash
apprise -vv -t 'my title' -b 'my notification body' \
'mailto://myemail:[email protected]' \
'pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b'
cat /proc/cpuinfo | apprise -vv -t 'cpu info' \
'mailto://myemail:[email protected]'
uptime | apprise -vv \
'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'
```
No one wants to put their credentials out for everyone to see on the command line. No problem apprise also supports configuration files. It can handle both a specific YAML format or a very simple TEXT format. You can also pull these configuration files via an HTTP query too! You can read more about the expected structure of the configuration files here.
```bash
apprise -vv -t 'my title' -b 'my notification body'
apprise -vv -t 'my title' -b 'my notification body' \
--config=/path/to/my/config.yml
apprise -vv -t 'my title' -b 'my notification body' \
--config=/path/to/my/config.yml \
--config=https://localhost/my/apprise/config
```
Apprise also supports file attachments too! Specify as many attachments to a notification as you want.
```bash
apprise -vv --title 'Agile Joke' \
--body 'Did you see this one yet?' \
--attach https://i.redd.it/my2t4d2fx0u31.jpg \
'mailto://myemail:[email protected]'
apprise -vv --title 'system crash' \
--body 'I do not think Jim fixed the bug; see attached...' \
--attach /var/log/myprogram.log \
--attach /var/debug/core.2345 \
--tag devteam
```
To send a notification from within your python application, just do the following:
```python
import apprise
apobj = apprise.Apprise()
apobj.add('mailto://myuserid:[email protected]')
apobj.add('pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b')
apobj.notify(
body='what a great notification service!',
title='my notification title',
)
```
Developers need access to configuration files too. The good news is their use just involves declaring another object (called AppriseConfig) that the Apprise object can ingest. You can also freely mix and match config and notification entries as often as you wish! You can read more about the expected structure of the configuration files here.
```python
import apprise
apobj = apprise.Apprise()
config = apprise.AppriseConfig()
config.add('/path/to/my/config.yml')
config.add('https://myserver:8080/path/to/config')
apobj.add(config)
apobj.add('mailto://myuser:[email protected]', tag='admin')
apobj.notify(
body='what a great notification service!',
title='my notification title',
)
apobj.notify(
body='send a notification to our admin group',
title='Attention Admins',
# notify any services tagged with the 'admin' tag
tag='admin',
)
apobj.notify(
body='send a notification to our admin group',
title='Attention Admins',
# notify absolutely everything loaded, reguardless on wether
# it has a tag associated with it or not:
tag='all',
)
```
Attachments are very easy to send using the Apprise API:
```python
import apprise
apobj = apprise.Apprise()
apobj.add('mailto://myuser:[email protected]')
apobj.notify(
title='A great photo of our family',
body='The flash caused Jane to close her eyes! hah! :)',
attach='/local/path/to/my/DSC_003.jpg',
)
apobj.notify(
title='Latest security image',
attach='http:/admin:[email protected]/ISAPI/Streaming/channels/101/picture?cache=3'
)
```
To send more than one attachment, just use a list, set, or tuple instead:
```python
import apprise
apobj = apprise.Apprise()
apobj.add('mailto://myuser:[email protected]')
attach = (
# ?name= allows us to rename the actual jpeg as found on the site
# to be another name when sent to our receipient(s)
'https://i.redd.it/my2t4d2fx0u31.jpg?name=FlyingToMars.jpg',
# Now add another:
'/path/to/funny/joke.gif',
)
apobj.notify(
title='Some good jokes.',
body='Hey guys, check out these!',
attach=attach,
)
```
If you're interested in reading more about this and other methods on how to customize your own notifications, please check out the following links:
* 
Using the CLI
* 🛠 Development API
* 
Troubleshooting
* ⚙ Configuration File Help
* 
Apprise API/Web Interface
* 
Showcase
Want to help make Apprise better?
* 
Contribute to the Apprise Code Base
* 
Sponsorship and Donations