Notification Workflows

When an anomaly is identified it becomes available in the UI and can be sent to the user’s preferred notification workflow. To configure notifications, navigate to the Notifications and Digest Settings page under Settings.

Choose the workflow#

This configuration determines where notifications will be sent.

There are two simple workflows available: email and Slack. WhyLabs also supports more complex notifications, like PagerDuty, ServiceNow, and other workflows that allow API key or webhook-based integration.

The user can select one or multiple workflows. We recommend using the workflow that matches the team's existing process.

WhyLabs Notifications

If you would like to use a notification workflow that is not covered in this document, please submit a request through WhyLabs Support.

Email Notifications#

To set up email notifications, we recommend creating a mailing list dedicated to WhyLabs Notifications, so that multiple team members can subscribe to it. Please work with your email administrator to configure permissions for the mailing list to receive external messages.

Slack Notifications#

To set up Slack notifications, we recommend creating a dedicated Slack channel for WhyLabs Notifications. Make sure all relevant team members are subscribed to the channel.

To obtain the Slack webhook, please follow Slack documentation: https://api.slack.com/messaging/webhooks.

PagerDuty Notifications#

To set up PagerDuty Notifications, please follow the steps below:

  1. In PagerDuty, create a Service to receive WhyLabs Alerts
  2. Once created, go to Integrations tab for this Service
  3. Click Add New Integration
  4. Select Events API V2
  5. [Optional] Rename this integration (e.g. WhyLabs Event Notifications)
  6. Copy the integration key, you’ll need it for the next step
  7. Go to notification settings in WhyLabs
  8. Enable PagerDuty Notifications
  9. Paste your integration key and set a schedule for your Notifications

Notification Content#

Notifications will include a breakdown of Alerts detected since the last Notification was sent. Where applicable, the messages will be grouped by Organization and Model ID. For example, the PagerDuty Notification may look like this:

{
"payload": {
"summary": "Example alert from WhyLabs",
"timestamp": "2021-07-7T08:42:58.315+0000",
"source": "whylabs",
"severity": "error",
"component": "whylogs",
"custom_details": {
"total_alerts": 15,
"alert_counts": {
"missingValues": 10,
"distributionDrift": 5
},
"most_alerted_features": ["featureA", "featureB", "featureC"]
}
},
"routing_key": "integration-key",
"dedup_key": "org-0:model-0",
"links": [{
"href": "https://hub.whylabsapp.com/models/model-0/alerts",
"text": "Lending Club alerts"
}],
"event_action": "trigger"
}

If the base Notification template does not work for your use case, and your team would like to receive customized Notifications instead, please reach out to us.

Prefooter Illustration Mobile
Run AI With Certainty
Get started for free
Prefooter Illustration