# Instalação e Configuração Apprise

# Instalação Apprise

Link: [https://github.com/caronc/apprise#productivity-based-notifications](https://github.com/caronc/apprise#productivity-based-notifications) git clone [https://github.com/caronc/apprise.git](https://github.com/caronc/apprise.git)

[![apprise-logo.png](https://capacita.siteinternet.com.br/uploads/images/gallery/2025-06/scaled-1680-/apprise-logo.png)](https://capacita.siteinternet.com.br/uploads/images/gallery/2025-06/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://camo.githubusercontent.com/ffcaf1a17e71089b9cbd4f7a513d86528a92e7ee83ad03b9e681e9f0b9420c06/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d646f6e6174652d677265656e2e737667)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MHANV39UZNQ5E) [![Follow](https://camo.githubusercontent.com/509702286b0bfee64c2640fc13691793ca709ef0381bcfc6e2d228f3e6faaf2f/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f6c32676e7578)](https://twitter.com/l2gnux/)  
[![Discord](https://camo.githubusercontent.com/9a69a543637051969c320397d5b74d63582f4122a9b32e2d8d76af5a20f3af6a/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3535383739333730333335363130343732342e7376673f636f6c6f72423d373238394441266c6162656c3d446973636f7264266c6f676f3d446973636f7264266c6f676f436f6c6f723d373238394441267374796c653d666c61742d737175617265)](https://discord.gg/MMPeN2D) [![Python](https://camo.githubusercontent.com/df4d9591fac3d9d5c38579a4d99df303bde129bdca36df9c1b6015ca6c42e8b7/68747470733a2f2f696d672e736869656c64732e696f2f707970692f707976657273696f6e732f617070726973652e7376673f7374796c653d666c61742d737175617265)](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://camo.githubusercontent.com/da3546b0e1b8e4fc278f83ab7338ba277a2b158c74ae8fa3cfef923f76211a54/68747470733a2f2f636f6465636f762e696f2f6769746875622f6361726f6e632f617070726973652f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/github/caronc/apprise) [![PyPi Downloads](https://camo.githubusercontent.com/bbda34f569d0d7008c8abcc7d6f0e3d9733cd8d83daebd207b274211052533f1/68747470733a2f2f696d672e736869656c64732e696f2f706570792f64742f617070726973652e7376673f7374796c653d666c61742d737175617265)](https://pypi.org/project/apprise/)

# Table of Contents

<div class="markdown-heading" dir="auto" id="bkmrk--3" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#table-of-contents)</div>- [Supported Notifications](https://github.com/caronc/apprise#supported-notifications)
    - [Productivity Based Notifications](https://github.com/caronc/apprise#productivity-based-notifications)
    - [SMS Notifications](https://github.com/caronc/apprise#sms-notifications)
    - [Desktop Notifications](https://github.com/caronc/apprise#desktop-notifications)
    - [Email Notifications](https://github.com/caronc/apprise#email-notifications)
    - [Custom Notifications](https://github.com/caronc/apprise#custom-notifications)
- [Installation](https://github.com/caronc/apprise#installation)
- [Command Line Usage](https://github.com/caronc/apprise#command-line-usage)
    - [Configuration Files](https://github.com/caronc/apprise#cli-configuration-files)
    - [File Attachments](https://github.com/caronc/apprise#cli-file-attachments)
    - [Loading Custom Notifications/Hooks](https://github.com/caronc/apprise#cli-loading-custom-notificationshooks)
    - [Environment Variables](https://github.com/caronc/apprise#cli-environment-variables)
- [Developer API Usage](https://github.com/caronc/apprise#developer-api-usage)
    - [Configuration Files](https://github.com/caronc/apprise#api-configuration-files)
    - [File Attachments](https://github.com/caronc/apprise#api-file-attachments)
    - [Loading Custom Notifications/Hooks](https://github.com/caronc/apprise#api-loading-custom-notificationshooks)
- [Persistent Storage](https://github.com/caronc/apprise#persistent-storage)
- [More Supported Links and Documentation](https://github.com/caronc/apprise#want-to-learn-more)

# Supported Notifications

<div class="markdown-heading" dir="auto" id="bkmrk--5" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#supported-notifications)</div>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

<div class="markdown-heading" dir="auto" id="bkmrk--7" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#productivity-based-notifications)</div>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.

<table id="bkmrk-notification-service" tabindex="0"><thead><tr><th>Notification Service</th><th>Service ID</th><th>Default Port</th><th>Example Syntax</th></tr></thead><tbody><tr><td>[Apprise API](https://github.com/caronc/apprise/wiki/Notify_apprise_api)</td><td>apprise:// or apprises://</td><td>(TCP) 80 or 443</td><td>apprise://hostname/Token</td></tr><tr><td>[AWS SES](https://github.com/caronc/apprise/wiki/Notify_ses)</td><td>ses://</td><td>(TCP) 443</td><td>ses://user@domain/AccessKeyID/AccessSecretKey/RegionName  
ses://user@domain/AccessKeyID/AccessSecretKey/RegionName/email1/email2/emailN</td></tr><tr><td>[Bark](https://github.com/caronc/apprise/wiki/Notify_bark)</td><td>bark://</td><td>(TCP) 80 or 443</td><td>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</td></tr><tr><td>[BlueSky](https://github.com/caronc/apprise/wiki/Notify_bluesky)</td><td>bluesky://</td><td>(TCP) 443</td><td>bluesky://Handle:AppPw  
bluesky://Handle:AppPw/TargetHandle  
bluesky://Handle:AppPw/TargetHandle1/TargetHandle2/TargetHandleN</td></tr><tr><td>[Chanify](https://github.com/caronc/apprise/wiki/Notify_chanify)</td><td>chantify://</td><td>(TCP) 443</td><td>chantify://token</td></tr><tr><td>[Discord](https://github.com/caronc/apprise/wiki/Notify_discord)</td><td>discord://</td><td>(TCP) 443</td><td>discord://webhook\_id/webhook\_token  
discord://avatar@webhook\_id/webhook\_token</td></tr><tr><td>[Emby](https://github.com/caronc/apprise/wiki/Notify_emby)</td><td>emby:// or embys://</td><td>(TCP) 8096</td><td>emby://user@hostname/  
emby://user:password@hostname</td></tr><tr><td>[Enigma2](https://github.com/caronc/apprise/wiki/Notify_enigma2)</td><td>enigma2:// or enigma2s://</td><td>(TCP) 80 or 443</td><td>enigma2://hostname</td></tr><tr><td>[FCM](https://github.com/caronc/apprise/wiki/Notify_fcm)</td><td>fcm://</td><td>(TCP) 443</td><td>fcm://project@apikey/DEVICE\_ID  
fcm://project@apikey/#TOPIC  
fcm://project@apikey/DEVICE\_ID1/#topic1/#topic2/DEVICE\_ID2/</td></tr><tr><td>[Feishu](https://github.com/caronc/apprise/wiki/Notify_feishu)</td><td>feishu://</td><td>(TCP) 443</td><td>feishu://token</td></tr><tr><td>[Flock](https://github.com/caronc/apprise/wiki/Notify_flock)</td><td>flock://</td><td>(TCP) 443</td><td>flock://token  
flock://botname@token  
flock://app\_token/u:userid  
flock://app\_token/g:channel\_id  
flock://app\_token/u:userid/g:channel\_id</td></tr><tr><td>[Google Chat](https://github.com/caronc/apprise/wiki/Notify_googlechat)</td><td>gchat://</td><td>(TCP) 443</td><td>gchat://workspace/key/token</td></tr><tr><td>[Gotify](https://github.com/caronc/apprise/wiki/Notify_gotify)</td><td>gotify:// or gotifys://</td><td>(TCP) 80 or 443</td><td>gotify://hostname/token  
gotifys://hostname/token?priority=high</td></tr><tr><td>[Growl](https://github.com/caronc/apprise/wiki/Notify_growl)</td><td>growl://</td><td>(UDP) 23053</td><td>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</td></tr><tr><td>[Guilded](https://github.com/caronc/apprise/wiki/Notify_guilded)</td><td>guilded://</td><td>(TCP) 443</td><td>guilded://webhook\_id/webhook\_token  
guilded://avatar@webhook\_id/webhook\_token</td></tr><tr><td>[Home Assistant](https://github.com/caronc/apprise/wiki/Notify_homeassistant)</td><td>hassio:// or hassios://</td><td>(TCP) 8123 or 443</td><td>hassio://hostname/accesstoken  
hassio://user@hostname/accesstoken  
hassio://user:password@hostname:port/accesstoken  
hassio://hostname/optional/path/accesstoken</td></tr><tr><td>[IFTTT](https://github.com/caronc/apprise/wiki/Notify_ifttt)</td><td>ifttt://</td><td>(TCP) 443</td><td>ifttt://webhooksID/Event  
ifttt://webhooksID/Event1/Event2/EventN  
ifttt://webhooksID/Event1/?+Key=Value  
ifttt://webhooksID/Event1/?-Key=value1</td></tr><tr><td>[Join](https://github.com/caronc/apprise/wiki/Notify_join)</td><td>join://</td><td>(TCP) 443</td><td>join://apikey/device  
join://apikey/device1/device2/deviceN/  
join://apikey/group  
join://apikey/groupA/groupB/groupN  
join://apikey/DeviceA/groupA/groupN/DeviceN/</td></tr><tr><td>[KODI](https://github.com/caronc/apprise/wiki/Notify_kodi)</td><td>kodi:// or kodis://</td><td>(TCP) 8080 or 443</td><td>kodi://hostname  
kodi://user@hostname  
kodi://user:password@hostname:port</td></tr><tr><td>[Kumulos](https://github.com/caronc/apprise/wiki/Notify_kumulos)</td><td>kumulos://</td><td>(TCP) 443</td><td>kumulos://apikey/serverkey</td></tr><tr><td>[LaMetric Time](https://github.com/caronc/apprise/wiki/Notify_lametric)</td><td>lametric://</td><td>(TCP) 443</td><td>lametric://apikey@device\_ipaddr  
lametric://apikey@hostname:port  
lametric://client\_id@client\_secret</td></tr><tr><td>[Line](https://github.com/caronc/apprise/wiki/Notify_line)</td><td>line://</td><td>(TCP) 443</td><td>line://Token@User  
line://Token/User1/User2/UserN</td></tr><tr><td>[LunaSea](https://github.com/caronc/apprise/wiki/Notify_lunasea)</td><td>lunasea://</td><td>(TCP) 80 or 443</td><td>lunasea://user:pass@+FireBaseDevice/  
lunasea://user:pass@FireBaseUser/  
lunasea://user:pass@hostname/+FireBaseDevice/  
lunasea://user:pass@hostname/@FireBaseUser/</td></tr><tr><td>[Mailgun](https://github.com/caronc/apprise/wiki/Notify_mailgun)</td><td>mailgun://</td><td>(TCP) 443</td><td>mailgun://user@hostname/apikey  
mailgun://user@hostname/apikey/email  
mailgun://user@hostname/apikey/email1/email2/emailN  
mailgun://user@hostname/apikey/?name="From%20User"</td></tr><tr><td>[Mastodon](https://github.com/caronc/apprise/wiki/Notify_mastodon)</td><td>mastodon:// or mastodons://</td><td>(TCP) 80 or 443</td><td>mastodon://access\_key@hostname  
mastodon://access\_key@hostname/@user  
mastodon://access\_key@hostname/@user1/@user2/@userN</td></tr><tr><td>[Matrix](https://github.com/caronc/apprise/wiki/Notify_matrix)</td><td>matrix:// or matrixs://</td><td>(TCP) 80 or 443</td><td>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&amp;format=markdown</td></tr><tr><td>[Mattermost](https://github.com/caronc/apprise/wiki/Notify_mattermost)</td><td>mmost:// or mmosts://</td><td>(TCP) 8065</td><td>mmost://hostname/authkey  
mmost://hostname:80/authkey  
mmost://user@hostname:80/authkey  
mmost://hostname/authkey?channel=channel  
mmosts://hostname/authkey  
mmosts://user@hostname/authkey  
</td></tr><tr><td>[Microsoft Power Automate / Workflows (MSTeams)](https://github.com/caronc/apprise/wiki/Notify_workflows)</td><td>workflows://</td><td>(TCP) 443</td><td>workflows://WorkflowID/Signature/</td></tr><tr><td>[Microsoft Teams](https://github.com/caronc/apprise/wiki/Notify_msteams)</td><td>msteams://</td><td>(TCP) 443</td><td>msteams://TokenA/TokenB/TokenC/</td></tr><tr><td>[Misskey](https://github.com/caronc/apprise/wiki/Notify_misskey)</td><td>misskey:// or misskeys://</td><td>(TCP) 80 or 443</td><td>misskey://access\_token@hostname</td></tr><tr><td>[MQTT](https://github.com/caronc/apprise/wiki/Notify_mqtt)</td><td>mqtt:// or mqtts://</td><td>(TCP) 1883 or 8883</td><td>mqtt://hostname/topic  
mqtt://user@hostname/topic  
mqtts://user:pass@hostname:9883/topic</td></tr><tr><td>[Nextcloud](https://github.com/caronc/apprise/wiki/Notify_nextcloud)</td><td>ncloud:// or nclouds://</td><td>(TCP) 80 or 443</td><td>ncloud://adminuser:pass@host/User  
nclouds://adminuser:pass@host/User1/User2/UserN</td></tr><tr><td>[NextcloudTalk](https://github.com/caronc/apprise/wiki/Notify_nextcloudtalk)</td><td>nctalk:// or nctalks://</td><td>(TCP) 80 or 443</td><td>nctalk://user:pass@host/RoomId  
nctalks://user:pass@host/RoomId1/RoomId2/RoomIdN</td></tr><tr><td>[Notica](https://github.com/caronc/apprise/wiki/Notify_notica)</td><td>notica://</td><td>(TCP) 443</td><td>notica://Token/</td></tr><tr><td>[Notifiarr](https://github.com/caronc/apprise/wiki/Notify_notifiarr)</td><td>notifiarr://</td><td>(TCP) 443</td><td>notifiarr://apikey/#channel  
notifiarr://apikey/#channel1/#channel2/#channeln</td></tr><tr><td>[Notifico](https://github.com/caronc/apprise/wiki/Notify_notifico)</td><td>notifico://</td><td>(TCP) 443</td><td>notifico://ProjectID/MessageHook/</td></tr><tr><td>[ntfy](https://github.com/caronc/apprise/wiki/Notify_ntfy)</td><td>ntfy://</td><td>(TCP) 80 or 443</td><td>ntfy://topic/  
ntfys://topic/</td></tr><tr><td>[Office 365](https://github.com/caronc/apprise/wiki/Notify_office365)</td><td>o365://</td><td>(TCP) 443</td><td>o365://TenantID:AccountEmail/ClientID/ClientSecret  
o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail  
o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail1/TargetEmail2/TargetEmailN</td></tr><tr><td>[OneSignal](https://github.com/caronc/apprise/wiki/Notify_onesignal)</td><td>onesignal://</td><td>(TCP) 443</td><td>onesignal://AppID@APIKey/PlayerID  
onesignal://TemplateID:AppID@APIKey/UserID  
onesignal://AppID@APIKey/#IncludeSegment  
onesignal://AppID@APIKey/Email</td></tr><tr><td>[Opsgenie](https://github.com/caronc/apprise/wiki/Notify_opsgenie)</td><td>opsgenie://</td><td>(TCP) 443</td><td>opsgenie://APIKey  
opsgenie://APIKey/UserID  
opsgenie://APIKey/#Team  
opsgenie://APIKey/\*Schedule  
opsgenie://APIKey/^Escalation</td></tr><tr><td>[PagerDuty](https://github.com/caronc/apprise/wiki/Notify_pagerduty)</td><td>pagerduty://</td><td>(TCP) 443</td><td>pagerduty://IntegrationKey@ApiKey  
pagerduty://IntegrationKey@ApiKey/Source/Component</td></tr><tr><td>[PagerTree](https://github.com/caronc/apprise/wiki/Notify_pagertree)</td><td>pagertree://</td><td>(TCP) 443</td><td>pagertree://integration\_id</td></tr><tr><td>[ParsePlatform](https://github.com/caronc/apprise/wiki/Notify_parseplatform)</td><td>parsep:// or parseps://</td><td>(TCP) 80 or 443</td><td>parsep://AppID:MasterKey@Hostname  
parseps://AppID:MasterKey@Hostname</td></tr><tr><td>[PopcornNotify](https://github.com/caronc/apprise/wiki/Notify_popcornnotify)</td><td>popcorn://</td><td>(TCP) 443</td><td>popcorn://ApiKey/ToPhoneNo  
popcorn://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/  
popcorn://ApiKey/ToEmail  
popcorn://ApiKey/ToEmail1/ToEmail2/ToEmailN/  
popcorn://ApiKey/ToPhoneNo1/ToEmail1/ToPhoneNoN/ToEmailN</td></tr><tr><td>[Prowl](https://github.com/caronc/apprise/wiki/Notify_prowl)</td><td>prowl://</td><td>(TCP) 443</td><td>prowl://apikey  
prowl://apikey/providerkey</td></tr><tr><td>[PushBullet](https://github.com/caronc/apprise/wiki/Notify_pushbullet)</td><td>pbul://</td><td>(TCP) 443</td><td>pbul://accesstoken  
pbul://accesstoken/#channel  
pbul://accesstoken/A\_DEVICE\_ID  
pbul://accesstoken/<email@address.com>  
pbul://accesstoken/#channel/#channel2/<email@address.net>/DEVICE</td></tr><tr><td>[Pushjet](https://github.com/caronc/apprise/wiki/Notify_pushjet)</td><td>pjet:// or pjets://</td><td>(TCP) 80 or 443</td><td>pjet://hostname/secret  
pjet://hostname:port/secret  
pjets://secret@hostname/secret  
pjets://hostname:port/secret</td></tr><tr><td>[Push (Techulus)](https://github.com/caronc/apprise/wiki/Notify_techulus)</td><td>push://</td><td>(TCP) 443</td><td>push://apikey/</td></tr><tr><td>[Pushed](https://github.com/caronc/apprise/wiki/Notify_pushed)</td><td>pushed://</td><td>(TCP) 443</td><td>pushed://appkey/appsecret/  
pushed://appkey/appsecret/#ChannelAlias  
pushed://appkey/appsecret/#ChannelAlias1/#ChannelAlias2/#ChannelAliasN  
pushed://appkey/appsecret/@UserPushedID  
pushed://appkey/appsecret/@UserPushedID1/@UserPushedID2/@UserPushedIDN</td></tr><tr><td>[PushMe](https://github.com/caronc/apprise/wiki/Notify_pushme)</td><td>pushme://</td><td>(TCP) 443</td><td>pushme://Token/</td></tr><tr><td>[Pushover](https://github.com/caronc/apprise/wiki/Notify_pushover)</td><td>pover://</td><td>(TCP) 443</td><td>pover://user@token  
pover://user@token/DEVICE  
pover://user@token/DEVICE1/DEVICE2/DEVICEN  
**Note**: you must specify both your user\_id and token</td></tr><tr><td>[PushSafer](https://github.com/caronc/apprise/wiki/Notify_pushsafer)</td><td>psafer:// or psafers://</td><td>(TCP) 80 or 443</td><td>psafer://privatekey  
psafers://privatekey/DEVICE  
psafer://privatekey/DEVICE1/DEVICE2/DEVICEN</td></tr><tr><td>[Pushy](https://github.com/caronc/apprise/wiki/Notify_pushy)</td><td>pushy://</td><td>(TCP) 443</td><td>pushy://apikey/DEVICE  
pushy://apikey/DEVICE1/DEVICE2/DEVICEN  
pushy://apikey/TOPIC  
pushy://apikey/TOPIC1/TOPIC2/TOPICN</td></tr><tr><td>[PushDeer](https://github.com/caronc/apprise/wiki/Notify_pushdeer)</td><td>pushdeer:// or pushdeers://</td><td>(TCP) 80 or 443</td><td>pushdeer://pushKey  
pushdeer://hostname/pushKey  
pushdeer://hostname:port/pushKey</td></tr><tr><td>[Reddit](https://github.com/caronc/apprise/wiki/Notify_reddit)</td><td>reddit://</td><td>(TCP) 443</td><td>reddit://user:password@app\_id/app\_secret/subreddit  
reddit://user:password@app\_id/app\_secret/sub1/sub2/subN</td></tr><tr><td>[Resend](https://github.com/caronc/apprise/wiki/Notify_resend)</td><td>resend://</td><td>(TCP) 443</td><td>resend://APIToken:FromEmail/  
resend://APIToken:FromEmail/ToEmail  
resend://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/</td></tr><tr><td>[Revolt](https://github.com/caronc/apprise/wiki/Notify_Revolt)</td><td>revolt://</td><td>(TCP) 443</td><td>revolt://bottoken/ChannelID  
revolt://bottoken/ChannelID1/ChannelID2/ChannelIDN</td></tr><tr><td>[Rocket.Chat](https://github.com/caronc/apprise/wiki/Notify_rocketchat)</td><td>rocket:// or rockets://</td><td>(TCP) 80 or 443</td><td>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</td></tr><tr><td>[RSyslog](https://github.com/caronc/apprise/wiki/Notify_rsyslog)</td><td>rsyslog://</td><td>(UDP) 514</td><td>rsyslog://hostname  
rsyslog://hostname/Facility</td></tr><tr><td>[Ryver](https://github.com/caronc/apprise/wiki/Notify_ryver)</td><td>ryver://</td><td>(TCP) 443</td><td>ryver://Organization/Token  
ryver://botname@Organization/Token</td></tr><tr><td>[SendGrid](https://github.com/caronc/apprise/wiki/Notify_sendgrid)</td><td>sendgrid://</td><td>(TCP) 443</td><td>sendgrid://APIToken:FromEmail/  
sendgrid://APIToken:FromEmail/ToEmail  
sendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/</td></tr><tr><td>[ServerChan](https://github.com/caronc/apprise/wiki/Notify_serverchan)</td><td>schan://</td><td>(TCP) 443</td><td>schan://sendkey/</td></tr><tr><td>[Signal API](https://github.com/caronc/apprise/wiki/Notify_signal)</td><td>signal:// or signals://</td><td>(TCP) 80 or 443</td><td>signal://hostname:port/FromPhoneNo  
signal://hostname:port/FromPhoneNo/ToPhoneNo  
signal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[SimplePush](https://github.com/caronc/apprise/wiki/Notify_simplepush)</td><td>spush://</td><td>(TCP) 443</td><td>spush://apikey  
spush://salt:password@apikey  
spush://apikey?event=Apprise</td></tr><tr><td>[Slack](https://github.com/caronc/apprise/wiki/Notify_slack)</td><td>slack://</td><td>(TCP) 443</td><td>slack://TokenA/TokenB/TokenC/  
slack://TokenA/TokenB/TokenC/Channel  
slack://botname@TokenA/TokenB/TokenC/Channel  
slack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelN</td></tr><tr><td>[SMTP2Go](https://github.com/caronc/apprise/wiki/Notify_smtp2go)</td><td>smtp2go://</td><td>(TCP) 443</td><td>smtp2go://user@hostname/apikey  
smtp2go://user@hostname/apikey/email  
smtp2go://user@hostname/apikey/email1/email2/emailN  
smtp2go://user@hostname/apikey/?name="From%20User"</td></tr><tr><td>[SparkPost](https://github.com/caronc/apprise/wiki/Notify_sparkpost)</td><td>sparkpost://</td><td>(TCP) 443</td><td>sparkpost://user@hostname/apikey  
sparkpost://user@hostname/apikey/email  
sparkpost://user@hostname/apikey/email1/email2/emailN  
sparkpost://user@hostname/apikey/?name="From%20User"</td></tr><tr><td>[Splunk](https://github.com/caronc/apprise/wiki/Notify_splunk)</td><td>splunk:// or victorops:/</td><td>(TCP) 443</td><td>splunk://route\_key@apikey  
splunk://route\_key@apikey/entity\_id</td></tr><tr><td>[Streamlabs](https://github.com/caronc/apprise/wiki/Notify_streamlabs)</td><td>strmlabs://</td><td>(TCP) 443</td><td>strmlabs://AccessToken/  
strmlabs://AccessToken/?name=name&amp;identifier=identifier&amp;amount=0&amp;currency=USD</td></tr><tr><td>[Synology Chat](https://github.com/caronc/apprise/wiki/Notify_synology_chat)</td><td>synology:// or synologys://</td><td>(TCP) 80 or 443</td><td>synology://hostname/token  
synology://hostname:port/token</td></tr><tr><td>[Syslog](https://github.com/caronc/apprise/wiki/Notify_syslog)</td><td>syslog://</td><td>n/a</td><td>syslog://  
syslog://Facility</td></tr><tr><td>[Telegram](https://github.com/caronc/apprise/wiki/Notify_telegram)</td><td>tgram://</td><td>(TCP) 443</td><td>tgram://bottoken/ChatID  
tgram://bottoken/ChatID1/ChatID2/ChatIDN</td></tr><tr><td>[Twitter](https://github.com/caronc/apprise/wiki/Notify_twitter)</td><td>twitter://</td><td>(TCP) 443</td><td>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</td></tr><tr><td>[Twist](https://github.com/caronc/apprise/wiki/Notify_twist)</td><td>twist://</td><td>(TCP) 443</td><td>twist://pasword:login  
twist://password:login/#channel  
twist://password:login/#team:channel  
twist://password:login/#team:channel1/channel2/#team3:channel</td></tr><tr><td>[Webex Teams (Cisco)](https://github.com/caronc/apprise/wiki/Notify_wxteams)</td><td>wxteams://</td><td>(TCP) 443</td><td>wxteams://Token</td></tr><tr><td>[WeCom Bot](https://github.com/caronc/apprise/wiki/Notify_wecombot)</td><td>wecombot://</td><td>(TCP) 443</td><td>wecombot://BotKey</td></tr><tr><td>[WhatsApp](https://github.com/caronc/apprise/wiki/Notify_whatsapp)</td><td>whatsapp://</td><td>(TCP) 443</td><td>whatsapp://AccessToken@FromPhoneID/ToPhoneNo  
whatsapp://Template:AccessToken@FromPhoneID/ToPhoneNo</td></tr><tr><td>[WxPusher](https://github.com/caronc/apprise/wiki/Notify_wxpusher)</td><td>wxpusher://</td><td>(TCP) 443</td><td>wxpusher://AppToken@UserID1/UserID2/UserIDN  
wxpusher://AppToken@Topic1/Topic2/Topic3  
wxpusher://AppToken@UserID1/Topic1/</td></tr><tr><td>[XBMC](https://github.com/caronc/apprise/wiki/Notify_xbmc)</td><td>xbmc:// or xbmcs://</td><td>(TCP) 8080 or 443</td><td>xbmc://hostname  
xbmc://user@hostname  
xbmc://user:password@hostname:port</td></tr><tr><td>[Zulip Chat](https://github.com/caronc/apprise/wiki/Notify_zulip)</td><td>zulip://</td><td>(TCP) 443</td><td>zulip://botname@Organization/Token  
zulip://botname@Organization/Token/Stream  
zulip://botname@Organization/Token/Email</td></tr></tbody></table>

## SMS Notifications

<div class="markdown-heading" dir="auto" id="bkmrk--9" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#sms-notifications)</div>SMS Notifications for the most part do not have a both a `title` and `body`. They consist of a single `body` which is usually no more then 160 characters in length. When using Apprise, the `title` and `body` are therefore combined into a single message prior to their transmission.

<table id="bkmrk-notification-service-1"><thead><tr><th>Notification Service</th><th>Service ID</th><th>Default Port</th><th>Example Syntax</th></tr></thead><tbody><tr><td>[Africas Talking](https://github.com/caronc/apprise/wiki/Notify_africas_talking)</td><td>atalk://</td><td>(TCP) 443</td><td>atalk://AppUser@ApiKey/ToPhoneNo  
atalk://AppUser@ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Automated Packet Reporting System (ARPS)](https://github.com/caronc/apprise/wiki/Notify_aprs)</td><td>aprs://</td><td>(TCP) 10152</td><td>aprs://user:pass@callsign  
aprs://user:pass@callsign1/callsign2/callsignN</td></tr><tr><td>[AWS SNS](https://github.com/caronc/apprise/wiki/Notify_sns)</td><td>sns://</td><td>(TCP) 443</td><td>sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo  
sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo1/+PhoneNo2/+PhoneNoN  
sns://AccessKeyID/AccessSecretKey/RegionName/Topic  
sns://AccessKeyID/AccessSecretKey/RegionName/Topic1/Topic2/TopicN</td></tr><tr><td>[BulkSMS](https://github.com/caronc/apprise/wiki/Notify_bulksms)</td><td>bulksms://</td><td>(TCP) 443</td><td>bulksms://user:password@ToPhoneNo  
bulksms://User:Password@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[BulkVS](https://github.com/caronc/apprise/wiki/Notify_bulkvs)</td><td>bulkvs://</td><td>(TCP) 443</td><td>bulkvs://user:password@FromPhoneNo  
bulkvs://user:password@FromPhoneNo/ToPhoneNo  
bulkvs://user:password@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Burst SMS](https://github.com/caronc/apprise/wiki/Notify_burst_sms)</td><td>burstsms://</td><td>(TCP) 443</td><td>burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo  
burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[ClickSend](https://github.com/caronc/apprise/wiki/Notify_clicksend)</td><td>clicksend://</td><td>(TCP) 443</td><td>clicksend://user:pass@PhoneNo  
clicksend://user:pass@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN</td></tr><tr><td>[DAPNET](https://github.com/caronc/apprise/wiki/Notify_dapnet)</td><td>dapnet://</td><td>(TCP) 80</td><td>dapnet://user:pass@callsign  
dapnet://user:pass@callsign1/callsign2/callsignN</td></tr><tr><td>[D7 Networks](https://github.com/caronc/apprise/wiki/Notify_d7networks)</td><td>d7sms://</td><td>(TCP) 443</td><td>d7sms://token@PhoneNo  
d7sms://token@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN</td></tr><tr><td>[DingTalk](https://github.com/caronc/apprise/wiki/Notify_dingtalk)</td><td>dingtalk://</td><td>(TCP) 443</td><td>dingtalk://token/  
dingtalk://token/ToPhoneNo  
dingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/</td></tr><tr><td>[Free-Mobile](https://github.com/caronc/apprise/wiki/Notify_freemobile)</td><td>freemobile://</td><td>(TCP) 443</td><td>freemobile://user@password/</td></tr><tr><td>[httpSMS](https://github.com/caronc/apprise/wiki/Notify_httpsms)</td><td>httpsms://</td><td>(TCP) 443</td><td>httpsms://ApiKey@FromPhoneNo  
httpsms://ApiKey@FromPhoneNo/ToPhoneNo  
httpsms://ApiKey@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Kavenegar](https://github.com/caronc/apprise/wiki/Notify_kavenegar)</td><td>kavenegar://</td><td>(TCP) 443</td><td>kavenegar://ApiKey/ToPhoneNo  
kavenegar://FromPhoneNo@ApiKey/ToPhoneNo  
kavenegar://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN</td></tr><tr><td>[MessageBird](https://github.com/caronc/apprise/wiki/Notify_messagebird)</td><td>msgbird://</td><td>(TCP) 443</td><td>msgbird://ApiKey/FromPhoneNo  
msgbird://ApiKey/FromPhoneNo/ToPhoneNo  
msgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[MSG91](https://github.com/caronc/apprise/wiki/Notify_msg91)</td><td>msg91://</td><td>(TCP) 443</td><td>msg91://TemplateID@AuthKey/ToPhoneNo  
msg91://TemplateID@AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Plivo](https://github.com/caronc/apprise/wiki/Notify_plivo)</td><td>plivo://</td><td>(TCP) 443</td><td>plivo://AuthID@Token@FromPhoneNo  
plivo://AuthID@Token/FromPhoneNo/ToPhoneNo  
plivo://AuthID@Token/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Seven](https://github.com/caronc/apprise/wiki/Notify_seven)</td><td>seven://</td><td>(TCP) 443</td><td>seven://ApiKey/FromPhoneNo  
seven://ApiKey/FromPhoneNo/ToPhoneNo  
seven://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Société Française du Radiotéléphone (SFR)](https://github.com/caronc/apprise/wiki/Notify_sfr)</td><td>sfr://</td><td>(TCP) 443</td><td>sfr://user:password&gt;@spaceId/ToPhoneNo  
sfr://user:password&gt;@spaceId/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Signal API](https://github.com/caronc/apprise/wiki/Notify_signal)</td><td>signal:// or signals://</td><td>(TCP) 80 or 443</td><td>signal://hostname:port/FromPhoneNo  
signal://hostname:port/FromPhoneNo/ToPhoneNo  
signal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Sinch](https://github.com/caronc/apprise/wiki/Notify_sinch)</td><td>sinch://</td><td>(TCP) 443</td><td>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/</td></tr><tr><td>[SMSEagle](https://github.com/caronc/apprise/wiki/Notify_smseagle)</td><td>smseagle:// or smseagles://</td><td>(TCP) 80 or 443</td><td>smseagles://hostname:port/ToPhoneNo  
smseagles://hostname:port/@ToContact  
smseagles://hostname:port/#ToGroup  
smseagles://hostname:port/ToPhoneNo1/#ToGroup/@ToContact/</td></tr><tr><td>[SMS Manager](https://github.com/caronc/apprise/wiki/Notify_sms_manager)</td><td>smsmgr://</td><td>(TCP) 443</td><td>smsmgr://ApiKey@ToPhoneNo  
smsmgr://ApiKey@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Threema Gateway](https://github.com/caronc/apprise/wiki/Notify_threema)</td><td>threema://</td><td>(TCP) 443</td><td>threema://GatewayID@secret/ToPhoneNo  
threema://GatewayID@secret/ToEmail  
threema://GatewayID@secret/ToThreemaID/  
threema://GatewayID@secret/ToEmail/ToThreemaID/ToPhoneNo/...</td></tr><tr><td>[Twilio](https://github.com/caronc/apprise/wiki/Notify_twilio)</td><td>twilio://</td><td>(TCP) 443</td><td>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/</td></tr><tr><td>[Voipms](https://github.com/caronc/apprise/wiki/Notify_voipms)</td><td>voipms://</td><td>(TCP) 443</td><td>voipms://password:email/FromPhoneNo  
voipms://password:email/FromPhoneNo/ToPhoneNo  
voipms://password:email/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr><tr><td>[Vonage](https://github.com/caronc/apprise/wiki/Notify_nexmo) (formerly Nexmo)</td><td>nexmo://</td><td>(TCP) 443</td><td>nexmo://ApiKey:ApiSecret@FromPhoneNo  
nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo  
nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/</td></tr></tbody></table>

## Desktop Notifications

<div class="markdown-heading" dir="auto" id="bkmrk--11" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#desktop-notifications)</div><table id="bkmrk-notification-service-2"><thead><tr><th>Notification Service</th><th>Service ID</th><th>Default Port</th><th>Example Syntax</th></tr></thead><tbody><tr><td>[Linux DBus Notifications](https://github.com/caronc/apprise/wiki/Notify_dbus)</td><td>dbus://  
qt://  
glib://  
kde://</td><td>n/a</td><td>dbus://  
qt://  
glib://  
kde://</td></tr><tr><td>[Linux Gnome Notifications](https://github.com/caronc/apprise/wiki/Notify_gnome)</td><td>gnome://</td><td>n/a</td><td>gnome://</td></tr><tr><td>[MacOS X Notifications](https://github.com/caronc/apprise/wiki/Notify_macosx)</td><td>macosx://</td><td>n/a</td><td>macosx://</td></tr><tr><td>[Windows Notifications](https://github.com/caronc/apprise/wiki/Notify_windows)</td><td>windows://</td><td>n/a</td><td>windows://</td></tr></tbody></table>

## Email Notifications

<div class="markdown-heading" dir="auto" id="bkmrk--13" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#email-notifications)</div><table id="bkmrk-service-id-default-p"><thead><tr><th>Service ID</th><th>Default Port</th><th>Example Syntax</th></tr></thead><tbody><tr><td>[mailto://](https://github.com/caronc/apprise/wiki/Notify_email)</td><td>(TCP) 25</td><td>mailto://userid:<pass@domain.com>  
mailto://domain.com?user=userid&amp;pass=password  
mailto://domain.com:2525?user=userid&amp;pass=password  
mailto://<user@gmail.com>&amp;pass=password  
mailto://mySendingUsername:<mySendingPassword@example.com>?to=<receivingAddress@example.com>  
mailto://userid:<password@example.com>?smtp=mail.example.com&amp;from=<noreply@example.com>&amp;name=no%20reply</td></tr><tr><td>[mailtos://](https://github.com/caronc/apprise/wiki/Notify_email)</td><td>(TCP) 587</td><td>mailtos://userid:<pass@domain.com>  
mailtos://domain.com?user=userid&amp;pass=password  
mailtos://domain.com:465?user=userid&amp;pass=password  
mailtos://<user@hotmail.com>&amp;pass=password  
mailtos://mySendingUsername:<mySendingPassword@example.com>?to=<receivingAddress@example.com>  
mailtos://userid:<password@example.com>?smtp=mail.example.com&amp;from=<noreply@example.com>&amp;name=no%20reply</td></tr></tbody></table>

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

<div class="markdown-heading" dir="auto" id="bkmrk--15" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#custom-notifications)</div><table id="bkmrk-post-method-service-"><thead><tr><th>Post Method</th><th>Service ID</th><th>Default Port</th><th>Example Syntax</th></tr></thead><tbody><tr><td>[Form](https://github.com/caronc/apprise/wiki/Notify_Custom_Form)</td><td>form:// or forms://</td><td>(TCP) 80 or 443</td><td>form://hostname  
form://user@hostname  
form://user:password@hostname:port  
form://hostname/a/path/to/post/to</td></tr><tr><td>[JSON](https://github.com/caronc/apprise/wiki/Notify_Custom_JSON)</td><td>json:// or jsons://</td><td>(TCP) 80 or 443</td><td>json://hostname  
json://user@hostname  
json://user:password@hostname:port  
json://hostname/a/path/to/post/to</td></tr><tr><td>[XML](https://github.com/caronc/apprise/wiki/Notify_Custom_XML)</td><td>xml:// or xmls://</td><td>(TCP) 80 or 443</td><td>xml://hostname  
xml://user@hostname  
xml://user:password@hostname:port  
xml://hostname/a/path/to/post/to</td></tr></tbody></table>

# Installation

<div class="markdown-heading" dir="auto" id="bkmrk--17" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#installation)</div>The easiest way is to install this package is from pypi:

```
pip install apprise
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--19" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>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.

```
# 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
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--20" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>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

<div class="markdown-heading" dir="auto" id="bkmrk--21" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#command-line-usage)</div>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:

```
# 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 optional
uptime | apprise -vv \
   'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--23" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>## CLI Configuration Files

<div class="markdown-heading" dir="auto" id="bkmrk--24" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#cli-configuration-files)</div>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).

```
# 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
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--26" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>## CLI File Attachments

<div class="markdown-heading" dir="auto" id="bkmrk--27" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#cli-file-attachments)</div>Apprise 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?' \
        --attach https://i.redd.it/my2t4d2fx0u31.jpg \
        'mailto://myemail:mypass@gmail.com'

# 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
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--29" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>## CLI Loading Custom Notifications/Hooks

<div class="markdown-heading" dir="auto" id="bkmrk--30" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#cli-loading-custom-notificationshooks)</div>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.

```
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
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--32" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>Once 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 so
apprise -vv --title 'custom override' \
        --body 'the body of my message' \
        --plugin-path /path/to/my/plugin.py \
        foobar:\\
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--33" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>You can read more about creating your own custom notifications and/or hooks [here](https://github.com/caronc/apprise/wiki/decorator_notify).

## CLI Environment Variables

<div class="markdown-heading" dir="auto" id="bkmrk--34" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#cli-environment-variables)</div>Those using the Command Line Interface (CLI) can also leverage environment variables to pre-set the default settings:

<table id="bkmrk-variable-description"><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td>`APPRISE_URLS`</td><td>Specify the default URLs to notify IF none are otherwise specified on the command line explicitly. If the `--config` (`-c`) is specified, then this will over-rides any reference to this variable. Use white space and/or a comma (`,`) to delimit multiple entries.</td></tr><tr><td>`APPRISE_CONFIG_PATH`</td><td>Explicitly specify the config search path to use (over-riding the default). The path(s) defined here must point to the absolute filename to open/reference. Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.</td></tr><tr><td>`APPRISE_PLUGIN_PATH`</td><td>Explicitly specify the custom plugin search path to use (over-riding the default). Use a semi-colon (`;`), line-feed (`\n`), and/or carriage return (`\r`) to delimit multiple entries.</td></tr><tr><td>`APPRISE_STORAGE_PATH`</td><td>Explicitly specify the persistent storage path to use (over-riding the default).</td></tr></tbody></table>

# Developer API Usage

<div class="markdown-heading" dir="auto" id="bkmrk--36" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#developer-api-usage)</div>To send a notification from within your python application, just do the following:

```
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:mypass@gmail.com')

# 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',
)
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--38" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>## API Configuration Files

<div class="markdown-heading" dir="auto" id="bkmrk--39" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#api-configuration-files)</div>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).

```
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: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' 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',
)
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--41" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>## API File Attachments

<div class="markdown-heading" dir="auto" id="bkmrk--42" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#api-file-attachments)</div>Attachments are very easy to send using the Apprise API:

```
import apprise

# Create an Apprise instance
apobj = apprise.Apprise()

# Add at least one service you want to notify
apobj.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'
)
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--44" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>To send more than one attachment, just use a list, set, or tuple instead:

```
import apprise

# Create an Apprise instance
apobj = apprise.Apprise()

# Add at least one service you want to notify
apobj.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,
)
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--45" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>## API Loading Custom Notifications/Hooks

<div class="markdown-heading" dir="auto" id="bkmrk--46" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#api-loading-custom-notificationshooks)</div>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:

```
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")
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--48" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>You can read more about creating your own custom notifications and/or hooks [here](https://github.com/caronc/apprise/wiki/decorator_notify).

# Persistent Storage

<div class="markdown-heading" dir="auto" id="bkmrk--49" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#persistent-storage)</div>Persistent storage allows Apprise to cache re-occurring actions optionaly to disk. This can greatly reduce the overhead used to send a notification.

There are 3 Persistent Storage operational states Apprise can operate using:

1. `auto`: Flush gathered cache information to the filesystem on demand. This option is incredibly light weight. This is the default behavior for all CLI usage. 
    - Developers who choose to use this operational mode can also force cached information manually if they choose.
    - The CLI will use this operational mode by default.
2. `flush`: Flushes any cache information to the filesystem during every transaction.
3. `memory`: Effectively disable Persistent Storage. Any caching of data required by each plugin used is done in memory. Apprise effectively operates as it always did before peristent storage was available. This setting ensures no content is every written to disk. 
    - By default this is the mode Apprise will operate under for those developing with it unless they configure it to otherwise operate as `auto` or `flush`. This is done through the `AppriseAsset()` object and is explained further on in this documentation.

## CLI Persistent Storage Commands

<div class="markdown-heading" dir="auto" id="bkmrk--51" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#cli-persistent-storage-commands)</div>You can provide the keyword `storage` on your CLI call to see the persistent storage options available to you.

```
# List all of the occupied space used by Apprise's Persistent Storage:
apprise storage list

# list is the default option, so the following does the same thing:
apprise storage

# You can prune all of your storage older then 30 days
# and not accessed for this period like so:
apprise storage prune

# You can do a hard reset (and wipe all persistent storage) with:
apprise storage clean
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--53" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>You can also filter your results by adding tags and/or URL Identifiers. When you get a listing (`apprise storage list`), you may see:

```
   # example output of 'apprise storage list':
   1. f7077a65                                             0.00B    unused
      - matrixs://abcdef:****@synapse.example12.com/%23general?image=no&mode=off&version=3&msgtype...
      tags: team

   2. 0e873a46                                            81.10B    active
      - tgram://W...U//?image=False&detect=yes&silent=no&preview=no&content=before&mdv=v1&format=m...
      tags: personal

   3. abcd123                                             12.00B    stale


```

<div class="snippet-clipboard-content notranslate position-relative overflow-auto" id="bkmrk--54" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>The (persistent storage) cache states are:

- `unused`: This plugin has not commited anything to disk for reuse/cache purposes
- `active`: This plugin has written content to disk. Or at the very least, it has prepared a persistent storage location it can write into.
- `stale`: The system detected a location where a URL may have possibly written to in the past, but there is nothing linking to it using the URLs provided. It is likely wasting space or is no longer of any use.

You can use this information to filter your results by specifying *URL ID* (UID) values after your command. For example:

```
# The below commands continue with the example already identified above
# the following would match abcd123 (even though just ab was provided)
# The output would only list the 'stale' entry above
apprise storage list ab

# knowing our filter is safe, we could remove it
# the below command would not obstruct our other to URLs and would only
# remove our stale one:
apprise storage clean ab

# Entries can be filtered by tag as well:
apprise storage list --tag=team

# You can match on multiple URL ID's as well:
# The followin would actually match the URL ID's of 1. and .2 above
apprise storage list f 0
```

<div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" id="bkmrk--55" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>When using the CLI, Persistent storage is set to the operational mode of `auto` by default, you can change this by providing `--storage-mode=` (`-SM`) during your calls. If you want to ensure it's always set to a value of your choice.

For more information on persistent storage, [visit here](https://github.com/caronc/apprise/wiki/persistent_storage).

## API Persistent Storage Commands

<div class="markdown-heading" dir="auto" id="bkmrk--56" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#api-persistent-storage-commands)</div>For developers, persistent storage is set in the operational mode of `memory` by default.

It's at the developers discretion to enable it (by switching it to either `auto` or `flush`). Should you choose to do so: it's as easy as including the information in the `AppriseAsset()` object prior to the initialization of your `Apprise()` instance.

For example:

```
from apprise import Apprise
from apprise import AppriseAsset
from apprise import PersistentStoreMode

# Prepare a location the persistent storage can write it's cached content to.
# By setting this path, this immediately assumes you wish to operate the
# persistent storage in the operational 'auto' mode
asset = AppriseAsset(storage_path="/path/to/save/data")

# If you want to be more explicit and set more options, then you may do the
# following
asset = AppriseAsset(
    # Set our storage path directory (minimum requirement to enable it)
    storage_path="/path/to/save/data",

    # Set the mode... the options are:
    # 1. PersistentStoreMode.MEMORY
    #       - disable persistent storage from writing to disk
    # 2. PersistentStoreMode.AUTO
    #       - write to disk on demand
    # 3. PersistentStoreMode.FLUSH
    #       - write to disk always and often
    storage_mode=PersistentStoreMode.FLUSH

    # The URL IDs are by default 8 characters in length. You can increase and
    # decrease it's value here.  The value must be > 2. The default value is 8
    # if not otherwise specified
    storage_idlen=8,
)

# Now that we've got our asset, we just work with our Apprise object as we
# normally do
aobj = Apprise(asset=asset)
```

<div class="highlight highlight-source-python notranslate position-relative overflow-auto" dir="auto" id="bkmrk--58" style="text-align: justify;"><div class="zeroclipboard-container">  
</div></div>For more information on persistent storage, [visit here](https://github.com/caronc/apprise/wiki/persistent_storage).

# Want To Learn More?

<div class="markdown-heading" dir="auto" id="bkmrk--59" style="text-align: justify;">[<svg aria-hidden="true" class="octicon octicon-link" height="16" version="1.1" viewbox="0 0 16 16" width="16"></svg>](https://github.com/caronc/apprise#want-to-learn-more)</div>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)
- 💾 [Persistent Storage](https://github.com/caronc/apprise/wiki/persistent_storage)
- 🌎 [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)