Documentation OnCall Manage Notifications Push notifications

Configure push notifications for Grafana OnCall OSS

Grafana OnCall OSS allows you to set up a personal notification webhook, which provides flexibility and control over how you receive push notifications.

To enable push notifications as a notification method, you can configure a webhook to send notifications via a third-party push notification service, such as Pushover, ntfy, or Gotify.

Configure webhooks for push notifications

The personal notification webhook feature allows you to configure customized notifications based on your preferred push notification provider. The configuration process is similar across push notification services like Pushover, Gotify, or ntfy.

Choose a push notification provider

• Pushover – Third-party push notification service.
• ntfy – Open-source push notification service.
• Gotify – Self-hosted push notification server.

Create an outgoing webhook in OnCall OSS

1. Navigate to Outgoing Webhooks in Grafana OnCall OSS.
2. Click + Outgoing Webhook, then select Advanced.
3. Set the Trigger Type to Personal Notification.
4. Configure the webhook:
   • URL: Enter the URL for your chosen push notification service.
   • Method: POST
   • Headers: (Optional, based on service requirements.)
   • Body: Ensure the message format aligns with the selected service.
5. Click Save.

Assign the webhook as a personal notification channel

1. Navigate to your User Profile.
2. Under Notification Channels, click Connect for Webhook.
3. On the Webhook Connection tab, select the webhook created in the previous step.
4. If you used a templated webhook URL, define your JSON key/value in the Context section.
5. Add the webhook as a notification step in your notification rules.

Once configured, notifications from OnCall OSS will be sent through the webhook to your chosen push notification provider. Ensure all necessary configurations are completed with your provider.

Example: Configure Pushover for OnCall OSS

Before you begin, ensure you have:

• A Pushover account (sign up at pushover.net).
• The Pushover mobile app installed and configured (iOS/Android). Ensure notifications are enabled and can override Do Not Disturb (DnD) mode if needed.
• A Pushover API token (generated from the Pushover website).
• Administrator access to your Grafana OnCall OSS instance.

Create a Pushover application

1. Log in to Pushover.
2. Navigate to Apps & Plugins > Create an Application.
3. Enter an Application Name (e.g., Grafana OnCall Alerts).
4. Copy and save the API token provided.

Configure an outgoing webhook in OnCall

1. In Grafana OnCall OSS, go to Outgoing Webhooks.
2. Click + Outgoing Webhook, then select Advanced.
3. Set the Trigger Type to Personal Notification.
4. Configure the webhook:
   • URL: https://api.pushover.net/1/messages.json
   • Method: POST
   • Headers:

json Copy

{
  "Content-Type": "application/json"
}

• Body:

json Copy

{
  "token": "YOUR_PUSHOVER_APP_TOKEN",
  "user": "USER_KEY",
  "message": "New Alert: {{ alert_title }}",
  "title": "Grafana OnCall Alert"
}

1. Replace YOUR_PUSHOVER_APP_TOKEN with your Pushover API token.
2. Replace USER_KEY with your personal Pushover key.
3. Click Save & test to verify the configuration.

Assign the webhook as a personal notification channel

1. Navigate to User Profile.
2. Under Notification Channels, click Connect for Webhook.
3. Select the webhook created in the previous step from the dropdown.
4. (Optional) Provide additional context data for webhook templates in JSON key/value pair.
5. Add the webhook as a notification step in your notification rules.

Example: Configure push notifications with ntfy

ntfy is an open-source push notification service that allows you to send notifications via REST API. A simple message can be sent using:

bash Copy

curl -d "Backup successful 😀" ntfy.sh/mytopic

For more customization options, refer to the ntfy documentation.

Set up an outgoing webhook for ntfy

1. In Grafana OnCall OSS, click + Outgoing Webhook, then select Advanced.
2. Set the Trigger Type to Personal Notification.
3. Configure the webhook:
   • URL: https://ntfy.sh/{{ user_defined_topic }}
   • Method: POST
   • Headers:

json Copy

{
  "Title": "Grafana OnCall Alert",
  "Priority": "5"
}

• Body:

json Copy

{
  "message": "New Alert: {{ alert_title }}"
}

4. Click Save.

Once configured, each user can set up a new notification channel in their profile and provide a ntfy_topic key with their desired topic name as the value.

Assign the webhook as a personal notification channel

1. Navigate to User Profile.
2. Under Notification Channels, click Connect for Webhook.
3. Select the webhook created in the previous step.
4. In the Context section, define your ntfy_topic as a JSON key/value pair.
5. Add the webhook as a notification step in your notification rules.

Related configuration

• Configure webhooks as personal notification channels
• Configure phone and SMS notifications