Skip to main content

Notifications

Overview​

Witboost notifications is designed to keep users informed about important updates throughout the data product lifecycle. Whether it's changes in data availability, workflow statuses, or important announcements, notifications ensure that users stay updated and can take necessary actions promptly.

Notifications can be delivered through different channels, depending by the platform settings.

These sections describes you, as platform team member, how to configure the notifications such that you can target different groups of users, on different channels, based on your preferences. Groups of users are the so-called recipient types, as described in the Concepts section.

Concepts​

A Witboost notification can be delivered to different channels, to different recipient types.

Channels​

A channel is the media that Witboost will use to deliver notifications to users. As of now, Witboost supports three channels:

  • Push channel: which can be viewed from the UI inside the Notification Center
  • Webhook channel: which can help you integrate with third-party communication tools (e.g. Slack, Microsoft Teams, Mattermost, etc.). Head to the dedicated section to learn how to configure them.
  • Email channel: you can integrate your own SMTP server, via OAuth2 or user-password authentication, to send notifications from it. To see instructions on how to configure it, refer to Email notifications

Recipient types​

A recipient type is a group of witboost users that will be targeted by a notification. Each notification supports a subset of all available recipient types in the platform. Some example recipient types are: system owners, system developers, governance team, platform team.

As a reference, this is the description of all recipient types that can be targeted by notifications:

  • System Owner (recipient-type:system-owner): Owner of a given resource
  • Domain System Owners (recipient-type:domain-system-owners): All users which are owners of at least one resource in a given domain.
  • System Developers (recipient-type:system-developers): All users which are part of a development group of a given resource.
  • System Access Control List (recipient-type:system-access-control-list): All users that are part of the Access Control List of a given resource.
  • Consumer Systems Owners (recipient-type:consumer-systems-owners): All users which are owners of downstream resources (consumer resource). A consumer resource is a resource which is consuming data from an upstream resource. Those resources are identified by having a readsFrom relationship towards the upstream resource.
  • Builder Users (recipient-type:builder-users): All users that have access to the Builder module.
  • Everyone (recipient-type:everyone): All witboost users. The list of witboost users can be seen from the Software Catalog.
  • Governance Team (recipient-type:governance-team): All users which have all required RBAC permissions to create policies and metrics.
  • Platform Team (recipient-type:platform-team): All users which have all required RBAC permissions to access the platform settings.
  • Access Control Requester (recipient-type:access-control-requester): User who sent the access control request
  • Access Control Request Identities (recipient-type:access-control-request-identities): Users that are involved in the access control request and will be affected by the requested change in the Access Control List

Each notification supports only a subset of all available recipient types, as those represents the scope of a notification.