Providers

API documentation for the different providers.

class notifiers.providers.email.SMTP

Send emails via SMTP

base_url = None

property defaults

A dict of default provider values if such is needed

name = 'email'

site_url = 'https://en.wikipedia.org/wiki/Email'

class notifiers.providers.gitter.Gitter

Send Gitter notifications

message_url = '/{room_id}/chatMessages'

property metadata

Returns a dict of the provider metadata as declared. Override if needed.

site_url = 'https://gitter.im'

class notifiers.providers.gitter.GitterMixin

Shared attributes between GitterRooms and Gitter

base_url = 'https://api.gitter.im/v1/rooms'

name = 'gitter'

path_to_errors = ('errors', 'error')

class notifiers.providers.gitter.GitterRooms

Returns a list of Gitter rooms via token

resource_name = 'rooms'

class notifiers.providers.gmail.Gmail

Send email via Gmail

base_url = 'smtp.gmail.com'

property defaults

A dict of default provider values if such is needed

name = 'gmail'

site_url = 'https://www.google.com/gmail/about/'

class notifiers.providers.hipchat.HipChat

Send HipChat notifications

room_notification = '/{room}/notification'

site_url = 'https://www.hipchat.com/docs/apiv2'

user_message = '/{user}/message'

class notifiers.providers.hipchat.HipChatMixin

Shared attributed between resources and HipChatResourceProxy

base_url = 'https://{group}.hipchat.com'

name = 'hipchat'

path_to_errors = ('error', 'message')

rooms_url = '/v2/room'

users_url = '/v2/user'

class notifiers.providers.hipchat.HipChatResourceMixin

Common resources attributes that should not override HipChat attributes

class notifiers.providers.hipchat.HipChatRooms

Return a list of HipChat rooms

resource_name = 'rooms'

class notifiers.providers.hipchat.HipChatUsers

Return a list of HipChat users

resource_name = 'users'

class notifiers.providers.join.Join

Send Join notifications

property defaults

A dict of default provider values if such is needed

push_url = '/sendPush'

site_url = 'https://joaoapps.com/join/api/'

class notifiers.providers.join.JoinDevices

Return a list of Join devices IDs

devices_url = '/listDevices'

resource_name = 'devices'

class notifiers.providers.join.JoinMixin

Shared resources between Join and JoinDevices

base_url = 'https://joinjoaomgcd.appspot.com/_ah/api/messaging/v1'

name = 'join'

class notifiers.providers.pushbullet.Pushbullet

Send Pushbullet notifications

base_url = 'https://api.pushbullet.com/v2/pushes'

property defaults

A dict of default provider values if such is needed

site_url = 'https://www.pushbullet.com'

class notifiers.providers.pushbullet.PushbulletDevices

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

Shared attributes between PushbulletDevices and Pushbullet

name = 'pushbullet'

path_to_errors = ('error', 'message')

class notifiers.providers.pushover.Pushover

Send Pushover notifications

message_url = 'messages.json'

property metadata

Returns a dict of the provider metadata as declared. Override if needed.

name = 'pushover'

site_url = 'https://pushover.net/'

class notifiers.providers.pushover.PushoverLimits

limits_url = 'apps/limits.json'

resource_name = 'limits'

class notifiers.providers.pushover.PushoverMixin

base_url = 'https://api.pushover.net/1/'

name = 'pushover'

path_to_errors = ('errors',)

class notifiers.providers.pushover.PushoverResourceMixin

class notifiers.providers.pushover.PushoverSounds

resource_name = 'sounds'

sounds_url = 'sounds.json'

class notifiers.providers.simplepush.SimplePush

Send SimplePush notifications

base_url = 'https://api.simplepush.io/send'

name = 'simplepush'

site_url = 'https://simplepush.io/'

class notifiers.providers.slack.Slack

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

Send Telegram notifications

push_endpoint = '/sendMessage'

site_url = 'https://core.telegram.org/'

class notifiers.providers.telegram.TelegramMixin

Shared resources between TelegramUpdates and Telegram

base_url = 'https://api.telegram.org/bot{token}'

name = 'telegram'

path_to_errors = ('description',)

class notifiers.providers.telegram.TelegramUpdates

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

Send Zulip notifications

api_endpoint = '/api/v1/messages'

base_url = 'https://{domain}.zulipchat.com'

property defaults

A dict of default provider values if such is needed

name = 'zulip'

path_to_errors = ('msg',)

site_url = 'https://zulipchat.com/api/'

class notifiers.providers.twilio.Twilio

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

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

Send emails via MailGun

base_url = 'https://api.mailgun.net/v3/{domain}/messages'

name = 'mailgun'

path_to_errors = ('message',)

site_url = 'https://documentation.mailgun.com/'

class notifiers.providers.popcornnotify.PopcornNotify

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

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

Return a list of Statuspage components for the page ID

components_url = 'components.json'

resource_name = 'components'

class notifiers.providers.statuspage.StatuspageMixin

Shared resources between Statuspage and StatuspageComponents

base_url = 'https://api.statuspage.io/v1//pages/{page_id}/'

name = 'statuspage'

path_to_errors = ('error',)

site_url = 'https://statuspage.io'