Generic Notify

Generic keyword to use with any notifier provider.

Arguments

Argument Type Default value Description
provider_namestrnullname of the notifier service
kwargsnullsee library documentation
param provider_name:
 name of the notifier service
param kwargs:see library documentation
return:True if notification was successful, False if not

Notify Email

Notify using email provider

Arguments

Argument Type Default value Description
messagestr, NoneNonenotification message
tostr, NoneNonetarget of email message
usernamestr, NoneNoneemail account username
passwordstr, NoneNoneemail account password
hoststr, NoneNoneemail SMTP host name
portint587email SMTP host port number
tlsboolTrueshould TLS be used (default True)
kwargsnullsee library documentation
param message:notification message
param to:target of email message
param username:email account username
param password:email account password
param host:email SMTP host name
param port:email SMTP host port number
param tls:should TLS be used (default True)
param kwargs:see library documentation
return:True if notification was successful, False if not

Example.


# Notify with Outlook account
Notify Email
...   message=Message from the Robot
...   to=RECIPIENT_EMAIL_ADDRESS
...   username=OUTLOOK_USERNAME
...   password=OUTLOOK_PASSWORD
...   host=smtp.office365.com
...   subject=Subject of the Message

Notify Gmail

Notify using Gmail provider

Arguments

Argument Type Default value Description
messagestr, NoneNonenotification message
tostr, NoneNonetarget of email message
usernamestr, NoneNoneGMail account username
passwordstr, NoneNoneGMail account password
kwargsnullsee library documentation
param message:notification message
param to:target of email message
param username:GMail account username
param password:GMail account password
param kwargs:see library documentation
return:True if notification was successful, False if not

Notify Pushover

Notify using Pushover provider

Arguments

Argument Type Default value Description
messagestr, NoneNonenotification message
userstr, NoneNonetarget user for the notification
tokenstr, NoneNoneservice token
kwargsnullsee library documentation
param message:notification message
param user:target user for the notification
param token:service token
param kwargs:see library documentation
return:True if notification was successful, False if not

Notify Slack

Notify using Slack provider

Arguments

Argument Type Default value Description
messagestr, NoneNonenotification message
channelstr, NoneNonetarget channel for the notification
webhook_urlstr, NoneNoneSlack webhook url
kwargsnullsee library documentation
param message:notification message
param channel:target channel for the notification
param webhook_url:
 Slack webhook url
param kwargs:see library documentation
return:True if notification was successful, False if not

Notify Telegram

Notify using Telegram provider

Arguments

Argument Type Default value Description
messagestr, NoneNonenotification message
chat_idstr, NoneNonetarget chat id for the notification
tokenstr, NoneNoneservice token
kwargsnullsee library documentation
param message:notification message
param chat_id:target chat id for the notification
param token:service token
param kwargs:see library documentation
return:True if notification was successful, False if not

Notify Twilio

Notify using Twilio provider

Arguments

Argument Type Default value Description
messagestr, NoneNonenotification message
number_fromstr, NoneNonenumber where the message comes from
number_tostr, NoneNonenumber where the messages goes to
account_sidstr, NoneNoneTwilio account SID
tokenstr, NoneNoneTwilio account token
kwargsnullsee library documentation
param message:notification message
param number_from:
 number where the message comes from
param number_to:
 number where the messages goes to
param account_sid:
 Twilio account SID
param token:Twilio account token
param kwargs:see library documentation
return:True if notification was successful, False if not