Note: You are looking at a static snapshot of documentation related to Robot Framework automations. The most recent documentation is at https://robocorp.com/docs
RPA.Notifier
Generic keyword to use with any notifier provider.
Arguments
| Argument | Type | Default value |
|---|---|---|
| provider_name | str | null |
| kwargs | null |
| param provider_name: | name of the notifier service |
|---|---|
| param kwargs: | see library documentation |
| return: | True if notification was successful, False if not |
Notify using email provider
Arguments
| Argument | Type | Default value |
|---|---|---|
| message | str, None | None |
| to | str, None | None |
| username | str, None | None |
| password | str, None | None |
| host | str, None | None |
| port | int | 587 |
| tls | bool | True |
| kwargs | null |
| 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 using Gmail provider
Arguments
| Argument | Type | Default value |
|---|---|---|
| message | str, None | None |
| to | str, None | None |
| username | str, None | None |
| password | str, None | None |
| kwargs | null |
| 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 using Pushover provider
Arguments
| Argument | Type | Default value |
|---|---|---|
| message | str, None | None |
| user | str, None | None |
| token | str, None | None |
| kwargs | null |
| 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 using Slack provider
Arguments
| Argument | Type | Default value |
|---|---|---|
| message | str, None | None |
| channel | str, None | None |
| webhook_url | str, None | None |
| kwargs | null |
| 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 using Telegram provider
Arguments
| Argument | Type | Default value |
|---|---|---|
| message | str, None | None |
| chat_id | str, None | None |
| token | str, None | None |
| kwargs | null |
| 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 using Twilio provider
Arguments
| Argument | Type | Default value |
|---|---|---|
| message | str, None | None |
| number_from | str, None | None |
| number_to | str, None | None |
| account_sid | str, None | None |
| token | str, None | None |
| kwargs | null |
| 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 |