forked from caronc/apprise
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
215 lines (167 loc) · 6.88 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
ap·prise / verb
To inform or tell (someone). To make one aware of something.
Apprise allows you to send a notification to *almost* all of the most popular notification services available to us today such as: Telegram, Pushbullet, Slack, Twitter, etc.
* One notification library to rule them all.
* A common and intuitive notification syntax.
* Supports the handling of images (to the notification services that will accept them).
System owners who wish to provide a notification service no longer need to research each and every new one as they appear. They just need to include this one library and then they can immediately gain access to a wide range of _almost_ all of the notifications services available to us today.
System Administrators who wish to send a notification from a scheduled task or from the command line also no longer need to find the right tool for the job. Everything is already wrapped and supported within the *apprise* script that ships with this product.
Supported Notifications
=======================
The section identifies all of the services supported by this script. For more indepth details on how each of these notification services work, check out the wiki here: https://github.com/caronc/apprise/wiki/
Popular Notification Services
-----------------------------
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.
* Boxcar
boxcar://hostname
boxcar://hostname/@tag
boxcar://hostname/device_token
boxcar://hostname/device_token1/device_token2/device_tokenN
boxcar://hostname/@tag/@tag2/device_token
* Discord
discord://webhook_id/webhook_token
discord://avatar@webhook_id/webhook_token
* Emby
emby://user@hostname/
emby://user:password@hostname
* Faast
faast://authorizationtoken
* Gnome Notifications
gnome://
* Growl
growl://hostname
growl://hostname:portno
growl://password@hostname
growl://password@hostname:port
Note: you can also use the get parameter version which can allow the growl request to behave using the older v1.x protocol. An example would look like:
growl://hostname?version=1
* IFTTT
ifttt://webhooksID/EventToTrigger
ifttt://webhooksID/EventToTrigger/Value1/Value2/Value3
ifttt://webhooksID/EventToTrigger/?Value3=NewEntry&Value2=AnotherValue
* Join
join://apikey/device
join://apikey/device1/device2/deviceN/
join://apikey/group
join://apikey/groupA/groupB/groupN
join://apikey/DeviceA/groupA/groupN/DeviceN/
* KODI
kodi://hostname
kodi://user@hostname
kodi://user:password@hostname:port
* Matrix
matrix://token
matrix://user@token
matrixs://token?mode=slack
matrixs://user@token?mode=matrix
* Mattermost
mmost://hostname/authkey
mmost://hostname:80/authkey
mmost://user@hostname:80/authkey
mmost://hostname/authkey?channel=channel
mmosts://hostname/authkey
mmosts://user@hostname/authkey
* Prowl
prowl://apikey
prowl://apikey/providerkey
* Pushalot
palot://authorizationtoken
* PushBullet
pbul://accesstoken
pbul://accesstoken/#channel
pbul://accesstoken/A_DEVICE_ID
pbul://accesstoken/[email protected]
pbul://accesstoken/#channel/#channel2/[email protected]/DEVICE
* Pushjet
pjet://secret
pjet://secret@hostname
pjet://secret@hostname:port
pjets://secret@hostname
pjets://secret@hostname:port
Note: if no hostname defined https://api.pushjet.io will be used
* Pushover
pover://user@token
pover://user@token/DEVICE
pover://user@token/DEVICE1/DEVICE2/DEVICEN
* Rocket.Chat
rocket://user:password@hostname/RoomID/Channel
rockets://user:password@hostname:443/Channel1/Channel1/RoomID
rocket://user:password@hostname/Channel
* Slack
slack://TokenA/TokenB/TokenC/Channel
slack://botname@TokenA/TokenB/TokenC/Channel
slack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelN
* Stride
stride://auth_token/cloud_id/convo_id
* Super Toasty
toasty://user@DEVICE
toasty://user@DEVICE1/DEVICE2/DEVICEN
* Telegram
tgram://bottoken/ChatID
tgram://bottoken/ChatID1/ChatID2/ChatIDN
* Twitter
tweet://user@CKey/CSecret/AKey/ASecret
* XBMC
xbmc://hostname
xbmc://user@hostname
xbmc://user:password@hostname:port
* Windows Notifications
windows://
Email Support
-------------
* mailto://
mailto://userid:[email protected]://domain.com?user=userid&pass=password
mailto://domain.com:2525?user=userid&pass=password
mailto://[email protected]&pass=password
mailto://mySendingUsername:[email protected][email protected]
mailto://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply
* mailtos//
mailtos://userid:[email protected]
mailtos://domain.com?user=userid&pass=password
mailtos://domain.com:465?user=userid&pass=passwordmailtos://[email protected]&pass=password
mailtos://mySendingUsername:[email protected][email protected]
mailtos://userid:[email protected]?smtp=mail.example.com&[email protected]&name=no%20reply
Apprise have some email services built right into it (such as yahoo, fastmail, hotmail, gmail, etc) that greatly simplify the mailto:// service.
Custom Notifications
--------------------
* JSON
json://hostnamejson://user@hostname
json://user:password@hostname:port
json://hostname/a/path/to/post/to
* XML
xml://hostname
xml://user@hostname
xml://user:password@hostname:port
xml://hostname/a/path/to/post/to
Installation
============
The easiest way is to install this package is from pypi:
pip install apprise
Command Line
============
A small command line tool is also provided with this package called apprise. If you know the server url's 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 to specify as you can easily chain them together:
apprise -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 -t 'cpu info' \
'mailto://myemail:[email protected]'
Developers
==========
To send a notification from within your python application, just do the following:
import apprise
# Create an Apprise instance
apobj = apprise.Apprise()
# Add all of the notification services by their server url.
# A sample email notification
apobj.add('mailto://myemail:[email protected]')
# A sample pushbullet notification
apobj.add('pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b')
# Then notify these services any time you desire. The below would
# notify all of the services loaded into our Apprise object.
apobj.notify(
title='my notification title',
body='what a great notification service!',
)
If you're interested in reading more about this and methods on how to customize your own notifications, please check out the wiki at https://github.com/caronc/apprise/wiki/Development_API