LogoLogo
AboutBlogLaunch app ↗
v0.23.x
v0.23.x
  • Get Started
  • Overview
  • Getting Access to Distributional
  • Install the Python SDK
  • Quickstart
  • Learning about Distributional
    • Distributional Concepts
    • Why We Test Data Distributions
    • The Flow of Data
  • Using Distributional
    • Projects
    • Runs
      • Reporting Runs
      • Setting a Baseline Run
    • Metrics
    • Tests
      • Creating Tests
        • Using Filters in Tests
        • Available Statistics and Assertions
      • Running Tests
      • Reviewing Tests
        • What Is a Similarity Index?
    • Notifications
    • Access Controls
      • Organization and Namespaces
      • Users and Permissions
      • Tokens
  • Platform
    • Sandbox
    • Self-hosted
      • Architecture
      • Deployment
        • Helm Chart
        • Terraform Module
      • Networking
      • OIDC Authentication
      • Data Security
  • Reference
    • Query Language
      • Functions
    • Python SDK
      • dbnl
      • dbnl.util
      • dbnl.experimental
      • Classes
      • Eval Module
        • Quick Start
        • dbnl.eval
        • dbnl.eval.metrics
        • Application Metric Sets
        • How-To / FAQ
        • LLM-as-judge and Embedding Metrics
        • RAG / Question Answer Example
      • Classes
  • CLI
  • Versions
    • Release Notes
Powered by GitBook

© 2025 Distributional, Inc. All Rights Reserved.

On this page
  • What's in a Notification?
  • Setting up a Notification Channel in your Namespace
  • Supported Third-Party Notification Channels
  • Setting up a Notification in your Project
  • Notification Criteria

Was this helpful?

Export as PDF
  1. Using Distributional

Notifications

PreviousWhat Is a Similarity Index?NextAccess Controls

Was this helpful?

Notifications provide a way for users to be automatically notified about critical test events (e.g., failures or completions) via third-party tools like PagerDuty and Slack.

With Notifications you can:

  • Add critical test failure alerting to your organization’s on-call

  • Create custom notifications for specific feature tests

  • Stay informed when a new test session has started

What's in a Notification?

A Notification is composed of two major elements:

  • The Notification Channel — this contains the metadata for how and where a Notification will be sent

  • The Notification Criteria — this defines the rules for when a Notification will be generated

Setting up a Notification Channel in your Namespace

Before setting up a Notification in your project, you must have a Notification Channel set up in your Namespace. A Notification Channel describes who will be notified and how. A Notification Channel in a Namespace can be used by Notifications across all Projects belonging to that Namespace.

In adding your Notification Channel, you will be able to select which you'd like to be notified through.

  1. In your desired Namespace, choose Notification Channels in the menu sidebar. Note: you must be a Namespace admin in order to do this.

  2. Click the New Notification Channel button to navigate to the creation form.

  3. Fill out the appropriate fields.

    1. Optional: If you’d like to test that your Notification Channel is set up correctly, click the Test button. If it is correctly set up, you should receive a notification through the integration you’ve selected.

  4. Click the Create Notification Channel button. Your channel will now be available when setting up your Notification.

Supported Third-Party Notification Channels

Note: More coming up in the product roadmap!

Setting up a Notification in your Project

  1. Navigate to your Project and click the Notifications tab.

  1. Click the "New Notification" button to navigate to the creation form.

  1. Click the "Create Notification" button. Your Notification will now notify you when your specified criteria are met!

Notification Criteria

Trigger Event

The trigger event describes when your Notification is initiated. Trigger events are based on Test Session outcomes.

Tags Filtering

Filtering by Tags allows you to define which tests in the Test Session you care to be notified about.

There are three types of Tags filters you can provide:

Include: Must have ANY of the selected

Exclude: Must not have ANY of the selected

Require: Must have ALL of the selected

When multiple types are provided, all filters are combined using ‘AND’ logic, meaning all conditions must be met simultaneously.

Note: This field only pertains to the ‘Test Session Failed’ trigger event

Condition

The condition describes the threshold at which you care to be notified. If the condition is met, your Notification will be sent.

Note: This field only pertains to the ‘Test Session Failed’ trigger event

Set your Notification’s name, , and Notification Channels.

PagerDuty
Slack
criteria
third-party integration
Notification Channel creation form
Notification creation form