Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/caronc/apprise

Apprise - Push Notifications that work with just about every platform!
https://github.com/caronc/apprise

alerts apprise framework notification-api notification-hub notification-service notifications notifier notify push-notifications python

Last synced: about 1 month ago
JSON representation

Apprise - Push Notifications that work with just about every platform!

Lists

README 

        
![Apprise Logo](https://raw.githubusercontent.com/caronc/apprise/master/apprise/assets/themes/default/apprise-logo.png)






**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.



* One notification library to rule them all.

* A common and intuitive notification syntax.

* Supports the handling of images and attachments (_to the notification services that will accept them_).

* It's incredibly lightweight.

* Amazing response times because all messages sent asynchronously.



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.



[![Paypal](https://img.shields.io/badge/paypal-donate-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MHANV39UZNQ5E)

[![Follow](https://img.shields.io/twitter/follow/l2gnux)](https://twitter.com/l2gnux/)


[![Discord](https://img.shields.io/discord/558793703356104724.svg?colorB=7289DA&label=Discord&logo=Discord&logoColor=7289DA&style=flat-square)](https://discord.gg/MMPeN2D)

[![Python](https://img.shields.io/pypi/pyversions/apprise.svg?style=flat-square)](https://pypi.org/project/apprise/)

[![Build Status](https://github.com/caronc/apprise/actions/workflows/tests.yml/badge.svg)](https://github.com/caronc/apprise/actions/workflows/tests.yml)

[![CodeCov Status](https://codecov.io/github/caronc/apprise/branch/master/graph/badge.svg)](https://codecov.io/github/caronc/apprise)

[![PyPi](https://img.shields.io/pypi/dm/apprise.svg?style=flat-square)](https://pypi.org/project/apprise/)



# Table of Contents



* [Supported Notifications](#supported-notifications)

  * [Productivity Based Notifications](#productivity-based-notifications)

  * [SMS Notifications](#sms-notifications)

  * [Desktop Notifications](#desktop-notifications)

  * [Email Notifications](#email-notifications)

  * [Custom Notifications](#custom-notifications)

* [Installation](#installation)

* [Command Line Usage](#command-line-usage)

  * [Configuration Files](#cli-configuration-files)

  * [File Attachments](#cli-file-attachments)

  * [Loading Custom Notifications/Hooks](#cli-loading-custom-notificationshooks)

* [Developer API Usage](#developer-api-usage)

  * [Configuration Files](#api-configuration-files)

  * [File Attachments](#api-file-attachments)

  * [Loading Custom Notifications/Hooks](#api-loading-custom-notificationshooks)

* [More Supported Links and Documentation](#want-to-learn-more)



# Supported Notifications



The section identifies all of the services supported by this library. [Check out the wiki for more information on the supported modules here](https://github.com/caronc/apprise/wiki).



## Productivity Based Notifications



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 |

| -------------------- | ---------- | ------------ | -------------- |

| [Apprise API](https://github.com/caronc/apprise/wiki/Notify_apprise_api)  | apprise:// or apprises:// | (TCP) 80 or 443 | apprise://hostname/Token

| [AWS SES](https://github.com/caronc/apprise/wiki/Notify_ses)  | ses://   | (TCP) 443   | ses://user@domain/AccessKeyID/AccessSecretKey/RegionName
ses://user@domain/AccessKeyID/AccessSecretKey/RegionName/email1/email2/emailN

| [Bark](https://github.com/caronc/apprise/wiki/Notify_bark)  | bark://   | (TCP) 80 or 443   | bark://hostname
bark://hostname/device_key
bark://hostname/device_key1/device_key2/device_keyN
barks://hostname
barks://hostname/device_key
barks://hostname/device_key1/device_key2/device_keyN

| [Boxcar](https://github.com/caronc/apprise/wiki/Notify_boxcar)  | boxcar://   | (TCP) 443   | boxcar://hostname
boxcar://hostname/@tag
boxcar://hostname/device_token
boxcar://hostname/device_token1/device_token2/device_tokenN
boxcar://hostname/@tag/@tag2/device_token

| [Chantify](https://github.com/caronc/apprise/wiki/Notify_chantify) | chantify://    | (TCP) 443    | chantify://token

| [Discord](https://github.com/caronc/apprise/wiki/Notify_discord)  | discord://   | (TCP) 443   | discord://webhook_id/webhook_token
discord://avatar@webhook_id/webhook_token

| [Emby](https://github.com/caronc/apprise/wiki/Notify_emby)  | emby:// or embys:// | (TCP) 8096 | emby://user@hostname/
emby://user:password@hostname

| [Enigma2](https://github.com/caronc/apprise/wiki/Notify_enigma2)  | enigma2:// or enigma2s:// | (TCP) 80 or 443 | enigma2://hostname

| [FCM](https://github.com/caronc/apprise/wiki/Notify_fcm) | fcm://    | (TCP) 443    | fcm://project@apikey/DEVICE_ID
fcm://project@apikey/#TOPIC
fcm://project@apikey/DEVICE_ID1/#topic1/#topic2/DEVICE_ID2/

| [Feishu](https://github.com/caronc/apprise/wiki/Notify_feishu) | feishu://    | (TCP) 443    | feishu://token

| [Flock](https://github.com/caronc/apprise/wiki/Notify_flock) | flock://    | (TCP) 443    | flock://token
flock://botname@token
flock://app_token/u:userid
flock://app_token/g:channel_id
flock://app_token/u:userid/g:channel_id

| [Google Chat](https://github.com/caronc/apprise/wiki/Notify_googlechat) | gchat://    | (TCP) 443    | gchat://workspace/key/token

| [Gotify](https://github.com/caronc/apprise/wiki/Notify_gotify) | gotify:// or gotifys://   | (TCP) 80 or 443    | gotify://hostname/token
gotifys://hostname/token?priority=high

| [Growl](https://github.com/caronc/apprise/wiki/Notify_growl)  | growl://   | (UDP) 23053   | growl://hostname
growl://hostname:portno
growl://password@hostname
growl://password@hostname:port**Note**: 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

| [Guilded](https://github.com/caronc/apprise/wiki/Notify_guilded)  | guilded://   | (TCP) 443   | guilded://webhook_id/webhook_token
guilded://avatar@webhook_id/webhook_token

| [Home Assistant](https://github.com/caronc/apprise/wiki/Notify_homeassistant)       | hassio:// or hassios://   | (TCP) 8123 or 443 | hassio://hostname/accesstoken
hassio://user@hostname/accesstoken
hassio://user:password@hostname:port/accesstoken
hassio://hostname/optional/path/accesstoken

| [IFTTT](https://github.com/caronc/apprise/wiki/Notify_ifttt) | ifttt://    | (TCP) 443    | ifttt://webhooksID/Event
ifttt://webhooksID/Event1/Event2/EventN
ifttt://webhooksID/Event1/?+Key=Value
ifttt://webhooksID/Event1/?-Key=value1

| [Join](https://github.com/caronc/apprise/wiki/Notify_join) | join://   | (TCP) 443    | join://apikey/device
join://apikey/device1/device2/deviceN/
join://apikey/group
join://apikey/groupA/groupB/groupN
join://apikey/DeviceA/groupA/groupN/DeviceN/

| [KODI](https://github.com/caronc/apprise/wiki/Notify_kodi) | kodi:// or kodis://    | (TCP) 8080 or 443   | kodi://hostname
kodi://user@hostname
kodi://user:password@hostname:port

| [Kumulos](https://github.com/caronc/apprise/wiki/Notify_kumulos) | kumulos:// | (TCP) 443 | kumulos://apikey/serverkey

| [LaMetric Time](https://github.com/caronc/apprise/wiki/Notify_lametric) | lametric:// | (TCP) 443 | lametric://apikey@device_ipaddr
lametric://apikey@hostname:port
lametric://client_id@client_secret

| [Line](https://github.com/caronc/apprise/wiki/Notify_line) | line:// | (TCP) 443 | line://Token@User
line://Token/User1/User2/UserN

| [LunaSea](https://github.com/caronc/apprise/wiki/Notify_lunasea) | lunasea://  | (TCP) 80 or 443   | lunasea://user:pass@+FireBaseDevice/
lunasea://user:pass@FireBaseUser/
lunasea://user:pass@hostname/+FireBaseDevice/
lunasea://user:pass@hostname/@FireBaseUser/

| [Mailgun](https://github.com/caronc/apprise/wiki/Notify_mailgun) | mailgun:// | (TCP) 443 | mailgun://user@hostname/apikey
mailgun://user@hostname/apikey/email
mailgun://user@hostname/apikey/email1/email2/emailN
mailgun://user@hostname/apikey/?name="From%20User"

| [Mastodon](https://github.com/caronc/apprise/wiki/Notify_mastodon) | mastodon:// or mastodons://| (TCP) 80 or 443  | mastodon://access_key@hostname
mastodon://access_key@hostname/@user
mastodon://access_key@hostname/@user1/@user2/@userN

| [Matrix](https://github.com/caronc/apprise/wiki/Notify_matrix) | matrix:// or matrixs://  | (TCP) 80 or 443 | matrix://hostname
matrix://user@hostname
matrixs://user:pass@hostname:port/#room_alias
matrixs://user:pass@hostname:port/!room_id
matrixs://user:pass@hostname:port/#room_alias/!room_id/#room2
matrixs://token@hostname:port/?webhook=matrix
matrix://user:token@hostname/?webhook=slack&format=markdown

| [Mattermost](https://github.com/caronc/apprise/wiki/Notify_mattermost) | mmost:// or mmosts:// | (TCP) 8065 | mmost://hostname/authkey
mmost://hostname:80/authkey
mmost://user@hostname:80/authkey
mmost://hostname/authkey?channel=channel
mmosts://hostname/authkey
mmosts://user@hostname/authkey


| [Microsoft Teams](https://github.com/caronc/apprise/wiki/Notify_msteams) | msteams://  | (TCP) 443   | msteams://TokenA/TokenB/TokenC/

| [Misskey](https://github.com/caronc/apprise/wiki/Notify_misskey) | misskey:// or misskeys://| (TCP) 80 or 443  | misskey://access_token@hostname

| [MQTT](https://github.com/caronc/apprise/wiki/Notify_mqtt) | mqtt://  or mqtts:// | (TCP) 1883 or 8883   | mqtt://hostname/topic
mqtt://user@hostname/topic
mqtts://user:pass@hostname:9883/topic

| [Nextcloud](https://github.com/caronc/apprise/wiki/Notify_nextcloud) | ncloud:// or nclouds:// | (TCP) 80 or 443 | ncloud://adminuser:pass@host/User
nclouds://adminuser:pass@host/User1/User2/UserN

| [NextcloudTalk](https://github.com/caronc/apprise/wiki/Notify_nextcloudtalk) | nctalk:// or nctalks:// | (TCP) 80 or 443 | nctalk://user:pass@host/RoomId
nctalks://user:pass@host/RoomId1/RoomId2/RoomIdN

| [Notica](https://github.com/caronc/apprise/wiki/Notify_notica) | notica://  | (TCP) 443   | notica://Token/

| [Notifiarr](https://github.com/caronc/apprise/wiki/Notify_notifiarr) | notifiarr:// | (TCP) 443 | notifiarr://apikey/#channel
notifiarr://apikey/#channel1/#channel2/#channeln

| [Notifico](https://github.com/caronc/apprise/wiki/Notify_notifico) | notifico://  | (TCP) 443   | notifico://ProjectID/MessageHook/

| [ntfy](https://github.com/caronc/apprise/wiki/Notify_ntfy) | ntfy://  | (TCP) 80 or 443   | ntfy://topic/
ntfys://topic/

| [Office 365](https://github.com/caronc/apprise/wiki/Notify_office365) | o365://  | (TCP) 443   | o365://TenantID:AccountEmail/ClientID/ClientSecret
o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail
o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail1/TargetEmail2/TargetEmailN

| [OneSignal](https://github.com/caronc/apprise/wiki/Notify_onesignal) | onesignal:// | (TCP) 443 | onesignal://AppID@APIKey/PlayerID
onesignal://TemplateID:AppID@APIKey/UserID
onesignal://AppID@APIKey/#IncludeSegment
onesignal://AppID@APIKey/Email

| [Opsgenie](https://github.com/caronc/apprise/wiki/Notify_opsgenie) | opsgenie:// | (TCP) 443 | opsgenie://APIKey
opsgenie://APIKey/UserID
opsgenie://APIKey/#Team
opsgenie://APIKey/\*Schedule
opsgenie://APIKey/^Escalation

| [PagerDuty](https://github.com/caronc/apprise/wiki/Notify_pagerduty) | pagerduty:// | (TCP) 443 | pagerduty://IntegrationKey@ApiKey
pagerduty://IntegrationKey@ApiKey/Source/Component

| [PagerTree](https://github.com/caronc/apprise/wiki/Notify_pagertree) | pagertree:// | (TCP) 443 | pagertree://integration_id

| [ParsePlatform](https://github.com/caronc/apprise/wiki/Notify_parseplatform) | parsep:// or parseps:// | (TCP) 80 or 443 | parsep://AppID:MasterKey@Hostname
parseps://AppID:MasterKey@Hostname

| [PopcornNotify](https://github.com/caronc/apprise/wiki/Notify_popcornnotify) | popcorn://  | (TCP) 443   | popcorn://ApiKey/ToPhoneNo
popcorn://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
popcorn://ApiKey/ToEmail
popcorn://ApiKey/ToEmail1/ToEmail2/ToEmailN/
popcorn://ApiKey/ToPhoneNo1/ToEmail1/ToPhoneNoN/ToEmailN

| [Prowl](https://github.com/caronc/apprise/wiki/Notify_prowl) | prowl://   | (TCP) 443    | prowl://apikey
prowl://apikey/providerkey

| [PushBullet](https://github.com/caronc/apprise/wiki/Notify_pushbullet) | pbul://    | (TCP) 443    | pbul://accesstoken
pbul://accesstoken/#channel
pbul://accesstoken/A_DEVICE_ID
pbul://accesstoken/[email protected]
pbul://accesstoken/#channel/#channel2/[email protected]/DEVICE

| [Pushjet](https://github.com/caronc/apprise/wiki/Notify_pushjet) | pjet:// or pjets:// | (TCP) 80 or 443 | pjet://hostname/secret
pjet://hostname:port/secret
pjets://secret@hostname/secret
pjets://hostname:port/secret

| [Push (Techulus)](https://github.com/caronc/apprise/wiki/Notify_techulus) | push://    | (TCP) 443    | push://apikey/

| [Pushed](https://github.com/caronc/apprise/wiki/Notify_pushed) | pushed://    | (TCP) 443    | pushed://appkey/appsecret/
pushed://appkey/appsecret/#ChannelAlias
pushed://appkey/appsecret/#ChannelAlias1/#ChannelAlias2/#ChannelAliasN
pushed://appkey/appsecret/@UserPushedID
pushed://appkey/appsecret/@UserPushedID1/@UserPushedID2/@UserPushedIDN

| [PushMe](https://github.com/caronc/apprise/wiki/Notify_pushme) | pushme://  | (TCP) 443   | pushme://Token/

| [Pushover](https://github.com/caronc/apprise/wiki/Notify_pushover)  | pover://   | (TCP) 443   | pover://user@token
pover://user@token/DEVICE
pover://user@token/DEVICE1/DEVICE2/DEVICEN
**Note**: you must specify both your user_id and token

| [PushSafer](https://github.com/caronc/apprise/wiki/Notify_pushsafer)  | psafer:// or psafers://  | (TCP) 80 or 443  | psafer://privatekey
psafers://privatekey/DEVICE
psafer://privatekey/DEVICE1/DEVICE2/DEVICEN

| [Pushy](https://github.com/caronc/apprise/wiki/Notify_pushy)  | pushy://  | (TCP) 443  | pushy://apikey/DEVICE
pushy://apikey/DEVICE1/DEVICE2/DEVICEN
pushy://apikey/TOPIC
pushy://apikey/TOPIC1/TOPIC2/TOPICN

| [PushDeer](https://github.com/caronc/apprise/wiki/Notify_pushdeer) | pushdeer:// or pushdeers:// | (TCP) 80 or 443 | pushdeer://pushKey
pushdeer://hostname/pushKey
pushdeer://hostname:port/pushKey

| [Reddit](https://github.com/caronc/apprise/wiki/Notify_reddit) | reddit:// | (TCP) 443   | reddit://user:password@app_id/app_secret/subreddit
reddit://user:password@app_id/app_secret/sub1/sub2/subN

| [Revolt](https://github.com/caronc/apprise/wiki/Notify_Revolt) | revolt:// | (TCP) 443   |  revolt://bottoken/ChannelID
revolt://bottoken/ChannelID1/ChannelID2/ChannelIDN |

| [Rocket.Chat](https://github.com/caronc/apprise/wiki/Notify_rocketchat) | rocket:// or rockets://  | (TCP) 80 or 443   | rocket://user:password@hostname/RoomID/Channel
rockets://user:password@hostname:443/#Channel1/#Channel1/RoomID
rocket://user:password@hostname/#Channel
rocket://webhook@hostname
rockets://webhook@hostname/@User/#Channel

| [RSyslog](https://github.com/caronc/apprise/wiki/Notify_rsyslog) | rsyslog://  | (UDP) 514 | rsyslog://hostname
rsyslog://hostname/Facility

| [Ryver](https://github.com/caronc/apprise/wiki/Notify_ryver) | ryver://  | (TCP) 443   | ryver://Organization/Token
ryver://botname@Organization/Token

| [SendGrid](https://github.com/caronc/apprise/wiki/Notify_sendgrid) | sendgrid://  | (TCP) 443   | sendgrid://APIToken:FromEmail/
sendgrid://APIToken:FromEmail/ToEmail
sendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/

| [ServerChan](https://github.com/caronc/apprise/wiki/Notify_serverchan) | schan://   | (TCP) 443    | schan://sendkey/

| [Signal API](https://github.com/caronc/apprise/wiki/Notify_signal) | signal://  or signals:// | (TCP) 80 or 443  | signal://hostname:port/FromPhoneNo
signal://hostname:port/FromPhoneNo/ToPhoneNo
signal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [SimplePush](https://github.com/caronc/apprise/wiki/Notify_simplepush) | spush://   | (TCP) 443    | spush://apikey
spush://salt:password@apikey
spush://apikey?event=Apprise

| [Slack](https://github.com/caronc/apprise/wiki/Notify_slack) | slack://  | (TCP) 443   | slack://TokenA/TokenB/TokenC/
slack://TokenA/TokenB/TokenC/Channel
slack://botname@TokenA/TokenB/TokenC/Channel
slack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelN

| [SMTP2Go](https://github.com/caronc/apprise/wiki/Notify_smtp2go) | smtp2go:// | (TCP) 443 | smtp2go://user@hostname/apikey
smtp2go://user@hostname/apikey/email
smtp2go://user@hostname/apikey/email1/email2/emailN
smtp2go://user@hostname/apikey/?name="From%20User"

| [Streamlabs](https://github.com/caronc/apprise/wiki/Notify_streamlabs) | strmlabs:// | (TCP) 443 | strmlabs://AccessToken/
strmlabs://AccessToken/?name=name&identifier=identifier&amount=0&currency=USD

| [SparkPost](https://github.com/caronc/apprise/wiki/Notify_sparkpost) | sparkpost:// | (TCP) 443 | sparkpost://user@hostname/apikey
sparkpost://user@hostname/apikey/email
sparkpost://user@hostname/apikey/email1/email2/emailN
sparkpost://user@hostname/apikey/?name="From%20User"

| [Synology Chat](https://github.com/caronc/apprise/wiki/Notify_synology_chat) | synology:// or synologys:// |  (TCP) 80 or 443 | synology://hostname/token
synology://hostname:port/token

| [Syslog](https://github.com/caronc/apprise/wiki/Notify_syslog) | syslog://  | n/a | syslog://
syslog://Facility

| [Telegram](https://github.com/caronc/apprise/wiki/Notify_telegram) | tgram://  | (TCP) 443   | tgram://bottoken/ChatID
tgram://bottoken/ChatID1/ChatID2/ChatIDN

| [Twitter](https://github.com/caronc/apprise/wiki/Notify_twitter) | twitter://  | (TCP) 443   | twitter://CKey/CSecret/AKey/ASecret
twitter://user@CKey/CSecret/AKey/ASecret
twitter://CKey/CSecret/AKey/ASecret/User1/User2/User2
twitter://CKey/CSecret/AKey/ASecret?mode=tweet

| [Twist](https://github.com/caronc/apprise/wiki/Notify_twist) | twist://  | (TCP) 443   | twist://pasword:login
twist://password:login/#channel
twist://password:login/#team:channel
twist://password:login/#team:channel1/channel2/#team3:channel

| [XBMC](https://github.com/caronc/apprise/wiki/Notify_xbmc) | xbmc:// or xbmcs://    | (TCP) 8080 or 443   | xbmc://hostname
xbmc://user@hostname
xbmc://user:password@hostname:port

| [Webex Teams (Cisco)](https://github.com/caronc/apprise/wiki/Notify_wxteams) | wxteams://  | (TCP) 443   | wxteams://Token

| [WeCom Bot](https://github.com/caronc/apprise/wiki/Notify_wecombot) | wecombot://  | (TCP) 443   | wecombot://BotKey

| [WhatsApp](https://github.com/caronc/apprise/wiki/Notify_whatsapp) | whatsapp://  | (TCP) 443   | whatsapp://AccessToken@FromPhoneID/ToPhoneNo
 whatsapp://Template:AccessToken@FromPhoneID/ToPhoneNo

| [Zulip Chat](https://github.com/caronc/apprise/wiki/Notify_zulip) | zulip://  | (TCP) 443   | zulip://botname@Organization/Token
zulip://botname@Organization/Token/Stream
zulip://botname@Organization/Token/Email



## SMS Notifications



| Notification Service | Service ID | Default Port | Example Syntax |

| -------------------- | ---------- | ------------ | -------------- |

| [Automated Packet Reporting System (ARPS)](https://github.com/caronc/apprise/wiki/Notify_aprs)  | aprs:// | (TCP) 10152 | aprs://user:pass@callsign
aprs://user:pass@callsign1/callsign2/callsignN

| [AWS SNS](https://github.com/caronc/apprise/wiki/Notify_sns)  | sns://   | (TCP) 443   | sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo
sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo1/+PhoneNo2/+PhoneNoN
sns://AccessKeyID/AccessSecretKey/RegionName/Topic
sns://AccessKeyID/AccessSecretKey/RegionName/Topic1/Topic2/TopicN

| [BulkSMS](https://github.com/caronc/apprise/wiki/Notify_bulksms) | bulksms://  | (TCP) 443   | bulksms://user:password@ToPhoneNo
bulksms://User:Password@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [BulkVS](https://github.com/caronc/apprise/wiki/Notify_bulkvs) | bulkvs://  | (TCP) 443   | bulkvs://user:password@FromPhoneNo
bulkvs://user:password@FromPhoneNo/ToPhoneNo
bulkvs://user:password@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Burst SMS](https://github.com/caronc/apprise/wiki/Notify_burst_sms) | burstsms://  | (TCP) 443   | burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo
burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Burst SMS](https://github.com/caronc/apprise/wiki/Notify_burst_sms) | burstsms://  | (TCP) 443   | burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo
burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [ClickSend](https://github.com/caronc/apprise/wiki/Notify_clicksend) | clicksend://  | (TCP) 443   | clicksend://user:pass@PhoneNo
clicksend://user:pass@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN

| [DAPNET](https://github.com/caronc/apprise/wiki/Notify_dapnet) | dapnet://  | (TCP) 80   | dapnet://user:pass@callsign
dapnet://user:pass@callsign1/callsign2/callsignN

| [D7 Networks](https://github.com/caronc/apprise/wiki/Notify_d7networks) | d7sms://  | (TCP) 443   | d7sms://token@PhoneNo
d7sms://token@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN

| [DingTalk](https://github.com/caronc/apprise/wiki/Notify_dingtalk)  | dingtalk://   | (TCP) 443   | dingtalk://token/
dingtalk://token/ToPhoneNo
dingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/

| [Free-Mobile](https://github.com/caronc/apprise/wiki/Notify_freemobile)  | freemobile://   | (TCP) 443   | freemobile://user@password/

 [httpSMS](https://github.com/caronc/apprise/wiki/Notify_httpsms) | httpsms://  | (TCP) 443   | httpsms://ApiKey@FromPhoneNo
httpsms://ApiKey@FromPhoneNo/ToPhoneNo
httpsms://ApiKey@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Kavenegar](https://github.com/caronc/apprise/wiki/Notify_kavenegar) | kavenegar://  | (TCP) 443   | kavenegar://ApiKey/ToPhoneNo
kavenegar://FromPhoneNo@ApiKey/ToPhoneNo
kavenegar://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN

| [MessageBird](https://github.com/caronc/apprise/wiki/Notify_messagebird) | msgbird://  | (TCP) 443   | msgbird://ApiKey/FromPhoneNo
msgbird://ApiKey/FromPhoneNo/ToPhoneNo
msgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [MSG91](https://github.com/caronc/apprise/wiki/Notify_msg91) | msg91://  | (TCP) 443   | msg91://TemplateID@AuthKey/ToPhoneNo
msg91://TemplateID@AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Signal API](https://github.com/caronc/apprise/wiki/Notify_signal) | signal://  or signals:// | (TCP) 80 or 443  | signal://hostname:port/FromPhoneNo
signal://hostname:port/FromPhoneNo/ToPhoneNo
signal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Sinch](https://github.com/caronc/apprise/wiki/Notify_sinch) | sinch://  | (TCP) 443   | sinch://ServicePlanId:ApiToken@FromPhoneNo
sinch://ServicePlanId:ApiToken@FromPhoneNo/ToPhoneNo
sinch://ServicePlanId:ApiToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
sinch://ServicePlanId:ApiToken@ShortCode/ToPhoneNo
sinch://ServicePlanId:ApiToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [SMSEagle](https://github.com/caronc/apprise/wiki/Notify_smseagle) | smseagle:// or smseagles:// | (TCP) 80 or 443  | smseagles://hostname:port/ToPhoneNo
smseagles://hostname:port/@ToContact
smseagles://hostname:port/#ToGroup
smseagles://hostname:port/ToPhoneNo1/#ToGroup/@ToContact/

 [SMS Manager](https://github.com/caronc/apprise/wiki/Notify_sms_manager) | smsmgr://  | (TCP) 443   | smsmgr://ApiKey@ToPhoneNo
smsmgr://ApiKey@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Threema Gateway](https://github.com/caronc/apprise/wiki/Notify_threema) | threema://  | (TCP) 443   | threema://GatewayID@secret/ToPhoneNo
threema://GatewayID@secret/ToEmail
threema://GatewayID@secret/ToThreemaID/
threema://GatewayID@secret/ToEmail/ToThreemaID/ToPhoneNo/...

| [Twilio](https://github.com/caronc/apprise/wiki/Notify_twilio) | twilio://  | (TCP) 443   | twilio://AccountSid:AuthToken@FromPhoneNo
twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo
twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo?apikey=Key
twilio://AccountSid:AuthToken@ShortCode/ToPhoneNo
twilio://AccountSid:AuthToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Voipms](https://github.com/caronc/apprise/wiki/Notify_voipms) | voipms://  | (TCP) 443   | voipms://password:email/FromPhoneNo
voipms://password:email/FromPhoneNo/ToPhoneNo
voipms://password:email/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

| [Vonage](https://github.com/caronc/apprise/wiki/Notify_nexmo) (formerly Nexmo) | nexmo://  | (TCP) 443   | nexmo://ApiKey:ApiSecret@FromPhoneNo
nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo
nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/



## Desktop Notifications



| Notification Service | Service ID | Default Port | Example Syntax |

| -------------------- | ---------- | ------------ | -------------- |

| [Linux DBus Notifications](https://github.com/caronc/apprise/wiki/Notify_dbus)  | dbus://
qt://
glib://
kde://  | n/a  | dbus://
qt://
glib://
kde://

| [Linux Gnome Notifications](https://github.com/caronc/apprise/wiki/Notify_gnome) | gnome://    |        n/a          | gnome://

| [MacOS X Notifications](https://github.com/caronc/apprise/wiki/Notify_macosx) | macosx://    |        n/a          | macosx://

| [Windows Notifications](https://github.com/caronc/apprise/wiki/Notify_windows) | windows://    |        n/a          | windows://



## Email Notifications



| Service ID | Default Port | Example Syntax |

| ---------- | ------------ | -------------- |

| [mailto://](https://github.com/caronc/apprise/wiki/Notify_email)  |  (TCP) 25    | mailto://userid:[email protected]
mailto://domain.com?user=userid&pass=password
mailto://domain.com:2525?user=userid&pass=password
mailto://[email protected]&pass=password
mailto://mySendingUsername:[email protected][email protected]
mailto://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply

| [mailtos://](https://github.com/caronc/apprise/wiki/Notify_email) |  (TCP) 587   | mailtos://userid:[email protected]
mailtos://domain.com?user=userid&pass=password
mailtos://domain.com:465?user=userid&pass=password
mailtos://[email protected]&pass=password
mailtos://mySendingUsername:[email protected][email protected]
mailtos://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](https://github.com/caronc/apprise/wiki/Notify_email).



## Custom Notifications



| Post Method          | Service ID | Default Port | Example Syntax |

| -------------------- | ---------- | ------------ | -------------- |

| [Form](https://github.com/caronc/apprise/wiki/Notify_Custom_Form)       | form:// or forms://   | (TCP) 80 or 443 | form://hostname
form://user@hostname
form://user:password@hostname:port
form://hostname/a/path/to/post/to

| [JSON](https://github.com/caronc/apprise/wiki/Notify_Custom_JSON)       | json:// or jsons://   | (TCP) 80 or 443 | json://hostname
json://user@hostname
json://user:password@hostname:port
json://hostname/a/path/to/post/to

| [XML](https://github.com/caronc/apprise/wiki/Notify_Custom_XML)         | xml:// or xmls://   | (TCP) 80 or 443 | xml://hostname
xml://user@hostname
xml://user:password@hostname:port
xml://hostname/a/path/to/post/to



# Installation



The easiest way is to install this package is from pypi:

```bash

pip install apprise

```



Apprise is also packaged as an RPM and available through [EPEL](https://docs.fedoraproject.org/en-US/epel/) supporting CentOS, Redhat, Rocky, Oracle Linux, etc.

```bash

# Follow instructions on https://docs.fedoraproject.org/en-US/epel

# to get your system connected up to EPEL and then:

# Redhat/CentOS 7.x users

yum install apprise



# Redhat/CentOS 8.x+ and/or Fedora Users

dnf install apprise

```



You can also check out the [Graphical version of Apprise](https://github.com/caronc/apprise-api) to centralize your configuration and notifications through a managable webpage.



# Command Line Usage



A small command line interface (CLI) tool is also provided with this package called *apprise*. If you know the server urls you wish to notify, you can simply provide them all on the command line and send your notifications that way:

```bash

# Send a notification to as many servers as you want

# as you can easily chain one after another (the -vv provides some

# additional verbosity to help let you know what is going on):

apprise -vv -t 'my title' -b 'my notification body' \

   'mailto://myemail:[email protected]' \

   'pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b'



# If you don't specify a --body (-b) then stdin is used allowing

# you to use the tool as part of your every day administration:

cat /proc/cpuinfo | apprise -vv -t 'cpu info' \

   'mailto://myemail:[email protected]'



# The title field is totally optional

uptime | apprise -vv \

   'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'

```



## CLI Configuration Files



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](https://github.com/caronc/apprise/wiki/config_yaml) or a very simple [TEXT format](https://github.com/caronc/apprise/wiki/config_text). 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](https://github.com/caronc/apprise/wiki/config).

```bash

# By default if no url or configuration is specified apprise will attempt to load

# configuration files (if present) from:

#  ~/.apprise

#  ~/.apprise.yaml

#  ~/.config/apprise.conf

#  ~/.config/apprise.yaml

#  /etc/apprise.conf

#  /etc/apprise.yaml



# Also a subdirectory handling allows you to leverage plugins

#  ~/.apprise/apprise

#  ~/.apprise/apprise.yaml

#  ~/.config/apprise/apprise.conf

#  ~/.config/apprise/apprise.yaml

#  /etc/apprise/apprise.yaml

#  /etc/apprise/apprise.conf



# Windows users can store their default configuration files here:

#  %APPDATA%/Apprise/apprise.conf

#  %APPDATA%/Apprise/apprise.yaml

#  %LOCALAPPDATA%/Apprise/apprise.conf

#  %LOCALAPPDATA%/Apprise/apprise.yaml

#  %ALLUSERSPROFILE%\Apprise\apprise.conf

#  %ALLUSERSPROFILE%\Apprise\apprise.yaml

#  %PROGRAMFILES%\Apprise\apprise.conf

#  %PROGRAMFILES%\Apprise\apprise.yaml

#  %COMMONPROGRAMFILES%\Apprise\apprise.conf

#  %COMMONPROGRAMFILES%\Apprise\apprise.yaml



# The configuration files specified above can also be identified with a `.yml`

# extension or even just entirely removing the `.conf` extension altogether.



# If you loaded one of those files, your command line gets really easy:

apprise -vv -t 'my title' -b 'my notification body'



# If you want to deviate from the default paths or specify more than one,

# just specify them using the --config switch:

apprise -vv -t 'my title' -b 'my notification body' \

   --config=/path/to/my/config.yml



# Got lots of configuration locations? No problem, you can specify them all:

# Apprise can even fetch the configuration from over a network!

apprise -vv -t 'my title' -b 'my notification body' \

   --config=/path/to/my/config.yml \

   --config=https://localhost/my/apprise/config

```



## CLI File Attachments



Apprise also supports file attachments too! Specify as many attachments to a notification as you want.

```bash

# Send a funny image you found on the internet to a colleague:

apprise -vv --title 'Agile Joke' \

        --body 'Did you see this one yet?' \

        --attach https://i.redd.it/my2t4d2fx0u31.jpg \

        'mailto://myemail:[email protected]'



# Easily send an update from a critical server to your dev team

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

```



## CLI Loading Custom Notifications/Hooks



To create your own custom `schema://` hook so that you can trigger your own custom code,

simply include the `@notify` decorator to wrap your function.

```python

from apprise.decorators import notify

#

# The below assumes you want to catch foobar:// calls:

#

@notify(on="foobar", name="My Custom Foobar Plugin")

def my_custom_notification_wrapper(body, title, notify_type, *args, **kwargs):

    """My custom notification function that triggers on all foobar:// calls

    """

    # Write all of your code here... as an example...

    print("{}: {} - {}".format(notify_type.upper(), title, body))



    # Returning True/False is a way to relay your status back to Apprise.

    # Returning nothing (None by default) is always interpreted as a Success

```



Once you've defined your custom hook, you just need to tell Apprise where it is at runtime.

```bash

# By default if no plugin path is specified apprise will attempt to load

# all plugin files (if present) from the following directory paths:

#  ~/.apprise/plugins

#  ~/.config/apprise/plugins

#  /var/lib/apprise/plugins



# Windows users can store their default plugin files in these directories:

#  %APPDATA%/Apprise/plugins

#  %LOCALAPPDATA%/Apprise/plugins

#  %ALLUSERSPROFILE%\Apprise\plugins

#  %PROGRAMFILES%\Apprise\plugins

#  %COMMONPROGRAMFILES%\Apprise\plugins



# If you placed your plugin file within one of the directories already defined

# above, then your call simply needs to look like:

apprise -vv --title 'custom override' \

        --body 'the body of my message' \

        foobar:\\



# However you can over-ride the path like so

apprise -vv --title 'custom override' \

        --body 'the body of my message' \

        --plugin-path /path/to/my/plugin.py \

        foobar:\\

```



You can read more about creating your own custom notifications and/or hooks [here](https://github.com/caronc/apprise/wiki/decorator_notify).



# Developer API Usage



To send a notification from within your python application, just do the following:

```python

import apprise



# Create an Apprise instance

apobj = apprise.Apprise()



# Add all of the notification services by their server url.

# A sample email notification:

apobj.add('mailto://myuserid:[email protected]')



# A sample pushbullet notification

apobj.add('pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b')



# Then notify these services any time you desire. The below would

# notify all of the services loaded into our Apprise object.

apobj.notify(

    body='what a great notification service!',

    title='my notification title',

)

```



## API Configuration Files



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](https://github.com/caronc/apprise/wiki/config).

```python

import apprise



# Create an Apprise instance

apobj = apprise.Apprise()



# Create an Config instance

config = apprise.AppriseConfig()



# Add a configuration source:

config.add('/path/to/my/config.yml')



# Add another...

config.add('https://myserver:8080/path/to/config')



# Make sure to add our config into our apprise object

apobj.add(config)



# You can mix and match; add an entry directly if you want too

# In this entry we associate the 'admin' tag with our notification

apobj.add('mailto://myuser:[email protected]', tag='admin')



# Then notify these services any time you desire. The below would

# notify all of the services that have not been bound to any specific

# tag.

apobj.notify(

    body='what a great notification service!',

    title='my notification title',

)



# Tagging allows you to specifically target only specific notification

# services you've loaded:

apobj.notify(

    body='send a notification to our admin group',

    title='Attention Admins',

    # notify any services tagged with the 'admin' tag

    tag='admin',

)



# If you want to notify absolutely everything (regardless of whether

# it's been tagged or not), just use the reserved tag of 'all':

apobj.notify(

    body='send a notification to our admin group',

    title='Attention Admins',

    # notify absolutely everything loaded, regardless on wether

    # it has a tag associated with it or not:

    tag='all',

)

```



## API File Attachments



Attachments are very easy to send using the Apprise API:

```python

import apprise



# Create an Apprise instance

apobj = apprise.Apprise()



# Add at least one service you want to notify

apobj.add('mailto://myuser:[email protected]')



# Then send your attachment.

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',

)



# Send a web based attachment too! In the below example, we connect to a home

# security camera and send a live image to an email. By default remote web

# content is cached, but for a security camera we might want to call notify

# again later in our code, so we want our last image retrieved to expire(in

# this case after 3 seconds).

apobj.notify(

    title='Latest security image',

    attach='http://admin:password@hikvision-cam01/ISAPI/Streaming/channels/101/picture?cache=3'

)

```



To send more than one attachment, just use a list, set, or tuple instead:

```python

import apprise



# Create an Apprise instance

apobj = apprise.Apprise()



# Add at least one service you want to notify

apobj.add('mailto://myuser:[email protected]')



# Now add all of the entries we're interested in:

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',

)



# Send your multiple attachments with a single notify call:

apobj.notify(

    title='Some good jokes.',

    body='Hey guys, check out these!',

    attach=attach,

)

```



## API Loading Custom Notifications/Hooks



By default, no custom plugins are loaded at all for those building from within the Apprise API.

It's at the developers discretion to load custom modules. But should you choose to do so, it's as easy

as including the path reference in the `AppriseAsset()` object prior to the initialization of your `Apprise()`

instance.



For example:

```python

from apprise import Apprise

from apprise import AppriseAsset



# Prepare your Asset object so that you can enable the custom plugins to

# be loaded for your instance of Apprise...

asset = AppriseAsset(plugin_paths="/path/to/scan")



# OR You can also generate scan more then one file too:

asset = AppriseAsset(

    plugin_paths=[

        # Iterate over all python libraries found in the root of the

        # specified path. This is NOT a recursive (directory) scan; only

        # the first level is parsed. HOWEVER, if a directory containing

        # an __init__.py is found, it will be included in the load.

        "/dir/containing/many/python/libraries",



        # An absolute path to a plugin.py to exclusively load

        "/path/to/plugin.py",



        # if you point to a directory that has an __init__.py file found in

        # it, then only that file is loaded (it's similar to point to a

        # absolute .py file. Hence, there is no (level 1) scanning at all

        # within the directory specified.

        "/path/to/dir/library"

    ]

)



# Now that we've got our asset, we just work with our Apprise object as we

# normally do

aobj = Apprise(asset=asset)



# If our new custom `foobar://` library was loaded (presuming we prepared

# one like in the examples above).  then you would be able to safely add it

# into Apprise at this point

aobj.add('foobar://')



# Send our notification out through our foobar://

aobj.notify("test")

```



You can read more about creating your own custom notifications and/or hooks [here](https://github.com/caronc/apprise/wiki/decorator_notify).



# Want To Learn More?



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](https://github.com/caronc/apprise/wiki/CLI_Usage)

* 🛠️ [Development API](https://github.com/caronc/apprise/wiki/Development_API)

* 🔧 [Troubleshooting](https://github.com/caronc/apprise/wiki/Troubleshooting)

* ⚙️ [Configuration File Help](https://github.com/caronc/apprise/wiki/config)

* ⚡ [Create Your Own Custom Notifications](https://github.com/caronc/apprise/wiki/decorator_notify)

* 🌎 [Apprise API/Web Interface](https://github.com/caronc/apprise-api)

* 🎉 [Showcase](https://github.com/caronc/apprise/wiki/showcase)



Want to help make Apprise better?

* 💡 [Contribute to the Apprise Code Base](https://github.com/caronc/apprise/wiki/Development_Contribution)

* ❤️ [Sponsorship and Donations](https://github.com/caronc/apprise/wiki/Sponsors)