2019-11-26 00:27:02 +01:00
2017-12-03 08:00:23 +01:00
2017-11-25 22:51:46 +01:00
< hr / >
**ap·prise** / *verb* < br />
To inform or tell (someone). To make one aware of something.
< hr / >
2019-10-01 17:03:01 +02:00
*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.
2018-10-11 15:26:40 +02:00
* One notification library to rule them all.
* A common and intuitive notification syntax.
2020-08-16 02:28:15 +02:00
* Supports the handling of images and attachments (_to the notification services that will accept them_).
* It's incredibly lightweight.
2021-02-28 17:16:33 +01:00
* Amazing response times because all messages sent asynchronously.
2018-10-11 15:26:40 +02:00
2020-08-16 02:28:15 +02:00
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.
2018-10-11 15:26:40 +02:00
2020-08-16 02:28:15 +02:00
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.
2017-11-25 22:51:46 +01:00
2020-01-09 02:05:27 +01:00
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick& hosted_button_id=MHANV39UZNQ5E)
[](https://twitter.com/l2gnux/)< br />
2019-03-23 00:58:45 +01:00
[](https://discord.gg/MMPeN2D)
[](https://pypi.org/project/apprise/)
2022-10-20 02:18:03 +02:00
[](https://github.com/caronc/apprise/actions/workflows/tests.yml)
2017-12-03 08:00:23 +01:00
[](https://codecov.io/github/caronc/apprise)
2019-02-05 02:28:03 +01:00
[](https://pypi.org/project/apprise/)
2017-11-29 05:25:25 +01:00
2022-07-15 17:27:36 +02:00
# Table of Contents
<!-- ts -->
* [Supported Notifications ](#supported-notifications )
* [Productivity Based Notifications ](#productivity-based-notifications )
* [SMS Notifications ](#sms-notifications )
* [Desktop Notifications ](#desktop-notifications )
* [Email Notifications ](#email-notifications )
* [Custom Notifications ](#custom-notifications )
* [Installation ](#installation )
* [Command Line Usage ](#command-line-usage )
* [Configuration Files ](#cli-configuration-files )
* [File Attachments ](#cli-file-attachments )
* [Loading Custom Notifications/Hooks ](#cli-loading-custom-notificationshooks )
* [Developer API Usage ](#developer-api-usage )
* [Configuration Files ](#api-configuration-files )
* [File Attachments ](#api-file-attachments )
* [Loading Custom Notifications/Hooks ](#api-loading-custom-notificationshooks )
2024-09-02 18:29:06 +02:00
* [Persistent Storage ](#persistent-storage )
2022-07-15 17:27:36 +02:00
* [More Supported Links and Documentation ](#want-to-learn-more )
<!-- te -->
# Supported Notifications
2018-12-16 21:44:28 +01:00
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 ).
2017-11-25 22:51:46 +01:00
2022-07-15 17:27:36 +02:00
## Productivity Based Notifications
2019-10-01 17:03:01 +02:00
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.
2017-11-25 22:51:46 +01:00
| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
2021-10-30 22:59:20 +02:00
| [Apprise API ](https://github.com/caronc/apprise/wiki/Notify_apprise_api ) | apprise:// or apprises:// | (TCP) 80 or 443 | apprise://hostname/Token
2021-12-06 23:03:30 +01:00
| [AWS SES ](https://github.com/caronc/apprise/wiki/Notify_ses ) | ses:// | (TCP) 443 | ses://user@domain/AccessKeyID/AccessSecretKey/RegionName< br /> ses://user@domain/AccessKeyID/AccessSecretKey/RegionName/email1/email2/emailN
2023-11-18 21:23:35 +01:00
| [Bark ](https://github.com/caronc/apprise/wiki/Notify_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
2022-06-06 15:34:17 +02:00
| [Boxcar ](https://github.com/caronc/apprise/wiki/Notify_boxcar ) | boxcar:// | (TCP) 443 | boxcar://hostname< br /> boxcar://hostname/@tag< br /> boxcar://hostname/device_token< br /> boxcar://hostname/device_token1/device_token2/device_tokenN< br /> boxcar://hostname/@tag/@tag2/device_token
2024-04-09 02:56:41 +02:00
| [Chantify ](https://github.com/caronc/apprise/wiki/Notify_chantify ) | chantify:// | (TCP) 443 | chantify://token
2018-02-26 01:59:37 +01:00
| [Discord ](https://github.com/caronc/apprise/wiki/Notify_discord ) | discord:// | (TCP) 443 | discord://webhook_id/webhook_token< br /> discord://avatar@webhook_id/webhook_token
2018-03-05 03:06:41 +01:00
| [Emby ](https://github.com/caronc/apprise/wiki/Notify_emby ) | emby:// or embys:// | (TCP) 8096 | emby://user@hostname/< br /> emby://user:password@hostname
2019-11-29 01:12:23 +01:00
| [Enigma2 ](https://github.com/caronc/apprise/wiki/Notify_enigma2 ) | enigma2:// or enigma2s:// | (TCP) 80 or 443 | enigma2://hostname
2020-12-23 20:56:28 +01:00
| [FCM ](https://github.com/caronc/apprise/wiki/Notify_fcm ) | fcm:// | (TCP) 443 | fcm://project@apikey/DEVICE_ID< br /> fcm://project@apikey/#TOPIC< br /> fcm://project@apikey/DEVICE_ID1/#topic1/#topic2/DEVICE_ID2/
2024-04-10 22:39:50 +02:00
| [Feishu ](https://github.com/caronc/apprise/wiki/Notify_feishu ) | feishu:// | (TCP) 443 | feishu://token
2019-03-18 00:27:34 +01:00
| [Flock ](https://github.com/caronc/apprise/wiki/Notify_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
2021-01-11 20:23:52 +01:00
| [Google Chat ](https://github.com/caronc/apprise/wiki/Notify_googlechat ) | gchat:// | (TCP) 443 | gchat://workspace/key/token
2019-03-12 02:17:55 +01:00
| [Gotify ](https://github.com/caronc/apprise/wiki/Notify_gotify ) | gotify:// or gotifys:// | (TCP) 80 or 443 | gotify://hostname/token< br /> gotifys://hostname/token?priority=high
2018-02-26 02:47:07 +01:00
| [Growl ](https://github.com/caronc/apprise/wiki/Notify_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
2022-05-11 04:25:24 +02:00
| [Guilded ](https://github.com/caronc/apprise/wiki/Notify_guilded ) | guilded:// | (TCP) 443 | guilded://webhook_id/webhook_token< br /> guilded://avatar@webhook_id/webhook_token
2021-02-14 20:01:30 +01:00
| [Home Assistant ](https://github.com/caronc/apprise/wiki/Notify_homeassistant ) | 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
2019-02-17 19:51:35 +01:00
| [IFTTT ](https://github.com/caronc/apprise/wiki/Notify_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
2017-11-25 22:51:46 +01:00
| [Join ](https://github.com/caronc/apprise/wiki/Notify_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 ](https://github.com/caronc/apprise/wiki/Notify_kodi ) | kodi:// or kodis:// | (TCP) 8080 or 443 | kodi://hostname< br /> kodi://user@hostname< br /> kodi://user:password@hostname:port
2019-09-12 04:10:32 +02:00
| [Kumulos ](https://github.com/caronc/apprise/wiki/Notify_kumulos ) | kumulos:// | (TCP) 443 | kumulos://apikey/serverkey
2020-09-14 04:13:27 +02:00
| [LaMetric Time ](https://github.com/caronc/apprise/wiki/Notify_lametric ) | lametric:// | (TCP) 443 | lametric://apikey@device_ipaddr< br /> lametric://apikey@hostname:port< br /> lametric://client_id@client_secret
2022-06-03 02:01:31 +02:00
| [Line ](https://github.com/caronc/apprise/wiki/Notify_line ) | line:// | (TCP) 443 | line://Token@User< br /> line://Token/User1/User2/UserN
2024-03-09 22:38:37 +01:00
| [LunaSea ](https://github.com/caronc/apprise/wiki/Notify_lunasea ) | lunasea:// | (TCP) 80 or 443 | lunasea://user:pass@+FireBaseDevice/< br /> lunasea://user:pass@FireBaseUser/< br /> lunasea://user:pass@hostname/+FireBaseDevice/< br /> lunasea://user:pass@hostname/@FireBaseUser/
2019-04-27 23:41:20 +02:00
| [Mailgun ](https://github.com/caronc/apprise/wiki/Notify_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"
2022-11-11 20:17:20 +01:00
| [Mastodon ](https://github.com/caronc/apprise/wiki/Notify_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
2019-03-17 19:20:51 +01:00
| [Matrix ](https://github.com/caronc/apprise/wiki/Notify_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
2021-06-19 21:46:46 +02:00
| [Mattermost ](https://github.com/caronc/apprise/wiki/Notify_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 />
2024-07-25 23:33:25 +02:00
| [Microsoft Power Automate / Workflows (MSTeams) ](https://github.com/caronc/apprise/wiki/Notify_workflows ) | workflows:// | (TCP) 443 | workflows://WorkflowID/Signature/
2019-04-04 04:39:51 +02:00
| [Microsoft Teams ](https://github.com/caronc/apprise/wiki/Notify_msteams ) | msteams:// | (TCP) 443 | msteams://TokenA/TokenB/TokenC/
2023-02-19 03:32:44 +01:00
| [Misskey ](https://github.com/caronc/apprise/wiki/Notify_misskey ) | misskey:// or misskeys://| (TCP) 80 or 443 | misskey://access_token@hostname
2021-09-17 04:46:33 +02:00
| [MQTT ](https://github.com/caronc/apprise/wiki/Notify_mqtt ) | mqtt:// or mqtts:// | (TCP) 1883 or 8883 | mqtt://hostname/topic< br /> mqtt://user@hostname/topic< br /> mqtts://user:pass@hostname:9883/topic
2019-12-13 01:37:05 +01:00
| [Nextcloud ](https://github.com/caronc/apprise/wiki/Notify_nextcloud ) | ncloud:// or nclouds:// | (TCP) 80 or 443 | ncloud://adminuser:pass@host/User< br /> nclouds://adminuser:pass@host/User1/User2/UserN
2022-01-12 04:13:32 +01:00
| [NextcloudTalk ](https://github.com/caronc/apprise/wiki/Notify_nextcloudtalk ) | nctalk:// or nctalks:// | (TCP) 80 or 443 | nctalk://user:pass@host/RoomId< br /> nctalks://user:pass@host/RoomId1/RoomId2/RoomIdN
2019-10-19 15:28:31 +02:00
| [Notica ](https://github.com/caronc/apprise/wiki/Notify_notica ) | notica:// | (TCP) 443 | notica://Token/
2023-10-07 23:40:41 +02:00
| [Notifiarr ](https://github.com/caronc/apprise/wiki/Notify_notifiarr ) | notifiarr:// | (TCP) 443 | notifiarr://apikey/#channel< br /> notifiarr://apikey/#channel1/#channel2/#channeln
2019-10-13 21:03:48 +02:00
| [Notifico ](https://github.com/caronc/apprise/wiki/Notify_notifico ) | notifico:// | (TCP) 443 | notifico://ProjectID/MessageHook/
2022-04-04 04:00:44 +02:00
| [ntfy ](https://github.com/caronc/apprise/wiki/Notify_ntfy ) | ntfy:// | (TCP) 80 or 443 | ntfy://topic/< br /> ntfys://topic/
2020-05-04 03:39:32 +02:00
| [Office 365 ](https://github.com/caronc/apprise/wiki/Notify_office365 ) | o365:// | (TCP) 443 | o365://TenantID:AccountEmail/ClientID/ClientSecret< br /> o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail< br /> o365://TenantID:AccountEmail/ClientID/ClientSecret/TargetEmail1/TargetEmail2/TargetEmailN
2020-12-30 21:55:16 +01:00
| [OneSignal ](https://github.com/caronc/apprise/wiki/Notify_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 ](https://github.com/caronc/apprise/wiki/Notify_opsgenie ) | opsgenie:// | (TCP) 443 | opsgenie://APIKey< br /> opsgenie://APIKey/UserID< br /> opsgenie://APIKey/#Team< br /> opsgenie://APIKey/\*Schedule< br /> opsgenie://APIKey/^Escalation
2022-06-03 01:40:31 +02:00
| [PagerDuty ](https://github.com/caronc/apprise/wiki/Notify_pagerduty ) | pagerduty:// | (TCP) 443 | pagerduty://IntegrationKey@ApiKey< br /> pagerduty://IntegrationKey@ApiKey/Source/Component
2023-02-14 02:01:18 +01:00
| [PagerTree ](https://github.com/caronc/apprise/wiki/Notify_pagertree ) | pagertree:// | (TCP) 443 | pagertree://integration_id
2020-10-20 22:38:29 +02:00
| [ParsePlatform ](https://github.com/caronc/apprise/wiki/Notify_parseplatform ) | parsep:// or parseps:// | (TCP) 80 or 443 | parsep://AppID:MasterKey@Hostname< br /> parseps://AppID:MasterKey@Hostname
2020-07-23 16:04:59 +02:00
| [PopcornNotify ](https://github.com/caronc/apprise/wiki/Notify_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
2017-11-25 22:51:46 +01:00
| [Prowl ](https://github.com/caronc/apprise/wiki/Notify_prowl ) | prowl:// | (TCP) 443 | prowl://apikey< br /> prowl://apikey/providerkey
| [PushBullet ](https://github.com/caronc/apprise/wiki/Notify_pushbullet ) | pbul:// | (TCP) 443 | pbul://accesstoken< br /> pbul://accesstoken/#channel< br /> pbul://accesstoken/A_DEVICE_ID< br /> pbul://accesstoken/email@address.com< br /> pbul://accesstoken/#channel/#channel2/email@address.net/DEVICE
2019-09-08 00:39:18 +02:00
| [Pushjet ](https://github.com/caronc/apprise/wiki/Notify_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
2019-07-20 04:42:41 +02:00
| [Push (Techulus) ](https://github.com/caronc/apprise/wiki/Notify_techulus ) | push:// | (TCP) 443 | push://apikey/
2019-01-31 06:15:50 +01:00
| [Pushed ](https://github.com/caronc/apprise/wiki/Notify_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
2023-08-19 23:14:44 +02:00
| [PushMe ](https://github.com/caronc/apprise/wiki/Notify_pushme ) | pushme:// | (TCP) 443 | pushme://Token/
2019-03-05 05:33:02 +01:00
| [Pushover ](https://github.com/caronc/apprise/wiki/Notify_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
2019-12-09 02:34:34 +01:00
| [PushSafer ](https://github.com/caronc/apprise/wiki/Notify_pushsafer ) | psafer:// or psafers:// | (TCP) 80 or 443 | psafer://privatekey< br /> psafers://privatekey/DEVICE< br /> psafer://privatekey/DEVICE1/DEVICE2/DEVICEN
2023-07-09 23:36:41 +02:00
| [Pushy ](https://github.com/caronc/apprise/wiki/Notify_pushy ) | pushy:// | (TCP) 443 | pushy://apikey/DEVICE< br /> pushy://apikey/DEVICE1/DEVICE2/DEVICEN< br /> pushy://apikey/TOPIC< br /> pushy://apikey/TOPIC1/TOPIC2/TOPICN
2023-07-14 11:16:49 +02:00
| [PushDeer ](https://github.com/caronc/apprise/wiki/Notify_pushdeer ) | pushdeer:// or pushdeers:// | (TCP) 80 or 443 | pushdeer://pushKey< br /> pushdeer://hostname/pushKey< br /> pushdeer://hostname:port/pushKey
2021-03-04 16:02:26 +01:00
| [Reddit ](https://github.com/caronc/apprise/wiki/Notify_reddit ) | reddit:// | (TCP) 443 | reddit://user:password@app_id/app_secret/subreddit< br /> reddit://user:password@app_id/app_secret/sub1/sub2/subN
2024-02-18 01:25:17 +01:00
| [Revolt ](https://github.com/caronc/apprise/wiki/Notify_Revolt ) | revolt:// | (TCP) 443 | revolt://bottoken/ChannelID< br /> revolt://bottoken/ChannelID1/ChannelID2/ChannelIDN |
2019-05-22 03:50:50 +02:00
| [Rocket.Chat ](https://github.com/caronc/apprise/wiki/Notify_rocketchat ) | 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
2023-08-20 03:33:57 +02:00
| [RSyslog ](https://github.com/caronc/apprise/wiki/Notify_rsyslog ) | rsyslog:// | (UDP) 514 | rsyslog://hostname< br /> rsyslog://hostname/Facility
2019-02-09 23:24:32 +01:00
| [Ryver ](https://github.com/caronc/apprise/wiki/Notify_ryver ) | ryver:// | (TCP) 443 | ryver://Organization/Token< br /> ryver://botname@Organization/Token
2019-08-18 06:39:21 +02:00
| [SendGrid ](https://github.com/caronc/apprise/wiki/Notify_sendgrid ) | sendgrid:// | (TCP) 443 | sendgrid://APIToken:FromEmail/< br /> sendgrid://APIToken:FromEmail/ToEmail< br /> sendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
2022-04-03 18:53:53 +02:00
| [ServerChan ](https://github.com/caronc/apprise/wiki/Notify_serverchan ) | schan:// | (TCP) 443 | schan://sendkey/
2022-04-16 21:34:30 +02:00
| [Signal API ](https://github.com/caronc/apprise/wiki/Notify_signal ) | 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/
2019-09-08 00:57:02 +02:00
| [SimplePush ](https://github.com/caronc/apprise/wiki/Notify_simplepush ) | spush:// | (TCP) 443 | spush://apikey< br /> spush://salt:password@apikey< br /> spush://apikey?event=Apprise
2019-05-11 21:02:56 +02:00
| [Slack ](https://github.com/caronc/apprise/wiki/Notify_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
2021-05-16 02:29:37 +02:00
| [SMTP2Go ](https://github.com/caronc/apprise/wiki/Notify_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"
2024-05-16 23:58:57 +02:00
| [SparkPost ](https://github.com/caronc/apprise/wiki/Notify_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"
2024-07-26 10:31:39 +02:00
| [Splunk ](https://github.com/caronc/apprise/wiki/Notify_splunk ) | splunk:// or victorops:/ | (TCP) 443 | splunk://route_key@apikey< br /> splunk://route_key@apikey/entity_id
2021-09-18 20:49:05 +02:00
| [Streamlabs ](https://github.com/caronc/apprise/wiki/Notify_streamlabs ) | strmlabs:// | (TCP) 443 | strmlabs://AccessToken/< br /> strmlabs://AccessToken/?name=name& identifier=identifier& amount=0& currency=USD
2023-11-19 18:07:27 +01:00
| [Synology Chat ](https://github.com/caronc/apprise/wiki/Notify_synology_chat ) | synology:// or synologys:// | (TCP) 80 or 443 | synology://hostname/token< br /> synology://hostname:port/token
2023-08-20 03:33:57 +02:00
| [Syslog ](https://github.com/caronc/apprise/wiki/Notify_syslog ) | syslog:// | n/a | syslog://< br /> syslog://Facility
2017-11-25 22:51:46 +01:00
| [Telegram ](https://github.com/caronc/apprise/wiki/Notify_telegram ) | tgram:// | (TCP) 443 | tgram://bottoken/ChatID< br /> tgram://bottoken/ChatID1/ChatID2/ChatIDN
2019-06-30 00:27:59 +02:00
| [Twitter ](https://github.com/caronc/apprise/wiki/Notify_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
2019-07-19 04:41:10 +02:00
| [Twist ](https://github.com/caronc/apprise/wiki/Notify_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
2019-04-06 06:33:44 +02:00
| [Webex Teams (Cisco) ](https://github.com/caronc/apprise/wiki/Notify_wxteams ) | wxteams:// | (TCP) 443 | wxteams://Token
2023-12-16 23:01:00 +01:00
| [WeCom Bot ](https://github.com/caronc/apprise/wiki/Notify_wecombot ) | wecombot:// | (TCP) 443 | wecombot://BotKey
2024-08-30 00:09:15 +02:00
| [WhatsApp ](https://github.com/caronc/apprise/wiki/Notify_whatsapp ) | whatsapp:// | (TCP) 443 | whatsapp://AccessToken@FromPhoneID/ToPhoneNo< br /> whatsapp://Template:AccessToken@FromPhoneID/ToPhoneNo
| [WxPusher ](https://github.com/caronc/apprise/wiki/Notify_wxpusher ) | wxpusher:// | (TCP) 443 | wxpusher://AppToken@UserID1/UserID2/UserIDN< br /> wxpusher://AppToken@Topic1/Topic2/Topic3< br /> wxpusher://AppToken@UserID1/Topic1/
2024-07-25 23:33:25 +02:00
| [XBMC ](https://github.com/caronc/apprise/wiki/Notify_xbmc ) | xbmc:// or xbmcs:// | (TCP) 8080 or 443 | xbmc://hostname< br /> xbmc://user@hostname< br /> xbmc://user:password@hostname:port
2020-12-15 00:45:54 +01:00
| [Zulip Chat ](https://github.com/caronc/apprise/wiki/Notify_zulip ) | zulip:// | (TCP) 443 | zulip://botname@Organization/Token< br /> zulip://botname@Organization/Token/Stream< br /> zulip://botname@Organization/Token/Email
2018-07-01 18:40:56 +02:00
2022-07-15 17:27:36 +02:00
## SMS Notifications
2017-11-25 22:51:46 +01:00
2019-06-07 04:59:05 +02:00
| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
2024-07-18 17:59:30 +02:00
| [Africas Talking ](https://github.com/caronc/apprise/wiki/Notify_africas_talking ) | atalk:// | (TCP) 443 | atalk://AppUser@ApiKey/ToPhoneNo< br /> atalk://AppUser@ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2023-12-16 16:59:37 +01:00
| [Automated Packet Reporting System (ARPS) ](https://github.com/caronc/apprise/wiki/Notify_aprs ) | aprs:// | (TCP) 10152 | aprs://user:pass@callsign< br /> aprs://user:pass@callsign1/callsign2/callsignN
2019-06-07 04:59:05 +02:00
| [AWS SNS ](https://github.com/caronc/apprise/wiki/Notify_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
2022-10-08 05:32:34 +02:00
| [BulkSMS ](https://github.com/caronc/apprise/wiki/Notify_bulksms ) | bulksms:// | (TCP) 443 | bulksms://user:password@ToPhoneNo< br /> bulksms://User:Password@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2023-12-22 23:43:49 +01:00
| [BulkVS ](https://github.com/caronc/apprise/wiki/Notify_bulkvs ) | bulkvs:// | (TCP) 443 | bulkvs://user:password@FromPhoneNo< br /> bulkvs://user:password@FromPhoneNo/ToPhoneNo< br /> bulkvs://user:password@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
| [Burst SMS ](https://github.com/caronc/apprise/wiki/Notify_burst_sms ) | burstsms:// | (TCP) 443 | burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo< br /> burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2023-07-01 22:38:52 +02:00
| [Burst SMS ](https://github.com/caronc/apprise/wiki/Notify_burst_sms ) | burstsms:// | (TCP) 443 | burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo< br /> burstsms://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2019-09-07 01:41:23 +02:00
| [ClickSend ](https://github.com/caronc/apprise/wiki/Notify_clicksend ) | clicksend:// | (TCP) 443 | clicksend://user:pass@PhoneNo< br /> clicksend://user:pass@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
2021-12-28 18:35:03 +01:00
| [DAPNET ](https://github.com/caronc/apprise/wiki/Notify_dapnet ) | dapnet:// | (TCP) 80 | dapnet://user:pass@callsign< br /> dapnet://user:pass@callsign1/callsign2/callsignN
2022-12-20 23:57:40 +01:00
| [D7 Networks ](https://github.com/caronc/apprise/wiki/Notify_d7networks ) | d7sms:// | (TCP) 443 | d7sms://token@PhoneNo< br /> d7sms://token@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
2021-08-12 03:49:00 +02:00
| [DingTalk ](https://github.com/caronc/apprise/wiki/Notify_dingtalk ) | dingtalk:// | (TCP) 443 | dingtalk://token/< br /> dingtalk://token/ToPhoneNo< br /> dingtalk://token/ToPhoneNo1/ToPhoneNo2/ToPhoneNo1/
2024-03-30 14:49:44 +01:00
| [Free-Mobile ](https://github.com/caronc/apprise/wiki/Notify_freemobile ) | freemobile:// | (TCP) 443 | freemobile://user@password/
2024-07-18 17:59:30 +02:00
| [httpSMS ](https://github.com/caronc/apprise/wiki/Notify_httpsms ) | httpsms:// | (TCP) 443 | httpsms://ApiKey@FromPhoneNo< br /> httpsms://ApiKey@FromPhoneNo/ToPhoneNo< br /> httpsms://ApiKey@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2020-01-29 19:08:19 +01:00
| [Kavenegar ](https://github.com/caronc/apprise/wiki/Notify_kavenegar ) | kavenegar:// | (TCP) 443 | kavenegar://ApiKey/ToPhoneNo< br /> kavenegar://FromPhoneNo@ApiKey/ToPhoneNo< br /> kavenegar://ApiKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN
2019-08-23 02:01:20 +02:00
| [MessageBird ](https://github.com/caronc/apprise/wiki/Notify_messagebird ) | msgbird:// | (TCP) 443 | msgbird://ApiKey/FromPhoneNo< br /> msgbird://ApiKey/FromPhoneNo/ToPhoneNo< br /> msgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2023-10-06 22:30:57 +02:00
| [MSG91 ](https://github.com/caronc/apprise/wiki/Notify_msg91 ) | msg91:// | (TCP) 443 | msg91://TemplateID@AuthKey/ToPhoneNo< br /> msg91://TemplateID@AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2024-06-11 22:07:53 +02:00
| [Société Française du Radiotéléphone (SFR) ](https://github.com/caronc/apprise/wiki/Notify_sfr ) | sfr:// | (TCP) 443 | sfr://user:password>@spaceId/ToPhoneNo< br /> sfr://user:password>@spaceId/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2022-07-15 17:27:36 +02:00
| [Signal API ](https://github.com/caronc/apprise/wiki/Notify_signal ) | 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/
2020-01-15 02:57:14 +01:00
| [Sinch ](https://github.com/caronc/apprise/wiki/Notify_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/
2023-12-17 20:04:45 +01:00
| [SMSEagle ](https://github.com/caronc/apprise/wiki/Notify_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/
2024-07-18 17:59:30 +02:00
| [SMS Manager ](https://github.com/caronc/apprise/wiki/Notify_sms_manager ) | smsmgr:// | (TCP) 443 | smsmgr://ApiKey@ToPhoneNo< br /> smsmgr://ApiKey@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2023-11-16 03:56:29 +01:00
| [Threema Gateway ](https://github.com/caronc/apprise/wiki/Notify_threema ) | threema:// | (TCP) 443 | threema://GatewayID@secret/ToPhoneNo< br /> threema://GatewayID@secret/ToEmail< br /> threema://GatewayID@secret/ToThreemaID/< br /> threema://GatewayID@secret/ToEmail/ToThreemaID/ToPhoneNo/...
2021-09-15 05:03:37 +02:00
| [Twilio ](https://github.com/caronc/apprise/wiki/Notify_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/
2023-02-11 16:03:02 +01:00
| [Voipms ](https://github.com/caronc/apprise/wiki/Notify_voipms ) | voipms:// | (TCP) 443 | voipms://password:email/FromPhoneNo< br /> voipms://password:email/FromPhoneNo/ToPhoneNo< br /> voipms://password:email/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2022-06-19 04:18:42 +02:00
| [Vonage ](https://github.com/caronc/apprise/wiki/Notify_nexmo ) (formerly Nexmo) | nexmo:// | (TCP) 443 | nexmo://ApiKey:ApiSecret@FromPhoneNo< br /> nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo< br /> nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
2019-06-07 04:59:05 +02:00
2022-07-15 17:27:36 +02:00
## Desktop Notifications
2020-03-31 02:13:35 +02:00
| Notification Service | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
| [Linux DBus Notifications ](https://github.com/caronc/apprise/wiki/Notify_dbus ) | dbus://< br /> qt://< br /> glib://< br /> kde:// | n/a | dbus://< br /> qt://< br /> glib://< br /> kde://
| [Linux Gnome Notifications ](https://github.com/caronc/apprise/wiki/Notify_gnome ) | gnome:// | n/a | gnome://
| [MacOS X Notifications ](https://github.com/caronc/apprise/wiki/Notify_macosx ) | macosx:// | n/a | macosx://
| [Windows Notifications ](https://github.com/caronc/apprise/wiki/Notify_windows ) | windows:// | n/a | windows://
2022-07-15 17:27:36 +02:00
## Email Notifications
2017-11-25 22:51:46 +01:00
| Service ID | Default Port | Example Syntax |
| ---------- | ------------ | -------------- |
2019-01-26 20:51:37 +01:00
| [mailto:// ](https://github.com/caronc/apprise/wiki/Notify_email ) | (TCP) 25 | mailto://userid:pass@domain.com< br /> mailto://domain.com?user=userid& pass=password< br /> mailto://domain.com:2525?user=userid& pass=password< br /> mailto://user@gmail.com& pass=password< br /> mailto://mySendingUsername:mySendingPassword@example.com?to=receivingAddress@example.com< br /> mailto://userid:password@example.com?smtp=mail.example.com& from=noreply@example.com& name=no%20reply
| [mailtos:// ](https://github.com/caronc/apprise/wiki/Notify_email ) | (TCP) 587 | mailtos://userid:pass@domain.com< br /> mailtos://domain.com?user=userid& pass=password< br /> mailtos://domain.com:465?user=userid& pass=password< br /> mailtos://user@hotmail.com& pass=password< br /> mailtos://mySendingUsername:mySendingPassword@example.com?to=receivingAddress@example.com< br /> mailtos://userid:password@example.com?smtp=mail.example.com& from=noreply@example.com& name=no%20reply
2017-11-25 22:51:46 +01:00
2018-12-06 18:00:55 +01:00
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 ).
2017-11-25 22:51:46 +01:00
2022-07-15 17:27:36 +02:00
## Custom Notifications
2017-11-25 22:51:46 +01:00
| Post Method | Service ID | Default Port | Example Syntax |
| -------------------- | ---------- | ------------ | -------------- |
2024-01-14 19:35:25 +01:00
| [Form ](https://github.com/caronc/apprise/wiki/Notify_Custom_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
2017-11-25 22:51:46 +01:00
| [JSON ](https://github.com/caronc/apprise/wiki/Notify_Custom_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 ](https://github.com/caronc/apprise/wiki/Notify_Custom_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
2022-07-15 17:27:36 +02:00
# Installation
2019-02-01 03:28:18 +01:00
The easiest way is to install this package is from pypi:
2017-11-30 01:51:18 +01:00
```bash
pip install apprise
```
2022-07-15 17:27:36 +02:00
Apprise is also packaged as an RPM and available through [EPEL ](https://docs.fedoraproject.org/en-US/epel/ ) supporting CentOS, Redhat, Rocky, Oracle Linux, etc.
```bash
# Follow instructions on https://docs.fedoraproject.org/en-US/epel
# to get your system connected up to EPEL and then:
# Redhat/CentOS 7.x users
yum install apprise
# Redhat/CentOS 8.x+ and/or Fedora Users
dnf install apprise
```
You can also check out the [Graphical version of Apprise ](https://github.com/caronc/apprise-api ) to centralize your configuration and notifications through a managable webpage.
# Command Line Usage
2022-08-09 19:28:25 +02:00
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:
2017-11-30 01:51:18 +01:00
```bash
2019-03-29 05:12:12 +01:00
# Send a notification to as many servers as you want
2020-08-03 16:25:21 +02:00
# 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' \
2017-11-30 01:51:18 +01:00
'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:
2020-08-03 16:25:21 +02:00
cat /proc/cpuinfo | apprise -vv -t 'cpu info' \
2020-06-09 23:22:47 +02:00
'mailto://myemail:mypass@gmail.com'
2019-03-29 05:12:12 +01:00
# The title field is totally optional
2020-08-03 16:25:21 +02:00
uptime | apprise -vv \
2020-06-09 23:22:47 +02:00
'discord:///4174216298/JHMHI8qBe7bk2ZwO5U711o3dV_js'
2017-11-30 01:51:18 +01:00
```
2022-07-15 17:27:36 +02:00
## CLI Configuration Files
No one wants to put their credentials out for everyone to see on the command line. No problem *apprise* also supports configuration files. It can handle both a specific [YAML format ](https://github.com/caronc/apprise/wiki/config_yaml ) or a very simple [TEXT format ](https://github.com/caronc/apprise/wiki/config_text ). You can also pull these configuration files via an HTTP query too! You can read more about the expected structure of the configuration files [here ](https://github.com/caronc/apprise/wiki/config ).
2019-03-05 05:33:02 +01:00
```bash
2022-07-15 17:27:36 +02:00
# By default if no url or configuration is specified apprise will attempt to load
# configuration files (if present) from:
2019-03-05 05:33:02 +01:00
# ~/.apprise
2024-03-03 23:59:06 +01:00
# ~/.apprise.yaml
2024-03-09 19:41:46 +01:00
# ~/.config/apprise.conf
2024-03-03 23:59:06 +01:00
# ~/.config/apprise.yaml
2024-03-09 19:41:46 +01:00
# /etc/apprise.conf
2024-03-03 23:59:06 +01:00
# /etc/apprise.yaml
2019-03-05 05:33:02 +01:00
2022-07-15 17:27:36 +02:00
# Also a subdirectory handling allows you to leverage plugins
# ~/.apprise/apprise
2024-03-03 23:59:06 +01:00
# ~/.apprise/apprise.yaml
2024-03-09 19:41:46 +01:00
# ~/.config/apprise/apprise.conf
2024-03-03 23:59:06 +01:00
# ~/.config/apprise/apprise.yaml
# /etc/apprise/apprise.yaml
2024-03-09 19:41:46 +01:00
# /etc/apprise/apprise.conf
2022-07-15 17:27:36 +02:00
2019-06-30 00:44:29 +02:00
# Windows users can store their default configuration files here:
2024-03-09 19:41:46 +01:00
# %APPDATA%/Apprise/apprise.conf
2024-03-03 23:59:06 +01:00
# %APPDATA%/Apprise/apprise.yaml
2024-03-09 19:41:46 +01:00
# %LOCALAPPDATA%/Apprise/apprise.conf
2024-03-03 23:59:06 +01:00
# %LOCALAPPDATA%/Apprise/apprise.yaml
2024-03-09 19:41:46 +01:00
# %ALLUSERSPROFILE%\Apprise\apprise.conf
2024-03-03 23:59:06 +01:00
# %ALLUSERSPROFILE%\Apprise\apprise.yaml
2024-03-09 19:41:46 +01:00
# %PROGRAMFILES%\Apprise\apprise.conf
2024-03-03 23:59:06 +01:00
# %PROGRAMFILES%\Apprise\apprise.yaml
2024-03-09 19:41:46 +01:00
# %COMMONPROGRAMFILES%\Apprise\apprise.conf
2024-03-03 23:59:06 +01:00
# %COMMONPROGRAMFILES%\Apprise\apprise.yaml
2019-06-30 00:44:29 +02:00
2024-03-09 19:41:46 +01:00
# The configuration files specified above can also be identified with a `.yml`
# extension or even just entirely removing the `.conf` extension altogether.
2019-03-05 05:33:02 +01:00
# If you loaded one of those files, your command line gets really easy:
2020-08-03 16:25:21 +02:00
apprise -vv -t 'my title' -b 'my notification body'
2019-03-05 05:33:02 +01:00
2019-10-01 17:03:01 +02:00
# If you want to deviate from the default paths or specify more than one,
# just specify them using the --config switch:
2020-08-03 16:25:21 +02:00
apprise -vv -t 'my title' -b 'my notification body' \
2020-06-09 23:22:47 +02:00
--config=/path/to/my/config.yml
2019-03-05 05:33:02 +01:00
2019-10-01 17:03:01 +02:00
# Got lots of configuration locations? No problem, you can specify them all:
# Apprise can even fetch the configuration from over a network!
2020-08-03 16:25:21 +02:00
apprise -vv -t 'my title' -b 'my notification body' \
2020-06-09 23:22:47 +02:00
--config=/path/to/my/config.yml \
--config=https://localhost/my/apprise/config
2019-03-05 05:33:02 +01:00
```
2022-07-15 17:27:36 +02:00
## CLI File Attachments
2019-11-17 03:44:17 +01:00
Apprise also supports file attachments too! Specify as many attachments to a notification as you want.
```bash
2019-11-26 01:58:18 +01:00
# Send a funny image you found on the internet to a colleague:
2020-08-03 16:25:21 +02:00
apprise -vv --title 'Agile Joke' \
2019-11-17 03:44:17 +01:00
--body 'Did you see this one yet?' \
--attach https://i.redd.it/my2t4d2fx0u31.jpg \
2020-06-09 23:22:47 +02:00
'mailto://myemail:mypass@gmail.com'
2019-11-17 03:44:17 +01:00
# Easily send an update from a critical server to your dev team
2020-08-03 16:25:21 +02:00
apprise -vv --title 'system crash' \
2019-11-17 03:44:17 +01:00
--body 'I do not think Jim fixed the bug; see attached...' \
--attach /var/log/myprogram.log \
--attach /var/debug/core.2345 \
--tag devteam
```
2022-07-15 17:27:36 +02:00
## CLI Loading Custom Notifications/Hooks
To create your own custom `schema://` hook so that you can trigger your own custom code,
simply include the `@notify` decorator to wrap your function.
```python
from apprise.decorators import notify
#
# The below assumes you want to catch foobar:// calls:
#
@notify (on="foobar", name="My Custom Foobar Plugin")
def my_custom_notification_wrapper(body, title, notify_type, *args, * *kwargs):
"""My custom notification function that triggers on all foobar:// calls
"""
# Write all of your code here... as an example...
print("{}: {} - {}".format(notify_type.upper(), title, body))
# Returning True/False is a way to relay your status back to Apprise.
# Returning nothing (None by default) is always interpreted as a Success
```
Once you've defined your custom hook, you just need to tell Apprise where it is at runtime.
```bash
# By default if no plugin path is specified apprise will attempt to load
# all plugin files (if present) from the following directory paths:
2022-10-23 19:44:16 +02:00
# ~/.apprise/plugins
2022-07-15 17:27:36 +02:00
# ~/.config/apprise/plugins
2023-05-13 04:07:55 +02:00
# /var/lib/apprise/plugins
2022-07-15 17:27:36 +02:00
# Windows users can store their default plugin files in these directories:
# %APPDATA%/Apprise/plugins
# %LOCALAPPDATA%/Apprise/plugins
2023-05-13 04:07:55 +02:00
# %ALLUSERSPROFILE%\Apprise\plugins
# %PROGRAMFILES%\Apprise\plugins
# %COMMONPROGRAMFILES%\Apprise\plugins
2022-07-15 17:27:36 +02:00
# 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:\\
```
2022-07-15 20:58:46 +02:00
You can read more about creating your own custom notifications and/or hooks [here ](https://github.com/caronc/apprise/wiki/decorator_notify ).
2022-07-15 17:27:36 +02:00
# Developer API Usage
2017-11-30 01:51:18 +01:00
To send a notification from within your python application, just do the following:
```python
import apprise
2019-03-05 05:33:02 +01:00
# Create an Apprise instance
2017-12-03 08:00:23 +01:00
apobj = apprise.Apprise()
2017-11-30 01:51:18 +01:00
# Add all of the notification services by their server url.
2019-10-01 17:03:01 +02:00
# A sample email notification:
apobj.add('mailto://myuserid:mypass@gmail.com')
2017-11-30 01:51:18 +01:00
# 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!',
2019-02-18 04:21:59 +01:00
title='my notification title',
2017-11-30 01:51:18 +01:00
)
```
2018-12-16 21:44:28 +01:00
2022-07-15 17:27:36 +02:00
## API Configuration Files
2019-10-01 17:03:01 +02:00
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 ).
2019-03-05 05:33:02 +01:00
```python
import apprise
# Create an Apprise instance
apobj = apprise.Apprise()
# Create an Config instance
2019-03-06 01:40:36 +01:00
config = apprise.AppriseConfig()
2019-03-05 05:33:02 +01:00
# 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
2019-03-29 05:12:12 +01:00
# In this entry we associate the 'admin' tag with our notification
2019-10-01 17:03:01 +02:00
apobj.add('mailto://myuser:mypass@hotmail.com', tag='admin')
2019-03-05 05:33:02 +01:00
# Then notify these services any time you desire. The below would
2019-10-01 17:03:01 +02:00
# notify all of the services that have not been bound to any specific
# tag.
2019-03-05 05:33:02 +01:00
apobj.notify(
body='what a great notification service!',
title='my notification title',
)
2019-03-06 01:40:36 +01:00
2019-10-01 17:03:01 +02:00
# Tagging allows you to specifically target only specific notification
# services you've loaded:
2019-03-06 01:40:36 +01:00
apobj.notify(
2020-06-09 23:22:47 +02:00
body='send a notification to our admin group',
2019-03-06 01:40:36 +01:00
title='Attention Admins',
2019-03-29 05:12:12 +01:00
# notify any services tagged with the 'admin' tag
2019-03-06 01:40:36 +01:00
tag='admin',
)
2019-10-01 17:03:01 +02:00
2022-08-09 19:28:25 +02:00
# If you want to notify absolutely everything (regardless of whether
2019-10-01 17:03:01 +02:00
# it's been tagged or not), just use the reserved tag of 'all':
apobj.notify(
2020-06-09 23:22:47 +02:00
body='send a notification to our admin group',
2019-10-01 17:03:01 +02:00
title='Attention Admins',
2022-08-09 19:28:25 +02:00
# notify absolutely everything loaded, regardless on wether
2019-10-01 17:03:01 +02:00
# it has a tag associated with it or not:
tag='all',
)
2019-03-05 05:33:02 +01:00
```
2022-07-15 17:27:36 +02:00
## API File Attachments
2019-11-17 03:44:17 +01:00
Attachments are very easy to send using the Apprise API:
```python
import apprise
# Create an Apprise instance
apobj = apprise.Apprise()
# Add at least one service you want to notify
apobj.add('mailto://myuser: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
2022-08-09 19:28:25 +02:00
# 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
2019-11-17 03:44:17 +01:00
# this case after 3 seconds).
apobj.notify(
title='Latest security image',
2022-01-12 14:42:11 +01:00
attach='http://admin:password@hikvision-cam01/ISAPI/Streaming/channels/101/picture?cache=3'
2019-11-17 03:44:17 +01:00
)
2019-11-24 04:57:58 +01:00
```
2019-11-17 03:44:17 +01:00
2020-06-09 23:22:47 +02:00
To send more than one attachment, just use a list, set, or tuple instead:
2019-11-24 04:57:58 +01:00
```python
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')
2019-11-17 03:44:17 +01:00
2022-08-09 19:28:25 +02:00
# Now add all of the entries we're interested in:
2020-06-09 23:22:47 +02:00
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',
2019-11-17 03:44:17 +01:00
2020-06-09 23:22:47 +02:00
# Now add another:
'/path/to/funny/joke.gif',
)
2019-11-17 03:44:17 +01:00
# Send your multiple attachments with a single notify call:
apobj.notify(
2020-06-09 23:22:47 +02:00
title='Some good jokes.',
body='Hey guys, check out these!',
attach=attach,
2019-11-17 03:44:17 +01:00
)
```
2022-07-15 17:27:36 +02:00
## API Loading Custom Notifications/Hooks
By default, no custom plugins are loaded at all for those building from within the Apprise API.
It's at the developers discretion to load custom modules. But should you choose to do so, it's as easy
as including the path reference in the `AppriseAsset()` object prior to the initialization of your `Apprise()`
instance.
For example:
```python
from apprise import Apprise
from apprise import AppriseAsset
# Prepare your Asset object so that you can enable the custom plugins to
# be loaded for your instance of Apprise...
asset = AppriseAsset(plugin_paths="/path/to/scan")
# OR You can also generate scan more then one file too:
asset = AppriseAsset(
plugin_paths=[
# Iterate over all python libraries found in the root of the
# specified path. This is NOT a recursive (directory) scan; only
# the first level is parsed. HOWEVER, if a directory containing
# an __init__ .py is found, it will be included in the load.
"/dir/containing/many/python/libraries",
# An absolute path to a plugin.py to exclusively load
"/path/to/plugin.py",
# if you point to a directory that has an __init__ .py file found in
# it, then only that file is loaded (it's similar to point to a
# absolute .py file. Hence, there is no (level 1) scanning at all
# within the directory specified.
"/path/to/dir/library"
2022-08-09 19:28:25 +02:00
]
2022-07-15 17:27:36 +02:00
)
# 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")
```
2024-08-30 00:09:15 +02:00
2022-07-15 20:58:46 +02:00
You can read more about creating your own custom notifications and/or hooks [here ](https://github.com/caronc/apprise/wiki/decorator_notify ).
2024-08-23 03:44:14 +02:00
# 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.
2024-08-25 01:12:23 +02:00
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.
2024-08-23 03:44:14 +02:00
## CLI Persistent Storage Commands
2024-08-25 01:12:23 +02:00
You can provide the keyword `storage` on your CLI call to see the persistent storage options available to you.
2024-08-23 03:44:14 +02:00
```bash
# 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
```
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
```
2024-08-25 01:12:23 +02:00
The (persistent storage) cache states are:
2024-08-23 03:44:14 +02:00
- `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.
2024-08-25 01:12:23 +02:00
You can use this information to filter your results by specifying _URL ID_ (UID) values after your command. For example:
2024-08-23 03:44:14 +02:00
```bash
# 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
```
2024-08-25 01:12:23 +02:00
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.
2024-08-23 03:44:14 +02:00
For more information on persistent storage, [visit here ](https://github.com/caronc/apprise/wiki/persistent_storage ).
## API Persistent Storage Commands
2024-08-25 01:12:23 +02:00
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.
2024-08-23 03:44:14 +02:00
For example:
```python
from apprise import Apprise
from apprise import AppriseAsset
from apprise import PersistentStoreMode
2024-08-25 01:12:23 +02:00
# 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
2024-08-23 03:44:14 +02:00
asset = AppriseAsset(storage_path="/path/to/save/data")
2024-08-25 01:12:23 +02:00
# If you want to be more explicit and set more options, then you may do the
# following
2024-08-23 03:44:14 +02:00
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
2024-08-25 01:12:23 +02:00
# 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,
2024-08-23 03:44:14 +02:00
)
# Now that we've got our asset, we just work with our Apprise object as we
# normally do
aobj = Apprise(asset=asset)
```
For more information on persistent storage, [visit here ](https://github.com/caronc/apprise/wiki/persistent_storage ).
2022-07-15 17:27:36 +02:00
# Want To Learn More?
2019-11-24 04:57:58 +01:00
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 )
2022-07-15 20:58:46 +02:00
* ⚡ [Create Your Own Custom Notifications ](https://github.com/caronc/apprise/wiki/decorator_notify )
2024-08-23 03:44:14 +02:00
* 💾 [Persistent Storage ](https://github.com/caronc/apprise/wiki/persistent_storage )
2020-01-04 22:54:51 +01:00
* 🌎 [Apprise API/Web Interface ](https://github.com/caronc/apprise-api )
2020-01-06 01:07:35 +01:00
* 🎉 [Showcase ](https://github.com/caronc/apprise/wiki/showcase )
2019-11-24 04:57:58 +01:00
2021-08-12 03:49:00 +02:00
Want to help make Apprise better?
2019-11-24 04:57:58 +01:00
* 💡 [Contribute to the Apprise Code Base ](https://github.com/caronc/apprise/wiki/Development_Contribution )
* ❤️ [Sponsorship and Donations ](https://github.com/caronc/apprise/wiki/Sponsors )
