Package: apprise
ap·prise/verbTo inform or tell (someone). To make one aware of something.Appriseallows you to send a notification toalmostall of the most popularnotificationservices 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 theapprisecommand line tool (CLI) that ships with this product.Table of ContentsSupported NotificationsProductivity Based NotificationsSMS NotificationsDesktop NotificationsEmail NotificationsCustom NotificationsInstallationCommand Line UsageConfiguration FilesFile AttachmentsLoading Custom Notifications/HooksDeveloper API UsageConfiguration FilesFile AttachmentsLoading Custom Notifications/HooksMore Supported Links and DocumentationSupported NotificationsThe section identifies all of the services supported by this library.Check out the wiki for more information on the supported modules here.Productivity Based NotificationsThe 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 ServiceService IDDefault PortExample SyntaxApprise APIapprise:// or apprises://(TCP) 80 or 443apprise://hostname/TokenAWS SESses://(TCP) 443ses://user@domain/AccessKeyID/AccessSecretKey/RegionNameses://user@domain/AccessKeyID/AccessSecretKey/RegionName/email1/email2/emailNBarkbark://(TCP) 80 or 443bark://hostnamebark://hostname/device_keybark://hostname/device_key1/device_key2/device_keyNbarks://hostnamebarks://hostname/device_keybarks://hostname/device_key1/device_key2/device_keyNBoxcarboxcar://(TCP) 443boxcar://hostnameboxcar://hostname/@tagboxcar://hostname/device_tokenboxcar://hostname/device_token1/device_token2/device_tokenNboxcar://hostname/@tag/@tag2/device_tokenDiscorddiscord://(TCP) 443discord://webhook_id/webhook_tokendiscord://avatar@webhook_id/webhook_tokenEmbyemby:// or embys://(TCP) 8096emby://user@hostname/emby://user:password@hostnameEnigma2enigma2:// or enigma2s://(TCP) 80 or 443enigma2://hostnameFaastfaast://(TCP) 443faast://authorizationtokenFCMfcm://(TCP) 443fcm://project@apikey/DEVICE_IDfcm://project@apikey/#TOPICfcm://project@apikey/DEVICE_ID1/#topic1/#topic2/DEVICE_ID2/Flockflock://(TCP) 443flock://tokenflock://botname@tokenflock://app_token/u:useridflock://app_token/g:channel_idflock://app_token/u:userid/g:channel_idGoogle Chatgchat://(TCP) 443gchat://workspace/key/tokenGotifygotify:// or gotifys://(TCP) 80 or 443gotify://hostname/tokengotifys://hostname/token?priority=highGrowlgrowl://(UDP) 23053growl://hostnamegrowl://hostname:portnogrowl://password@hostnamegrowl://password@hostname:portNote: you can also use the get parameterversionwhich can allow the growl request to behave using the older v1.x protocol. An example would look like: growl://hostname?version=1Guildedguilded://(TCP) 443guilded://webhook_id/webhook_tokenguilded://avatar@webhook_id/webhook_tokenHome Assistanthassio:// or hassios://(TCP) 8123 or 443hassio://hostname/accesstokenhassio://user@hostname/accesstokenhassio://user:password@hostname:port/accesstokenhassio://hostname/optional/path/accesstokenIFTTTifttt://(TCP) 443ifttt://webhooksID/Eventifttt://webhooksID/Event1/Event2/EventNifttt://webhooksID/Event1/?+Key=Valueifttt://webhooksID/Event1/?-Key=value1Joinjoin://(TCP) 443join://apikey/devicejoin://apikey/device1/device2/deviceN/join://apikey/groupjoin://apikey/groupA/groupB/groupNjoin://apikey/DeviceA/groupA/groupN/DeviceN/KODIkodi:// or kodis://(TCP) 8080 or 443kodi://hostnamekodi://user@hostnamekodi://user:password@hostname:portKumuloskumulos://(TCP) 443kumulos://apikey/serverkeyLaMetric Timelametric://(TCP) 443lametric://apikey@device_ipaddrlametric://apikey@hostname:portlametric://client_id@client_secretLineline://(TCP) 443line://Token@Userline://Token/User1/User2/UserNMailgunmailgun://(TCP) 443mailgun://user@hostname/apikeymailgun://user@hostname/apikey/emailmailgun://user@hostname/apikey/email1/email2/emailNmailgun://user@hostname/apikey/?name="From%20User"Mastodonmastodon:// or mastodons://(TCP) 80 or 443mastodon://access_key@hostnamemastodon://access_key@hostname/@usermastodon://access_key@hostname/@user1/@user2/@userNMatrixmatrix:// or matrixs://(TCP) 80 or 443matrix://hostnamematrix://user@hostnamematrixs://user:pass@hostname:port/#room_aliasmatrixs://user:pass@hostname:port/!room_idmatrixs://user:pass@hostname:port/#room_alias/!room_id/#room2matrixs://token@hostname:port/?webhook=matrixmatrix://user:token@hostname/?webhook=slack&format=markdownMattermostmmost:// or mmosts://(TCP) 8065mmost://hostname/authkeymmost://hostname:80/authkeymmost://user@hostname:80/authkeymmost://hostname/authkey?channel=channelmmosts://hostname/authkeymmosts://user@hostname/authkeyMicrosoft Teamsmsteams://(TCP) 443msteams://TokenA/TokenB/TokenC/Misskeymisskey:// or misskeys://(TCP) 80 or 443misskey://access_token@hostnameMQTTmqtt://  or mqtts://(TCP) 1883 or 8883mqtt://hostname/topicmqtt://user@hostname/topicmqtts://user:pass@hostname:9883/topicNextcloudncloud:// or nclouds://(TCP) 80 or 443ncloud://adminuser:pass@host/Usernclouds://adminuser:pass@host/User1/User2/UserNNextcloudTalknctalk:// or nctalks://(TCP) 80 or 443nctalk://user:pass@host/RoomIdnctalks://user:pass@host/RoomId1/RoomId2/RoomIdNNoticanotica://(TCP) 443notica://Token/Notifiarrnotifiarr://(TCP) 443notifiarr://apikey/#channelnotifiarr://apikey/#channel1/#channel2/#channelnNotificonotifico://(TCP) 443notifico://ProjectID/MessageHook/ntfyntfy://(TCP) 80 or 443ntfy://topic/ntfys://topic/Office 365o365://(TCP) 443o365://TenantID:AccountEmail/ClientID/ClientSecreto365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmailo365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail1/TargetEmail2/TargetEmailNOneSignalonesignal://(TCP) 443onesignal://AppID@APIKey/PlayerIDonesignal://TemplateID:AppID@APIKey/UserIDonesignal://AppID@APIKey/#IncludeSegmentonesignal://AppID@APIKey/EmailOpsgenieopsgenie://(TCP) 443opsgenie://APIKeyopsgenie://APIKey/UserIDopsgenie://APIKey/#Teamopsgenie://APIKey/*Scheduleopsgenie://APIKey/^EscalationPagerDutypagerduty://(TCP) 443pagerduty://IntegrationKey@ApiKeypagerduty://IntegrationKey@ApiKey/Source/ComponentPagerTreepagertree://(TCP) 443pagertree://integration_idParsePlatformparsep:// or parseps://(TCP) 80 or 443parsep://AppID:MasterKey@Hostnameparseps://AppID:MasterKey@HostnamePopcornNotifypopcorn://(TCP) 443popcorn://ApiKey/ToPhoneNopopcorn://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/popcorn://ApiKey/ToEmailpopcorn://ApiKey/ToEmail1/ToEmail2/ToEmailN/popcorn://ApiKey/ToPhoneNo1/ToEmail1/ToPhoneNoN/ToEmailNProwlprowl://(TCP) 443prowl://apikeyprowl://apikey/providerkeyPushBulletpbul://(TCP) 443pbul://accesstokenpbul://accesstoken/#channelpbul://accesstoken/A_DEVICE_IDpbul://accesstoken/email@address.compbul://accesstoken/#channel/#channel2/email@address.net/DEVICEPushjetpjet:// or pjets://(TCP) 80 or 443pjet://hostname/secretpjet://hostname:port/secretpjets://secret@hostname/secretpjets://hostname:port/secretPush (Techulus)push://(TCP) 443push://apikey/Pushedpushed://(TCP) 443pushed://appkey/appsecret/pushed://appkey/appsecret/#ChannelAliaspushed://appkey/appsecret/#ChannelAlias1/#ChannelAlias2/#ChannelAliasNpushed://appkey/appsecret/@UserPushedIDpushed://appkey/appsecret/@UserPushedID1/@UserPushedID2/@UserPushedIDNPushMepushme://(TCP) 443pushme://Token/Pushoverpover://(TCP) 443pover://user@tokenpover://user@token/DEVICEpover://user@token/DEVICE1/DEVICE2/DEVICENNote: you must specify both your user_id and tokenPushSaferpsafer:// or psafers://(TCP) 80 or 443psafer://privatekeypsafers://privatekey/DEVICEpsafer://privatekey/DEVICE1/DEVICE2/DEVICENPushypushy://(TCP) 443pushy://apikey/DEVICEpushy://apikey/DEVICE1/DEVICE2/DEVICENpushy://apikey/TOPICpushy://apikey/TOPIC1/TOPIC2/TOPICNPushDeerpushdeer:// or pushdeers://(TCP) 80 or 443pushdeer://pushKeypushdeer://hostname/pushKeypushdeer://hostname:port/pushKeyRedditreddit://(TCP) 443reddit://user:password@app_id/app_secret/subredditreddit://user:password@app_id/app_secret/sub1/sub2/subNRocket.Chatrocket:// or rockets://(TCP) 80 or 443rocket://user:password@hostname/RoomID/Channelrockets://user:password@hostname:443/#Channel1/#Channel1/RoomIDrocket://user:password@hostname/#Channelrocket://webhook@hostnamerockets://webhook@hostname/@User/#ChannelRSyslogrsyslog://(UDP) 514rsyslog://hostnamersyslog://hostname/FacilityRyverryver://(TCP) 443ryver://Organization/Tokenryver://botname@Organization/TokenSendGridsendgrid://(TCP) 443sendgrid://APIToken:FromEmail/sendgrid://APIToken:FromEmail/ToEmailsendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/ServerChanschan://(TCP) 443schan://sendkey/Signal APIsignal://  or signals://(TCP) 80 or 443signal://hostname:port/FromPhoneNosignal://hostname:port/FromPhoneNo/ToPhoneNosignal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/SimplePushspush://(TCP) 443spush://apikeyspush://salt:password@apikeyspush://apikey?event=AppriseSlackslack://(TCP) 443slack://TokenA/TokenB/TokenC/slack://TokenA/TokenB/TokenC/Channelslack://botname@TokenA/TokenB/TokenC/Channelslack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelNSMTP2Gosmtp2go://(TCP) 443smtp2go://user@hostname/apikeysmtp2go://user@hostname/apikey/emailsmtp2go://user@hostname/apikey/email1/email2/emailNsmtp2go://user@hostname/apikey/?name="From%20User"Streamlabsstrmlabs://(TCP) 443strmlabs://AccessToken/strmlabs://AccessToken/?name=name&identifier=identifier&amount=0&currency=USDSparkPostsparkpost://(TCP) 443sparkpost://user@hostname/apikeysparkpost://user@hostname/apikey/emailsparkpost://user@hostname/apikey/email1/email2/emailNsparkpost://user@hostname/apikey/?name="From%20User"Synology Chatsynology:// or synologys://(TCP) 80 or 443synology://hostname/tokensynology://hostname:port/tokenSyslogsyslog://n/asyslog://syslog://FacilityTelegramtgram://(TCP) 443tgram://bottoken/ChatIDtgram://bottoken/ChatID1/ChatID2/ChatIDNTwittertwitter://(TCP) 443twitter://CKey/CSecret/AKey/ASecrettwitter://user@CKey/CSecret/AKey/ASecrettwitter://CKey/CSecret/AKey/ASecret/User1/User2/User2twitter://CKey/CSecret/AKey/ASecret?mode=tweetTwisttwist://(TCP) 443twist://pasword:logintwist://password:login/#channeltwist://password:login/#team:channeltwist://password:login/#team:channel1/channel2/#team3:channelXBMCxbmc:// or xbmcs://(TCP) 8080 or 443xbmc://hostnamexbmc://user@hostnamexbmc://user:password@hostname:portWebex Teams (Cisco)wxteams://(TCP) 443wxteams://TokenWeCom Botwecombot://(TCP) 443wecombot://BotKeyWhatsAppwhatsapp://(TCP) 443whatsapp://AccessToken@FromPhoneID/ToPhoneNowhatsapp://Template:AccessToken@FromPhoneID/ToPhoneNoZulip Chatzulip://(TCP) 443zulip://botname@Organization/Tokenzulip://botname@Organization/Token/Streamzulip://botname@Organization/Token/EmailSMS NotificationsNotification ServiceService IDDefault PortExample SyntaxAutomated Packet Reporting System (ARPS)aprs://(TCP) 10152aprs://user:pass@callsignaprs://user:pass@callsign1/callsign2/callsignNAWS SNSsns://(TCP) 443sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNosns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo1/+PhoneNo2/+PhoneNoNsns://AccessKeyID/AccessSecretKey/RegionName/Topicsns://AccessKeyID/AccessSecretKey/RegionName/Topic1/Topic2/TopicNBulkSMSbulksms://(TCP) 443bulksms://user:password@ToPhoneNobulksms://User:Password@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/BulkVSbulkvs://(TCP) 443bulkvs://user:password@FromPhoneNobulkvs://user:password@FromPhoneNo/ToPhoneNobulkvs://user:password@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Burst SMSburstsms://(TCP) 443burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNoburstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Burst SMSburstsms://(TCP) 443burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNoburstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/ClickSendclicksend://(TCP) 443clicksend://user:pass@PhoneNoclicksend://user:pass@ToPhoneNo1/ToPhoneNo2/ToPhoneNoNDAPNETdapnet://(TCP) 80dapnet://user:pass@callsigndapnet://user:pass@callsign1/callsign2/callsignND7 Networksd7sms://(TCP) 443d7sms://token@PhoneNod7sms://token@ToPhoneNo1/ToPhoneNo2/ToPhoneNoNDingTalkdingtalk://(TCP) 443dingtalk://token/dingtalk://token/ToPhoneNodingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/httpSMShttpsms://(TCP) 443httpsms://ApiKey@FromPhoneNohttpsms://ApiKey@FromPhoneNo/ToPhoneNohttpsms://ApiKey@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Kavenegarkavenegar://(TCP) 443kavenegar://ApiKey/ToPhoneNokavenegar://FromPhoneNo@ApiKey/ToPhoneNokavenegar://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoNMessageBirdmsgbird://(TCP) 443msgbird://ApiKey/FromPhoneNomsgbird://ApiKey/FromPhoneNo/ToPhoneNomsgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/MSG91msg91://(TCP) 443msg91://TemplateID@AuthKey/ToPhoneNomsg91://TemplateID@AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Signal APIsignal://  or signals://(TCP) 80 or 443signal://hostname:port/FromPhoneNosignal://hostname:port/FromPhoneNo/ToPhoneNosignal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Sinchsinch://(TCP) 443sinch://ServicePlanId:ApiToken@FromPhoneNosinch://ServicePlanId:ApiToken@FromPhoneNo/ToPhoneNosinch://ServicePlanId:ApiToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/sinch://ServicePlanId:ApiToken@ShortCode/ToPhoneNosinch://ServicePlanId:ApiToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/SMSEaglesmseagle:// or smseagles://(TCP) 80 or 443smseagles://hostname:port/ToPhoneNosmseagles://hostname:port/@ToContactsmseagles://hostname:port/#ToGroupsmseagles://hostname:port/ToPhoneNo1/#ToGroup/@ToContact/SMS Managersmsmgr://(TCP) 443smsmgr://ApiKey@ToPhoneNosmsmgr://ApiKey@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Threema Gatewaythreema://(TCP) 443threema://GatewayID@secret/ToPhoneNothreema://GatewayID@secret/ToEmailthreema://GatewayID@secret/ToThreemaID/threema://GatewayID@secret/ToEmail/ToThreemaID/ToPhoneNo/...Twiliotwilio://(TCP) 443twilio://AccountSid:AuthToken@FromPhoneNotwilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNotwilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo?apikey=Keytwilio://AccountSid:AuthToken@ShortCode/ToPhoneNotwilio://AccountSid:AuthToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Voipmsvoipms://(TCP) 443voipms://password:email/FromPhoneNovoipms://password:email/FromPhoneNo/ToPhoneNovoipms://password:email/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Vonage(formerly Nexmo)nexmo://(TCP) 443nexmo://ApiKey:ApiSecret@FromPhoneNonexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNonexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/Desktop NotificationsNotification ServiceService IDDefault PortExample SyntaxLinux DBus Notificationsdbus://qt://glib://kde://n/adbus://qt://glib://kde://Linux Gnome Notificationsgnome://n/agnome://MacOS X Notificationsmacosx://n/amacosx://Windows Notificationswindows://n/awindows://Email NotificationsService IDDefault PortExample Syntaxmailto://(TCP) 25mailto://userid:pass@domain.commailto://domain.com?user=userid&pass=passwordmailto://domain.com:2525?user=userid&pass=passwordmailto://user@gmail.com&pass=passwordmailto://mySendingUsername:mySendingPassword@example.com?to=receivingAddress@example.commailto://userid:password@example.com?smtp=mail.example.com&from=noreply@example.com&name=no%20replymailtos://(TCP) 587mailtos://userid:pass@domain.commailtos://domain.com?user=userid&pass=passwordmailtos://domain.com:465?user=userid&pass=passwordmailtos://user@hotmail.com&pass=passwordmailtos://mySendingUsername:mySendingPassword@example.com?to=receivingAddress@example.commailtos://userid:password@example.com?smtp=mail.example.com&from=noreply@example.com&name=no%20replyApprise have some email services built right into it (such as yahoo, fastmail, hotmail, gmail, etc) that greatly simplify the mailto:// service.  See more detailshere.Custom NotificationsPost MethodService IDDefault PortExample SyntaxFormform:// or forms://(TCP) 80 or 443form://hostnameform://user@hostnameform://user:password@hostname:portform://hostname/a/path/to/post/toJSONjson:// or jsons://(TCP) 80 or 443json://hostnamejson://user@hostnamejson://user:password@hostname:portjson://hostname/a/path/to/post/toXMLxml:// or xmls://(TCP) 80 or 443xml://hostnamexml://user@hostnamexml://user:password@hostname:portxml://hostname/a/path/to/post/toInstallationThe easiest way is to install this package is from pypi:pipinstallappriseApprise is also packaged as an RPM and available throughEPELsupporting CentOS, Redhat, Rocky, Oracle Linux, etc.# Follow instructions on https://docs.fedoraproject.org/en-US/epel# to get your system connected up to EPEL and then:# Redhat/CentOS 7.x usersyuminstallapprise# Redhat/CentOS 8.x+ and/or Fedora UsersdnfinstallappriseYou can also check out theGraphical version of Appriseto centralize your configuration and notifications through a managable webpage.Command Line UsageA small command line interface (CLI) tool is also provided with this package calledapprise. 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:# 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:mypass@gmail.com'\'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:mypass@gmail.com'# The title field is totally optionaluptime|apprise-vv\'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'CLI Configuration FilesNo one wants to put their credentials out for everyone to see on the command line.  No problemapprisealso supports configuration files.  It can handle both a specificYAML formator a very simpleTEXT format. You can also pull these configuration files via an HTTP query too! You can read more about the expected structure of the configuration fileshere.# By default if no url or configuration is specified apprise will attempt to load# configuration files (if present) from:#  ~/.apprise#  ~/.apprise.yml#  ~/.config/apprise#  ~/.config/apprise.yml#  /etc/apprise#  /etc/apprise.yml# Also a subdirectory handling allows you to leverage plugins#  ~/.apprise/apprise#  ~/.apprise/apprise.yml#  ~/.config/apprise/apprise#  ~/.config/apprise/apprise.yml#  /etc/apprise/apprise#  /etc/apprise/apprise.yml# Windows users can store their default configuration files here:#  %APPDATA%/Apprise/apprise#  %APPDATA%/Apprise/apprise.yml#  %LOCALAPPDATA%/Apprise/apprise#  %LOCALAPPDATA%/Apprise/apprise.yml#  %ALLUSERSPROFILE%\Apprise\apprise#  %ALLUSERSPROFILE%\Apprise\apprise.yml#  %PROGRAMFILES%\Apprise\apprise#  %PROGRAMFILES%\Apprise\apprise.yml#  %COMMONPROGRAMFILES%\Apprise\apprise#  %COMMONPROGRAMFILES%\Apprise\apprise.yml# 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/configCLI File AttachmentsApprise also supports file attachments too! Specify as many attachments to a notification as you want.# Send a funny image you found on the internet to a colleague:apprise-vv--title'Agile Joke'\--body'Did you see this one yet?'\--attachhttps://i.redd.it/my2t4d2fx0u31.jpg\'mailto://myemail:mypass@gmail.com'# Easily send an update from a critical server to your dev teamapprise-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\--tagdevteamCLI Loading Custom Notifications/HooksTo create your own customschema://hook so that you can trigger your own custom code,
simply include the@notifydecorator to wrap your function.fromapprise.decoratorsimportnotify## The below assumes you want to catch foobar:// calls:#@notify(on="foobar",name="My Custom Foobar Plugin")defmy_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 SuccessOnce you've defined your custom hook, you just need to tell Apprise where it is at runtime.# 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 soapprise-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 hookshere.Developer API UsageTo send a notification from within your python application, just do the following:importapprise# Create an Apprise instanceapobj=apprise.Apprise()# Add all of the notification services by their server url.# A sample email notification:apobj.add('mailto://myuserid:mypass@gmail.com')# A sample pushbullet notificationapobj.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 FilesDevelopers need access to configuration files too. The good news is their use just involves declaring another object (calledAppriseConfig) that theAppriseobject 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 fileshere.importapprise# Create an Apprise instanceapobj=apprise.Apprise()# Create an Config instanceconfig=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 objectapobj.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 notificationapobj.add('mailto://myuser:mypass@hotmail.com',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' tagtag='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 AttachmentsAttachments are very easy to send using the Apprise API:importapprise# Create an Apprise instanceapobj=apprise.Apprise()# Add at least one service you want to notifyapobj.add('mailto://myuser:mypass@hotmail.com')# 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:importapprise# Create an Apprise instanceapobj=apprise.Apprise()# Add at least one service you want to notifyapobj.add('mailto://myuser:mypass@hotmail.com')# 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/HooksBy 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 theAppriseAsset()object prior to the initialization of yourApprise()instance.For example:fromappriseimportApprisefromappriseimportAppriseAsset# 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 doaobj=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 pointaobj.add('foobar://')# Send our notification out through our foobar://aobj.notify("test")You can read more about creating your own custom notifications and/or hookshere.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🛠️Development API🔧Troubleshooting⚙️Configuration File Help⚡Create Your Own Custom Notifications🌎Apprise API/Web Interface🎉ShowcaseWant to help make Apprise better?💡Contribute to the Apprise Code Base❤️Sponsorship and Donations