Notifications

Notification Types

Monika will send notifications to you whenever alerts are triggered, e.g., when the response status of a probed URL is not 2xx success code (status-not-2xx).

At this moment, Monika support these channel of notifications (You can use just one or more):

1. Desktop Notifications
2. Discord
3. Facebook Workplace
4. Google Chat
5. Lark Suite
6. Mailgun
7. Microsoft Teams
8. Monika Whatsapp Notifier
9. PagerDuty
10. SendGrid
11. Slack
12. SMTP
13. Telegram
14. Webhook
15. WhatsApp Business
16. Dingtalk
17. Pushover
18. Opsgenie
19. Pushbullet
20. Instatus

Configurations

To use one or more notifications, you need to define the settings in the monika.yml file as shown below.

1 notifications:
2   - id: unique-id-mailgun
3     type: mailgun
4     data:
5       recipients: ['RECIPIENT_EMAIL_ADDRESS1', 'RECIPIENT_EMAIL_ADDRESS2']
6       apiKey: YOUR_API_KEY
7       domain: YOUR_DOMAIN
8 
9   - id: unique-id-sendgrid
10     type: sendgrid
11     data:
12       sender: YOUR_VERIFIED_EMAIL_BY_SENDGRID
13       recipients: ['RECIPIENT_EMAIL_ADDRESS']
14       apiKey: YOUR_API_KEY
15 
16   - id: unique-id-smtp
17     type: smtp
18     data:
19       recipients: ['RECIPIENT_EMAIL_ADDRESS']
20       hostname: SMTP_HOSTNAME
21       port: 587
22       username: SMTP_USERNAME
23       password: SMTP_PASSWORD
24 
25   - id: unique-id-webhook
26     type: webhook
27     data:
28       url: https://WEBHOOK_URL

Note that every triggered alert will be sent to you through all the notifications you defined in the configuration file, e.g., if you added webhook and smtp settings, you will receive the alert messages through both.

Desktop Notifications

Monika supports desktop notifications. Here are the prerequisites for enabling the desktop notifications:

• macOS: Uses OSAScript (Apple Open Scripting Architecture). AppleScript 2.0 or later and macOS version 10.5 or later required.
• Linux: Uses notify-send command. notify-osd or libnotify-bin required (Ubuntu should have this by default).
• Windows: Uses Powershell. Refer to Microsoft Official Documentation for System Requirements.

1 notifications:
2   - id: unique-id-monika-notif
3     type: desktop

Discord

Monika supports Discord. To enable notification via Discord, you must create a discord webhook first. More info at Discord webhook documentation

1 notifications:
2   - id: unique-id-webhook
3     type: discord
4     data:
5       url: https://YOUR_DISCORD_URL

Facebook Workplace

Monika supports Facebook Workplace. To enable notification via Workplace, you must create custom integration first. More info at Facebook Workplace Custom Integrations

1 notifications:
2   - id: unique-workplace-id
3     type: workplace
4     data:
5       thread_id: abcd-123-456
6       access_token: your_custom_integration_access_token

Google Chat

You can send Monika notifications to your Google Chat. First you need to generate the url webhook for Monika to use. To create a webhook:

1. Open Google Chat
2. Go to the space to add notification
3. Select Manage webhook from the top of the page
4. Under Incoming webhook, click Add another if one already exists, in either case you need to provide a name.
5. Name the new webhook and Save
6. Copy the URL in the webhook modal
7. You will need the URL in your monika configuration

For further information check the Google Chat documentations here

Example of Google Chat configuration may be something similar to below:

1 notifications:
2   - id: myGoogleChatNotif
3     type: google-chat
4     data:
5       url: https://chat.googleapis.com/v1/spaces/XXXXX/messages?key=1122334455

Larksuite Notifications

If you use Larksuite, you can get Monika to send notifications to the Larksuite bots. You can create a webhook url, and then use it in the monika configuration.

You can find more information on creating webhooks here.

The Yaml config setup may look something like this:

1 notifications:
2   - id: lark-group-message
3     type: lark
4     data:
5       url: https://open.larksuite.com/open-apis/bot/v2/hook/your-webhook-key-here

Keep watch on these pages, new notification methods are being developed.

Mailgun

Mailgun is an email notification delivery service provided by Mailgun email service. To use mailgun for your notification,

1. You would need a mailgun account.
2. Get your API key by referring to this documentation.
3. For your domain
   • • If you are on the free plan, add authorized recipients as instructed here.
   • • If you want to use your own domain, refer here to add it.
4. After that, put them in monika.yml configuration as follows:

1 notifications:
2   - id: unique-id-mailgun
3     type: mailgun
4     data:
5       recipients: ['RECIPIENT_EMAIL_ADDRESS']
6       apiKey: YOUR_API_KEY
7       domain: YOUR_DOMAIN

Microsoft Teams

Monika supports sending notifications via Microsoft Teams. In order to be able to send notifications via Microsoft Teams, you may need to add Connectors and webhooks to your channel. Please refer to Microsoft Teams Documentation to enable connectors and webhooks.

1 notifications:
2   - id: unique-id-teams
3     type: teams
4     data:
5       url: https://YOUR_TEAMS_WEBHOOK_URL

Monika WhatsApp Notifier

You can get a notification from Monika to your WhatsApp number without having a Whatsapp Business account. First, you must create a Monika Whatsapp Notifier account.

1 notifications:
2   - id: unique-monika-notif-id
3     type: monika-notif
4     data:
5       url: https://YOUR_MONIKA_NOTIF_URL

Please note, to receive messages from the WhatsApp cloud API the following requirements are mandatory.

• The recipient phone number must be a WhatsApp phone number.
• The recipient must accept Meta's new Terms of Service and Privacy Policy.
• The recipient must use the following WhatsApp version or greater:
  Android: 2.21.15.15
  SMBA: 2.21.15.15
  iOS: 2.21.170.4
  SMBI: 2.21.170.4
  KaiOS: 2.2130.10
  Web: 2.2132.6

PagerDuty

PagerDuty is a platform for agile incident management. You need the integration key to use PagerDuty which you can get by following the steps in PagerDuty's services and integration docs. To give you the flexibility to choose which probe belongs to which PagerDuty service. You need to map the PagerDuty integration key with your Monika probe id in the configuration.

1 notifications:
2   - id: unique-id-pagerduty-notify
3     type: pagerduty
4     data:
5       - key: YOUR_PAGERDUTY_INTEGRATION_KEY
6         probeID: ZN32nw_KsvTKtLFNu55JV

Sendgrid

Similar to mailgun, sendgrid is also an email delivery service. Make sure you have a sendgrid account. To obtain your API key, refer to sendgrid documentation. Then put the API key in Monika's configuration as follows:

1 notifications:
2   - id: unique-id-sendgrid
3     type: sendgrid
4     data:
5       sender: YOUR_VERIFIED_EMAIL_BY_SENDGRID
6       recipients: ['RECIPIENT_EMAIL_ADDRESS1', 'RECIPEIENT_EMAIL_ADDRESS2']
7       apiKey: YOUR_API_KEY

Slack Incoming Webhook

Monika supports Slack Incoming Webhook. To enable notification via Slack, you must have a Slack's Incoming Webhook URL. Please consult the Sending messages using Incoming Webhooks documentation.

1 notifications:
2   - id: unique-id-slack
3     type: slack
4     data:
5       url: https://YOUR_SLACK_INCOMING_WEBHOOK_URL

SMTP

SMTP (Simple Mail Transfer Protocol) is a way to send email using the TCP/IP protocol. This is the easiest way to get notified when alerts are triggered. Use the following configuration to set up SMTP notification.

1 notifications:
2   - id: unique-id-smtp
3     type: smtp
4     data:
5       recipients: ['RECIPIENT_EMAIL_ADDRESS']
6       hostname: smtp.mail.com
7       port: 587
8       username: SMTP_USERNAME
9       password: SMTP_PASSWORD

Example using Gmail SMTP

To use Gmail SMTP with Monika,

1. You need to have a Gmail account.
2. Use smtp.gmail.com for hostname.
3. Use 587 for port.
4. Use your Gmail address for username.
5. Use your Gmail password for password.
   1. If you have activated 2-Factor-Authentication (2FA), you need to create an App Password from your Account Settings. Then use the app password for password.

Statuspage

Statuspage is a status and incident communication tool. You need a page ID and an API key to use Statuspage. You can obtain it by following the steps in the documentation.

1 notifications:
2   - id: unique-id-statuspage
3     type: statuspage
4     data:
5       apiKey: YOUR_STATUSPAGE_API_KEY
6       pageID: YOUR_STATUSPAGE_PAGE_ID

Telegram

Monika supports Telegram. To enable notification via Telegram, you must have a Telegram bot. Please consult Bots: An introduction for developers.

1 notifications:
2   - id: unique-id-telegram
3     type: telegram
4     data:
5       group_id: YOUR_GROUP_ID
6       bot_token: YOUR_BOT_TOKEN

Webhook

Monika supports Webhook. To enable notification via Webhook.

1 notifications:
2   - id: unique-id-webhook
3     type: webhook
4     data:
5       url: https://YOUR_WEBHOOK_URL

Using the webhook type configuration, Monika will send a request with the following body:

1 body: {
2   url: string
3   time: string
4   alert: string
5 }

Whatsapp Business

Monika supports notifications from Whatsapp for business accounts. To enable notifications via WhatsApp for business, you must have a registered user in the WhatsApp business API server. Please refer to WhatsApp Business API documentation.

1 notifications:
2   - id: unique-whatsapp-id
3     type: whatsapp
4     data:
5       recipients: ['628123456789', '3804321234']
6       url: https://yourwhatsappapiserver.com
7       username: whatsappusername
8       password: whatsapppassword

Dingtalk

Monika supports Dingtalk. To enable notification via Dingtalk, you must create a robot webhook first. More info at Dingtalk robot webhook Dingtalk documentation and Alibaba cloud documentation.

1 notifications:
2   - id: unique-id-webhook
3     type: dingtalk
4     data:
5       access_token: YOUR_ACCESS_TOKEN

Gotify

Monika supports Gotify. To enable notification via Gotify, you must have a Gotify Server's URL and application token. Gotify is an open source notification server with several different clients. More info at Gotify documentation.

1 notifications:
2   - id: unique-id-gotify
3     type: gotify
4     data:
5       url: GOTIFY_URL
6       token: GOTIFY_TOKEN

Pushover

Monika supports Pushover. To enable notification via Pushover, you must create a pushover application first. More info at Pushover documentation.

1 notifications:
2   - id: unique-id-webhook
3     type: pushover
4     data:
5       token: PUSHOVER_TOKEN
6       user: PUSHOVER_USER

Opsgenie

Monika supports Opsgenie. To enable notification via Opsgenie, you must create a team, then create an integration, and finally add an API. More info at Opsgenie documentation.

1 notifications:
2   - id: unique-id-opsgenie
3     type: opsgenie
4     data:
5       geniekey: GENIE_KEY

Pushbullet

Monika supports Pushbullet. To enable notification via Pushbullet, you must create an account and create your access token. You can create an access token at Pushbullet Settings Page.

Optionally, you can push notifications to specific devices by running the command below:

1 curl --header 'Access-Token: <your_access_token_here>' \
2      https://api.pushbullet.com/v2/devices

Then, you can put the iden value from the API response to the deviceID at the Monika configuration properties.

More info at Pushbullet Documentation.

1 notifications:
2   - id: unique-id-pushbullet
3     type: pushbullet
4     data:
5       token: PUSBULLET_ACCESS_TOKEN
6       deviceID: PUSHBULLET_DEVICE_ID

Instatus

Instatus is a status and incident communication tool. You need a page ID and an API key to use Instatus. You can obtain it by following the steps in the documentation.

1 notifications:
2   - id: unique-id-instatus
3     type: instatus
4     data:
5       apiKey: YOUR_INSTATUS_API_KEY
6       pageID: YOUR_INSTATUS_PAGE_ID //You can get it with client.pages.get()