Providers
API documentation for the different providers.
- class notifiers.providers.email.SMTP[source]
Send emails via SMTP
- base_url = None
- name = 'email'
- site_url = 'https://en.wikipedia.org/wiki/Email'
- class notifiers.providers.gitter.Gitter[source]
Send Gitter notifications
- message_url = '/{room_id}/chatMessages'
- site_url = 'https://gitter.im'
- class notifiers.providers.gitter.GitterMixin[source]
Shared attributes between
GitterRooms
andGitter
- base_url = 'https://api.gitter.im/v1/rooms'
- name = 'gitter'
- path_to_errors = ('errors', 'error')
- class notifiers.providers.gitter.GitterRooms[source]
Returns a list of Gitter rooms via token
- resource_name = 'rooms'
- class notifiers.providers.gmail.Gmail[source]
Send email via Gmail
- base_url = 'smtp.gmail.com'
- name = 'gmail'
- site_url = 'https://www.google.com/gmail/about/'
- class notifiers.providers.icloud.iCloud[source]
Send email via iCloud
- base_url = 'smtp.mail.me.com'
- name = 'icloud'
- site_url = 'https://www.icloud.com/mail'
- class notifiers.providers.join.Join[source]
Send Join notifications
- push_url = '/sendPush'
- site_url = 'https://joaoapps.com/join/api/'
- class notifiers.providers.join.JoinDevices[source]
Return a list of Join devices IDs
- devices_url = '/listDevices'
- resource_name = 'devices'
- class notifiers.providers.join.JoinMixin[source]
Shared resources between
Join
andJoinDevices
- base_url = 'https://joinjoaomgcd.appspot.com/_ah/api/messaging/v1'
- name = 'join'
- class notifiers.providers.pushbullet.Pushbullet[source]
Send Pushbullet notifications
- base_url = 'https://api.pushbullet.com/v2/pushes'
- site_url = 'https://www.pushbullet.com'
- class notifiers.providers.pushbullet.PushbulletDevices[source]
Return a list of Pushbullet devices associated to a token
- devices_url = 'https://api.pushbullet.com/v2/devices'
- resource_name = 'devices'
- class notifiers.providers.pushbullet.PushbulletMixin[source]
Shared attributes between
PushbulletDevices
andPushbullet
- name = 'pushbullet'
- path_to_errors = ('error', 'message')
- class notifiers.providers.pushover.Pushover[source]
Send Pushover notifications
- message_url = 'messages.json'
- name = 'pushover'
- site_url = 'https://pushover.net/'
- class notifiers.providers.pushover.PushoverLimits[source]
- limits_url = 'apps/limits.json'
- resource_name = 'limits'
- class notifiers.providers.pushover.PushoverMixin[source]
- base_url = 'https://api.pushover.net/1/'
- name = 'pushover'
- path_to_errors = ('errors',)
- class notifiers.providers.pushover.PushoverSounds[source]
- resource_name = 'sounds'
- sounds_url = 'sounds.json'
- class notifiers.providers.simplepush.SimplePush[source]
Send SimplePush notifications
- base_url = 'https://api.simplepush.io/send'
- name = 'simplepush'
- site_url = 'https://simplepush.io/'
- class notifiers.providers.slack.Slack[source]
Send Slack webhook notifications
- base_url = 'https://hooks.slack.com/services/'
- name = 'slack'
- site_url = 'https://api.slack.com/incoming-webhooks'
- class notifiers.providers.telegram.Telegram[source]
Send Telegram notifications
- push_endpoint = '/sendMessage'
- site_url = 'https://core.telegram.org/'
- class notifiers.providers.telegram.TelegramMixin[source]
Shared resources between
TelegramUpdates
andTelegram
- base_url = 'https://api.telegram.org/bot{token}'
- name = 'telegram'
- path_to_errors = ('description',)
- class notifiers.providers.telegram.TelegramUpdates[source]
Return Telegram bot updates, correlating to the getUpdates method. Returns chat IDs needed to notifications
- resource_name = 'updates'
- updates_endpoint = '/getUpdates'
- class notifiers.providers.zulip.Zulip[source]
Send Zulip notifications
- api_endpoint = '/api/v1/messages'
- base_url = 'https://{domain}.zulipchat.com'
- name = 'zulip'
- path_to_errors = ('msg',)
- site_url = 'https://zulipchat.com/api/'
- class notifiers.providers.twilio.Twilio[source]
Send an SMS via a Twilio number
- base_url = 'https://api.twilio.com/2010-04-01/Accounts/{}/Messages.json'
- name = 'twilio'
- path_to_errors = ('message',)
- site_url = 'https://www.twilio.com/'
- class notifiers.providers.pagerduty.PagerDuty[source]
Send PagerDuty Events
- base_url = 'https://events.pagerduty.com/v2/enqueue'
- name = 'pagerduty'
- path_to_errors = ('errors',)
- site_url = 'https://v2.developer.pagerduty.com/'
- class notifiers.providers.mailgun.MailGun[source]
Send emails via MailGun
- base_url = 'https://api.mailgun.net/v3/{domain}/messages'
- defaults = {'base_url': 'https://api.mailgun.net'}
- name = 'mailgun'
- path_to_errors = ('message',)
- site_url = 'https://documentation.mailgun.com/'
- class notifiers.providers.popcornnotify.PopcornNotify[source]
Send PopcornNotify notifications
- base_url = 'https://popcornnotify.com/notify'
- name = 'popcornnotify'
- path_to_errors = ('error',)
- site_url = 'https://popcornnotify.com/'
- class notifiers.providers.statuspage.Statuspage[source]
Create Statuspage incidents
- incidents_url = 'incidents.json'
- realtime_statuses = ['investigating', 'identified', 'monitoring', 'resolved']
- scheduled_statuses = ['scheduled', 'in_progress', 'verifying', 'completed']
- class notifiers.providers.statuspage.StatuspageComponents[source]
Return a list of Statuspage components for the page ID
- components_url = 'components.json'
- resource_name = 'components'
- class notifiers.providers.statuspage.StatuspageMixin[source]
Shared resources between
Statuspage
andStatuspageComponents
- base_url = 'https://api.statuspage.io/v1//pages/{page_id}/'
- name = 'statuspage'
- path_to_errors = ('error',)
- site_url = 'https://statuspage.io'