Repository: caronc/apprise

Stars: 16366

README.md Copy Chapter

!Apprise Logo

<hr/>

ap·prise / verb<br/>
To inform or tell (someone). To make one aware of something.
<hr/>

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.

<br/>

Table of Contents

Visit the Official Documentation site for more information on Apprise.

Supported Notifications

The section identifies all of the services supported by this library. Check out the wiki for more information on the supported modules here.

Productivity Based Notifications Copy Chapter

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. If you're having trouble constructing your own URL; try our Apprise URL Builder out.

| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| Apprise API | apprise:// or apprises:// | (TCP) 80 or 443 | apprise://hostname/Token
| AWS SES | ses:// | (TCP) 443 | ses://user@domain/AccessKeyID/AccessSecretKey/RegionName<br/>ses://user@domain/AccessKeyID/AccessSecretKey/RegionName/email1/email2/emailN
| Bark | bark:// | (TCP) 80 or 443 | bark://hostname<br />bark://hostname/device_key<br />bark://hostname/device_key1/device_key2/device_keyN<br/>barks://hostname<br />barks://hostname/device_key<br />barks://hostname/device_key1/device_key2/device_keyN
| Blink(1) | blink1:// | USB | blink1://<br />blink1://serial/
| BlueSky | bluesky:// | (TCP) 443 | bluesky://Handle:AppPw<br />bluesky://Handle:AppPw/TargetHandle<br />bluesky://Handle:AppPw/TargetHandle1/TargetHandle2/TargetHandleN
| Brevo | brevo:// | (TCP) 443 | brevo://APIToken:FromEmail/<br />brevo://APIToken:FromEmail/ToEmail<br />brevo://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
| Chanify | chantify:// | (TCP) 443 | chantify://token
| Discord | discord:// | (TCP) 443 | discord://webhook_id/webhook_token<br />discord://avatar@webhook_id/webhook_token
| Dot. | dot:// | (TCP) 443 | dot://apikey@device_id/text/<br />dot://apikey@device_id/image/<br />Note: device_id is the Quote/0 hardware serial
| Emby | emby:// or embys:// | (TCP) 8096 | emby://user@hostname/<br />emby://user:password@hostname
| Enigma2 | enigma2:// or enigma2s:// | (TCP) 80 or 443 | enigma2://hostname
| Evolution API | evolution:// or evolutions:// | (TCP) 80 or 443 | evolution://apikey@hostname/instance/ToPhoneNo<br/>evolution://apikey@hostname:port/instance/ToPhoneNo<br/>evolution://apikey@hostname/instance/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| FCM | fcm:// | (TCP) 443 | fcm://project@apikey/DEVICE_ID<br />fcm://project@apikey/#TOPIC<br/>fcm://project@apikey/DEVICE_ID1/#topic1/#topic2/DEVICE_ID2/
| Feishu | feishu:// | (TCP) 443 | feishu://token
| Flock | flock:// | (TCP) 443 | flock://token<br/>flock://botname@token<br/>flock://app_token/u:userid<br/>flock://app_token/g:channel_id<br/>flock://app_token/u:userid/g:channel_id
| Google Chat | gchat:// | (TCP) 443 | gchat://workspace/key/token
| Gotify | gotify:// or gotifys:// | (TCP) 80 or 443 | gotify://hostname/token<br />gotifys://hostname/token?priority=high
| Growl | growl:// | (UDP) 23053 | growl://hostname<br />growl://hostname:portno<br />growl://password@hostname<br />growl://password@hostname:port</br>Note: you can also use the get parameter _version_ which can allow the growl request to behave using the older v1.x protocol. An example would look like: growl://hostname?version=1
| Guilded | guilded:// | (TCP) 443 | guilded://webhook_id/webhook_token<br />guilded://avatar@webhook_id/webhook_token
| Home Assistant | hassio:// or hassios:// | (TCP) 8123 or 443 | hassio://hostname/accesstoken<br />hassio://user@hostname/accesstoken<br />hassio://user:password@hostname:port/accesstoken<br />hassio://hostname/optional/path/accesstoken
| IFTTT | ifttt:// | (TCP) 443 | ifttt://webhooksID/Event<br />ifttt://webhooksID/Event1/Event2/EventN<br/>ifttt://webhooksID/Event1/?+Key=Value<br/>ifttt://webhooksID/Event1/?-Key=value1
| IRC | irc:// or ircs:// | (TCP) 6667 or 6697 | ircs://user:[email protected]/@user<br /> ircs://user:[email protected]/#channel?join=true&mode=nickserv<br/>ircs://user:[email protected]/@user1/@user2/@user3/#channel1
| Jellyfin | jellyfin:// or jellyfins:// | (TCP) 8096 | jellyfin://user@hostname/<br />jellyfins://user:password@hostname
| Jira | jira:// | (TCP) 443 | jira://APIKey<br/>jira://APIKey/@UserID<br/>jira://APIKey/#Team<br/>jira://APIKey/\*Schedule<br/>jira://APIKey/^Escalation
| Join | join:// | (TCP) 443 | join://apikey/device<br />join://apikey/device1/device2/deviceN/<br />join://apikey/group<br />join://apikey/groupA/groupB/groupN<br />join://apikey/DeviceA/groupA/groupN/DeviceN/
| KODI | kodi:// or kodis:// | (TCP) 8080 or 443 | kodi://hostname<br />kodi://user@hostname<br />kodi://user:password@hostname:port
| Kumulos | kumulos:// | (TCP) 443 | kumulos://apikey/serverkey
| LaMetric Time | lametric:// | (TCP) 443 | lametric://apikey@device_ipaddr<br/>lametric://apikey@hostname:port<br/>lametric://client_id@client_secret
| Lark | lark:// | (TCP) 443 | lark://BotToken
| Line | line:// | (TCP) 443 | line://Token@User<br/>line://Token/User1/User2/UserN
| Mailgun | mailgun:// | (TCP) 443 | mailgun://user@hostname/apikey<br />mailgun://user@hostname/apikey/email<br />mailgun://user@hostname/apikey/email1/email2/emailN<br />mailgun://user@hostname/apikey/?name="From%20User"
| Mastodon | mastodon:// or mastodons://| (TCP) 80 or 443 | mastodon://access_key@hostname<br />mastodon://access_key@hostname/@user<br />mastodon://access_key@hostname/@user1/@user2/@userN
| Matrix | matrix:// or matrixs:// | (TCP) 80 or 443 | matrix://hostname<br />matrix://user@hostname<br />matrixs://user:pass@hostname:port/#room_alias<br />matrixs://user:pass@hostname:port/!room_id<br />matrixs://user:pass@hostname:port/#room_alias/!room_id/#room2<br />matrixs://token@hostname:port/?webhook=matrix<br />matrix://user:token@hostname/?webhook=slack&format=markdown
| Mattermost | mmost:// or mmosts:// | (TCP) 8065 | mmost://hostname/authkey<br />mmost://hostname:80/authkey<br />mmost://user@hostname:80/authkey<br />mmost://hostname/authkey?channel=channel<br />mmosts://hostname/authkey<br />mmosts://user@hostname/authkey<br />
| Microsoft Power Automate / Workflows (MSTeams) | workflows:// | (TCP) 443 | workflows://WorkflowID/Signature/
| Microsoft Teams | msteams:// | (TCP) 443 | msteams://TokenA/TokenB/TokenC/
| Misskey | misskey:// or misskeys://| (TCP) 80 or 443 | misskey://access_token@hostname
| MQTT | mqtt:// or mqtts:// | (TCP) 1883 or 8883 | mqtt://hostname/topic<br />mqtt://user@hostname/topic<br />mqtts://user:pass@hostname:9883/topic
| Nextcloud | ncloud:// or nclouds:// | (TCP) 80 or 443 | ncloud://adminuser:pass@host/User<br/>nclouds://adminuser:pass@host/User1/User2/UserN
| NextcloudTalk | nctalk:// or nctalks:// | (TCP) 80 or 443 | nctalk://user:pass@host/RoomId<br/>nctalks://user:pass@host/RoomId1/RoomId2/RoomIdN
| Notica | notica:// | (TCP) 443 | notica://Token/
| NotificationAPI | napi:// | (TCP) 443 | napi://ClientID/ClientSecret/Target<br />napi://ClientID/ClientSecret/Target1/Target2/TargetN<br />napi://MessageType@ClientID/ClientSecret/Target
| Notifiarr | notifiarr:// | (TCP) 443 | notifiarr://apikey/#channel<br />notifiarr://apikey/#channel1/#channel2/#channeln
| Notifico | notifico:// | (TCP) 443 | notifico://ProjectID/MessageHook/
| ntfy | ntfy:// | (TCP) 80 or 443 | ntfy://topic/<br/>ntfys://topic/
| Octopush | octopush:// | (TCP) 443 | octopush://APILogin/APIKey/TargetPhoneNo<br />octopush://Sender:APILogin/APIKey/TargetPhoneNo<br />octopush://Sender:APILogin/APIKey/TargetPhoneNo1/TargetPhoneNo2/TargetPhoneNoN
| Office 365 | o365:// | (TCP) 443 | o365://TenantID:AccountEmail/ClientID/ClientSecret<br />o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail<br />o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail1/TargetEmail2/TargetEmailN
| OneSignal | onesignal:// | (TCP) 443 | onesignal://AppID@APIKey/PlayerID<br/>onesignal://TemplateID:AppID@APIKey/UserID<br/>onesignal://AppID@APIKey/#IncludeSegment<br/>onesignal://AppID@APIKey/Email
| Opsgenie | opsgenie:// | (TCP) 443 | opsgenie://APIKey<br/>opsgenie://APIKey/UserID<br/>opsgenie://APIKey/#Team<br/>opsgenie://APIKey/\*Schedule<br/>opsgenie://APIKey/^Escalation
| PagerDuty | pagerduty:// | (TCP) 443 | pagerduty://IntegrationKey@ApiKey<br/>pagerduty://IntegrationKey@ApiKey/Source/Component
| PagerTree | pagertree:// | (TCP) 443 | pagertree://integration_id
| ParsePlatform | parsep:// or parseps:// | (TCP) 80 or 443 | parsep://AppID:MasterKey@Hostname<br/>parseps://AppID:MasterKey@Hostname
| PopcornNotify | popcorn:// | (TCP) 443 | popcorn://ApiKey/ToPhoneNo<br/>popcorn://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/<br/>popcorn://ApiKey/ToEmail<br/>popcorn://ApiKey/ToEmail1/ToEmail2/ToEmailN/<br/>popcorn://ApiKey/ToPhoneNo1/ToEmail1/ToPhoneNoN/ToEmailN
| Prowl | prowl:// | (TCP) 443 | prowl://apikey<br />prowl://apikey/providerkey
| PushBullet | pbul:// | (TCP) 443 | pbul://accesstoken<br />pbul://accesstoken/#channel<br/>pbul://accesstoken/A_DEVICE_ID<br />pbul://accesstoken/[email protected]<br />pbul://accesstoken/#channel/#channel2/[email protected]/DEVICE
| Pushjet | pjet:// or pjets:// | (TCP) 80 or 443 | pjet://hostname/secret<br />pjet://hostname:port/secret<br />pjets://secret@hostname/secret<br />pjets://hostname:port/secret
| Push (Techulus) | push:// | (TCP) 443 | push://apikey/
| Pushed | pushed:// | (TCP) 443 | pushed://appkey/appsecret/<br/>pushed://appkey/appsecret/#ChannelAlias<br/>pushed://appkey/appsecret/#ChannelAlias1/#ChannelAlias2/#ChannelAliasN<br/>pushed://appkey/appsecret/@UserPushedID<br/>pushed://appkey/appsecret/@UserPushedID1/@UserPushedID2/@UserPushedIDN
| PushMe | pushme:// | (TCP) 443 | pushme://Token/
| Pushover | pover:// | (TCP) 443 | pover://user@token<br />pover://user@token/DEVICE<br />pover://user@token/DEVICE1/DEVICE2/DEVICEN<br />Note: you must specify both your user_id and token
| Pushplus | pushplus:// | (TCP) 443 | pushplus://Token
| PushSafer | psafer:// or psafers:// | (TCP) 80 or 443 | psafer://privatekey<br />psafers://privatekey/DEVICE<br />psafer://privatekey/DEVICE1/DEVICE2/DEVICEN
| Pushy | pushy:// | (TCP) 443 | pushy://apikey/DEVICE<br />pushy://apikey/DEVICE1/DEVICE2/DEVICEN<br />pushy://apikey/TOPIC<br />pushy://apikey/TOPIC1/TOPIC2/TOPICN
| PushDeer | pushdeer:// or pushdeers:// | (TCP) 80 or 443 | pushdeer://pushKey<br />pushdeer://hostname/pushKey<br />pushdeer://hostname:port/pushKey
| QQ Push | qq:// | (TCP) 443 | qq://Token
| Reddit | reddit:// | (TCP) 443 | reddit://user:password@app_id/app_secret/subreddit<br />reddit://user:password@app_id/app_secret/sub1/sub2/subN
| Resend | resend:// | (TCP) 443 | resend://APIToken:FromEmail/<br />resend://APIToken:FromEmail/ToEmail<br />resend://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
| Revolt | revolt:// | (TCP) 443 | revolt://bottoken/ChannelID<br />revolt://bottoken/ChannelID1/ChannelID2/ChannelIDN |
| Rocket.Chat | rocket:// or rockets:// | (TCP) 80 or 443 | rocket://user:password@hostname/RoomID/Channel<br />rockets://user:password@hostname:443/#Channel1/#Channel1/RoomID<br />rocket://user:password@hostname/#Channel<br />rocket://webhook@hostname<br />rockets://webhook@hostname/@User/#Channel
| RSyslog | rsyslog:// | (UDP) 514 | rsyslog://hostname<br />rsyslog://hostname/Facility
| Ryver | ryver:// | (TCP) 443 | ryver://Organization/Token<br />ryver://botname@Organization/Token
| SendGrid | sendgrid:// | (TCP) 443 | sendgrid://APIToken:FromEmail/<br />sendgrid://APIToken:FromEmail/ToEmail<br />sendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
| SendPulse | sendpulse:// | (TCP) 443 | sendpulse://user@host/ClientId/ClientSecret<br />sendpulse://user@host/ClientId/clientSecret/ToEmail<br />sendpulse://user@host/ClientId/ClientSecret/ToEmail1/ToEmail2/ToEmailN/
| ServerChan | schan:// | (TCP) 443 | schan://sendkey/
| Signal API | signal:// or signals:// | (TCP) 80 or 443 | signal://hostname:port/FromPhoneNo<br/>signal://hostname:port/FromPhoneNo/ToPhoneNo<br/>signal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| SIGNL4 | signl4:// | (TCP) 80 or 443 | signl4://hostname
| SimplePush | spush:// | (TCP) 443 | spush://apikey<br />spush://salt:password@apikey<br />spush://apikey?event=Apprise
| Slack | slack:// | (TCP) 443 | slack://TokenA/TokenB/TokenC/<br />slack://TokenA/TokenB/TokenC/Channel<br />slack://botname@TokenA/TokenB/TokenC/Channel<br />slack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelN
| SMTP2Go | smtp2go:// | (TCP) 443 | smtp2go://user@hostname/apikey<br />smtp2go://user@hostname/apikey/email<br />smtp2go://user@hostname/apikey/email1/email2/emailN<br />smtp2go://user@hostname/apikey/?name="From%20User"
| SparkPost | sparkpost:// | (TCP) 443 | sparkpost://user@hostname/apikey<br />sparkpost://user@hostname/apikey/email<br />sparkpost://user@hostname/apikey/email1/email2/emailN<br />sparkpost://user@hostname/apikey/?name="From%20User"
| Spike.sh | spike:// | (TCP) 443 | spike://Token
| Splunk | splunk:// or victorops:/ | (TCP) 443 | splunk://route_key@apikey<br />splunk://route_key@apikey/entity_id
| Spug Push | spugpush:// | (TCP) 443 | spugpush://Token
| Streamlabs | strmlabs:// | (TCP) 443 | strmlabs://AccessToken/<br/>strmlabs://AccessToken/?name=name&identifier=identifier&amount=0&currency=USD
| Synology Chat | synology:// or synologys:// | (TCP) 80 or 443 | synology://hostname/token<br />synology://hostname:port/token
| Syslog | syslog:// | n/a | syslog://<br />syslog://Facility
| Telegram | tgram:// | (TCP) 443 | tgram://bottoken/ChatID<br />tgram://bottoken/ChatID1/ChatID2/ChatIDN
| Twitter | twitter:// | (TCP) 443 | twitter://CKey/CSecret/AKey/ASecret<br/>twitter://user@CKey/CSecret/AKey/ASecret<br/>twitter://CKey/CSecret/AKey/ASecret/User1/User2/User2<br/>twitter://CKey/CSecret/AKey/ASecret?mode=tweet
| Twist | twist:// | (TCP) 443 | twist://pasword:login<br/>twist://password:login/#channel<br/>twist://password:login/#team:channel<br/>twist://password:login/#team:channel1/channel2/#team3:channel
| Vapid (WebPush) | vapid:// | (TCP) 443 | vapid://subscriber/target<br/>vapid://subscriber/target?subfile=path&keyfile=path
| Viber | viber:// | (TCP) 443 | viber://token/target
| Webex Teams (Cisco) | wxteams:// | (TCP) 443 | wxteams://Token
| WeCom Bot | wecombot:// | (TCP) 443 | wecombot://BotKey
| WhatsApp | whatsapp:// | (TCP) 443 | whatsapp://AccessToken@FromPhoneID/ToPhoneNo<br/>whatsapp://Template:AccessToken@FromPhoneID/ToPhoneNo
| WxPusher | wxpusher:// | (TCP) 443 | wxpusher://AppToken@UserID1/UserID2/UserIDN<br/>wxpusher://AppToken@Topic1/Topic2/Topic3<br/>wxpusher://AppToken@UserID1/Topic1/
| XBMC | xbmc:// or xbmcs:// | (TCP) 8080 or 443 | xbmc://hostname<br />xbmc://user@hostname<br />xbmc://user:password@hostname:port
| XMPP | xmpp:// or xmpps:// | (TCP) 5222 or 5223 | xmpp://user:pass@hostname<br />xmpps://user:pass@hostname/jid<br />xmpps://user:pass@hostname/jid1/[email protected]
| Zulip Chat | zulip:// | (TCP) 443 | zulip://botname@Organization/Token<br />zulip://botname@Organization/Token/Stream<br />zulip://botname@Organization/Token/Email

SMS Notifications Copy Chapter

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.

| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| 46elks | 46elks:// | (TCP) 443 | 46elks://user:password@FromPhoneNo<br/>46elks://user:password@FromPhoneNo/ToPhoneNo<br/>46elks://user:password@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Africas Talking | atalk:// | (TCP) 443 | atalk://AppUser@ApiKey/ToPhoneNo<br/>atalk://AppUser@ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Automated Packet Reporting System (ARPS) | aprs:// | (TCP) 10152 | aprs://user:pass@callsign<br/>aprs://user:pass@callsign1/callsign2/callsignN
| AWS SNS | sns:// | (TCP) 443 | sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo<br/>sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo1/+PhoneNo2/+PhoneNoN<br/>sns://AccessKeyID/AccessSecretKey/RegionName/Topic<br/>sns://AccessKeyID/AccessSecretKey/RegionName/Topic1/Topic2/TopicN
| BulkSMS | bulksms:// | (TCP) 443 | bulksms://user:password@ToPhoneNo<br/>bulksms://User:Password@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| BulkVS | bulkvs:// | (TCP) 443 | bulkvs://user:password@FromPhoneNo<br/>bulkvs://user:password@FromPhoneNo/ToPhoneNo<br/>bulkvs://user:password@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Burst SMS | burstsms:// | (TCP) 443 | burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo<br/>burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Clickatell | clickatell:// | (TCP) 443 | clickatell://ApiKey/ToPhoneNo<br/>clickatell://FromPhoneNo@ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| ClickSend | clicksend:// | (TCP) 443 | clicksend://user:pass@PhoneNo<br/>clicksend://user:pass@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| DAPNET | dapnet:// | (TCP) 80 | dapnet://user:pass@callsign<br/>dapnet://user:pass@callsign1/callsign2/callsignN
| D7 Networks | d7sms:// | (TCP) 443 | d7sms://token@PhoneNo<br/>d7sms://token@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| DingTalk | dingtalk:// | (TCP) 443 | dingtalk://token/<br />dingtalk://token/ToPhoneNo<br />dingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/
| Exotel | exotel:// | (TCP) 443 | exotel://sid:token@FromPhoneNo<br/>exotel://sid:token@FromPhoneNo/ToPhoneNo<br/>exotel://sid:token@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| Free-Mobile | freemobile:// | (TCP) 443 | freemobile://user@password/
| httpSMS | httpsms:// | (TCP) 443 | httpsms://ApiKey@FromPhoneNo<br/>httpsms://ApiKey@FromPhoneNo/ToPhoneNo<br/>httpsms://ApiKey@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Kavenegar | kavenegar:// | (TCP) 443 | kavenegar://ApiKey/ToPhoneNo<br/>kavenegar://FromPhoneNo@ApiKey/ToPhoneNo<br/>kavenegar://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| MessageBird | msgbird:// | (TCP) 443 | msgbird://ApiKey/FromPhoneNo<br/>msgbird://ApiKey/FromPhoneNo/ToPhoneNo<br/>msgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| MSG91 | msg91:// | (TCP) 443 | msg91://TemplateID@AuthKey/ToPhoneNo<br/>msg91://TemplateID@AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Plivo | plivo:// | (TCP) 443 | plivo://AuthID@Token@FromPhoneNo<br/>plivo://AuthID@Token/FromPhoneNo/ToPhoneNo<br/>plivo://AuthID@Token/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Seven | seven:// | (TCP) 443 | seven://ApiKey/FromPhoneNo<br/>seven://ApiKey/FromPhoneNo/ToPhoneNo<br/>seven://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Société Française du Radiotéléphone (SFR) | sfr:// | (TCP) 443 | sfr://user:password>@spaceId/ToPhoneNo<br/>sfr://user:password>@spaceId/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Signal API | signal:// or signals:// | (TCP) 80 or 443 | signal://hostname:port/FromPhoneNo<br/>signal://hostname:port/FromPhoneNo/ToPhoneNo<br/>signal://hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Sinch | sinch:// | (TCP) 443 | sinch://ServicePlanId:ApiToken@FromPhoneNo<br/>sinch://ServicePlanId:ApiToken@FromPhoneNo/ToPhoneNo<br/>sinch://ServicePlanId:ApiToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/<br/>sinch://ServicePlanId:ApiToken@ShortCode/ToPhoneNo<br/>sinch://ServicePlanId:ApiToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| SMPP | smpp:// or smpps:// | (TCP) 443 | smpp://user:password@hostname:port/FromPhoneNo/ToPhoneNo<br/>smpps://user:password@hostname:port/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
| SMSEagle | smseagle:// or smseagles:// | (TCP) 80 or 443 | smseagles://hostname:port/ToPhoneNo<br/>smseagles://hostname:port/@ToContact<br/>smseagles://hostname:port/#ToGroup<br/>smseagles://hostname:port/ToPhoneNo1/#ToGroup/@ToContact/
| SMS Manager | smsmgr:// | (TCP) 443 | smsmgr://ApiKey@ToPhoneNo<br/>smsmgr://ApiKey@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Threema Gateway | threema:// | (TCP) 443 | threema://GatewayID@secret/ToPhoneNo<br/>threema://GatewayID@secret/ToEmail<br/>threema://GatewayID@secret/ToThreemaID/<br/>threema://GatewayID@secret/ToEmail/ToThreemaID/ToPhoneNo/...
| Twilio | twilio:// | (TCP) 443 | twilio://AccountSid:AuthToken@FromPhoneNo<br/>twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo<br/>twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/<br/>twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo?apikey=Key<br/>twilio://AccountSid:AuthToken@ShortCode/ToPhoneNo<br/>twilio://AccountSid:AuthToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/<br/>twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo?method=call<br/>twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN?method=call
| Voipms | voipms:// | (TCP) 443 | voipms://password:email/FromPhoneNo<br/>voipms://password:email/FromPhoneNo/ToPhoneNo<br/>voipms://password:email/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| Vonage (formerly Nexmo) | vonage:// | (TCP) 443 | vonage://ApiKey:ApiSecret@FromPhoneNo<br/>vonage://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo<br/>vonage://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/

Desktop Notifications Copy Chapter

| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| Linux DBus Notifications | dbus://<br />qt://<br />glib://<br />kde:// | n/a | dbus://<br />qt://<br />glib://<br />kde://
| Linux Gnome Notifications | gnome:// | n/a | gnome://
| MacOS X Notifications | macosx:// | n/a | macosx://
| Windows Notifications | windows:// | n/a | windows://

Email Notifications Copy Chapter

| Service ID | Default Port | Example Syntax |
| ---------- | ------------ | -------------- |
| mailto:// | (TCP) 25 | mailto://userid:[email protected]<br />mailto://domain.com?user=userid&pass=password<br/>mailto://domain.com:2525?user=userid&pass=password<br />mailto://[email protected]&pass=password<br />mailto://mySendingUsername:[email protected][email protected]<br />mailto://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply
| mailtos:// | (TCP) 587 | mailtos://userid:[email protected]<br />mailtos://domain.com?user=userid&pass=password<br/>mailtos://domain.com:465?user=userid&pass=password<br />mailtos://[email protected]&pass=password<br />mailtos://mySendingUsername:[email protected][email protected]<br />mailtos://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply

Apprise have some email services built right into it (such as yahoo, fastmail, hotmail, gmail, etc) that greatly simplify the mailto:// service. See more details here.

Custom Notifications Copy Chapter

| Post Method | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| Form | form:// or forms:// | (TCP) 80 or 443 | form://hostname<br />form://user@hostname<br />form://user:password@hostname:port<br />form://hostname/a/path/to/post/to
| JSON | json:// or jsons:// | (TCP) 80 or 443 | json://hostname<br />json://user@hostname<br />json://user:password@hostname:port<br />json://hostname/a/path/to/post/to
| XML | xml:// or xmls:// | (TCP) 80 or 443 | xml://hostname<br />xml://user@hostname<br />xml://user:password@hostname:port<br />xml://hostname/a/path/to/post/to

Installation

The easiest way is to install Apprise from PyPI:

pip install apprise

Apprise is also packaged as an RPM and available through 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/Rocky Linux 8.x+ and/or Fedora Users

dnf install apprise

You can also check out the Graphical version of Apprise to centralize your configuration and notifications through a manageable webpage.

Command Line Usage

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

Send a notification to as many servers as you want

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

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

apprise -vv -t 'my title' -b 'my notification body' \
   'mailto://myemail:[email protected]' \
   'pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b'
If you don't specify a --body (-b) then stdin is used allowing

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

cat /proc/cpuinfo | apprise -vv -t 'cpu info' \
   'mailto://myemail:[email protected]'
The title field is totally optional

uptime | apprise -vv \
   'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'

CLI Configuration Files Copy Chapter

No one wants to put their credentials out for everyone to see on the command line. No problem apprise also supports configuration files. It can handle both a specific YAML format or a very simple TEXT format. You can also pull these configuration files via an HTTP query too! Read more about the expected structure of the configuration files here.

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

configuration files (if present) from:

 ~/.apprise

 ~/.apprise.yaml

 ~/.config/apprise.conf

 ~/.config/apprise.yaml

 /etc/apprise.conf

 /etc/apprise.yaml
Also a subdirectory handling allows you to leverage plugins

 ~/.apprise/apprise

 ~/.apprise/apprise.yaml

 ~/.config/apprise/apprise.conf

 ~/.config/apprise/apprise.yaml

 /etc/apprise/apprise.yaml

 /etc/apprise/apprise.conf
Windows users can store their default configuration files here:

 %APPDATA%/Apprise/apprise.conf

 %APPDATA%/Apprise/apprise.yaml

 %LOCALAPPDATA%/Apprise/apprise.conf

 %LOCALAPPDATA%/Apprise/apprise.yaml

 %ALLUSERSPROFILE%\Apprise\apprise.conf

 %ALLUSERSPROFILE%\Apprise\apprise.yaml

 %PROGRAMFILES%\Apprise\apprise.conf

 %PROGRAMFILES%\Apprise\apprise.yaml

 %COMMONPROGRAMFILES%\Apprise\apprise.conf

 %COMMONPROGRAMFILES%\Apprise\apprise.yaml
The configuration files specified above can also be identified with a .yml

extension or even just entirely removing the .conf extension altogether.
If you loaded one of those files, your command line gets really easy:

apprise -vv -t 'my title' -b 'my notification body'
If you want to deviate from the default paths or specify more than one,

just specify them using the --config switch:

apprise -vv -t 'my title' -b 'my notification body' \
   --config=/path/to/my/config.yml
Got lots of configuration locations? No problem, you can specify them all:

Apprise can even fetch the configuration from over a network!

apprise -vv -t 'my title' -b 'my notification body' \
   --config=/path/to/my/config.yml \
   --config=https://localhost/my/apprise/config

CLI Tagging Support Copy Chapter

Apprise allows you to tag your services in your configuration to organize them (e.g., family, devops, critical). You can then filter which services to notify using the --tag (-g) switch.

It is important to understand how Apprise handles multiple tags:

OR Logic (Union): To notify services that have either* Tag A OR Tag B, specify the -g switch multiple times.
AND Logic (Intersection): To notify services that have both* Tag A AND Tag B, separate the tags with a comma.

OR Logic: Notify any service tagged 'devops' OR 'admin'

apprise -vv -t "Union Test" \
   --config=~/apprise.yml \
   -g devops -g admin
AND Logic: Notify only services tagged with BOTH 'devops' AND 'critical'

apprise -vv -t "Intersection Test" \
   --config=~/apprise.yml \
   -g devops,critical
CLI File Attachments  Copy Chapter
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:

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

CLI Loading Custom Notifications/Hooks  Copy Chapter
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.

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

# Returning True/False is a way to relay your status back to Apprise.
# Returning nothing (None by default) is always interpreted as a Success

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

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:

However you can override the path like so

You can read more about creating your own custom notifications and/or hooks here.
CLI Environment Variables  Copy Chapter
Those using the Command Line Interface (CLI) can also leverage environment variables to pre-set the default settings:
| Variable                | Description       |
|------------------------ | ----------------- |
| APPRISE_URLS          |  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 overrides any reference to this variable. Use white space and/or a comma (,) to delimit multiple entries.
|  APPRISE_CONFIG_PATH  | Explicitly specify the config search path to use (overriding 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.
|  APPRISE_PLUGIN_PATH  | Explicitly specify the custom plugin search path to use (overriding the default). Use a semi-colon (;), line-feed (\n), and/or carriage return (\r) to delimit multiple entries.
|  APPRISE_STORAGE_PATH | Explicitly specify the persistent storage path to use (overriding the default).
Developer API Usage
To send a notification from within your python application, just do the following:

Create an Apprise instance

Add all of the notification services by their server url.

A sample email notification:

A sample pushbullet notification

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

notify all of the services loaded into our Apprise object.

API Configuration Files  Copy Chapter
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.

Create an Apprise instance

Create an Config instance

Add a configuration source:

Add another...

Make sure to add our config into our apprise object

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

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

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.

Tagging allows you to specifically target only specific notification

services you've loaded:

If you want to notify absolutely everything (regardless of whether

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

API File Attachments  Copy Chapter
Attachments are very easy to send using the Apprise API:

Create an Apprise instance

Add at least one service you want to notify

Then send your attachment.

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

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

Create an Apprise instance

Add at least one service you want to notify

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

# Now add another:
'/path/to/funny/joke.gif',
)

Send your multiple attachments with a single notify call:

API Loading Custom Notifications/Hooks  Copy Chapter
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:

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

be loaded for your instance of Apprise...

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

# 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

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

Send our notification out through our foobar://

You can read more about creating your own custom notifications and/or hooks here.
Persistent Storage
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.
1. flush: Flushes any cache information to the filesystem during every transaction.
1. 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  Copy Chapter
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:

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

You can prune all of your storage older then 30 days

and not accessed for this period like so:

You can do a hard reset (and wipe all persistent storage) with:

You can also filter your results by adding tags and/or URL Identifiers.  When you get a listing (apprise storage list), you may see:

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

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

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:

Entries can be filtered by tag as well:

You can match on multiple URL ID's as well:

The followin would actually match the URL ID's of 1. and .2 above

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.
API Persistent Storage Commands  Copy Chapter

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:

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

If you want to be more explicit and set more options, then you may do the

following

# 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

For more information on persistent storage, visit here.

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
* ⚙️ Configuration File Help
* ⚡ Create Your Own Custom Notifications
* 🌎 Apprise API/Web Interface
* 📖 Apprise Documentation Source
* 🔧 Troubleshooting
* 🎉 Showcase

Want to help make Apprise better?
* 💡 Contribute to the Apprise Code Base
* ❤️ Sponsorship and Donations