Work with Notifications

Flex UI provides a client-side API to manage notifications in Flex UI.

What is a notification in Flex?

A notification is an alert that tells the user what state change or error has occurred to a component or page when they are no longer viewing that component or page

Users can be notified in Flex using a Notification Bar or Browser notifications or both.

With notifications framework, you can:

  • Register custom notifications including browser notifications
  • Customize standard notifications
  • Turn off standard UI notifications
  • Override standard notifications per Task Channel Definition
  • Customize how standard UI notifications are displayed
  • Register your custom UI notifications and specify how to render them


NotificationBar is an in-app way to alert user. NotificationBar has a variety of options like icon, actions, timeout.

Screenshot 2022-05-26 at 12.52.12.png

Screenshot 2022-05-26 at 12.52.12.png

Browser Notifications

Flex uses the standard Browser Notification API as the basis for its browser notifications implementation. Browser notifications can be enabled in the Admin Dashboard of the Flex UI.

Browser notifications are shown if Flex is minimized.

Note, due to security constraints across browsers, Browser Notifications are not supported when Flex is iframed within a cross-domain webpage. This includes the Salesforce and Zendesk integrations.

Requesting permissions

To start showing browser notifications, the user needs to first grant permissions. By default, Flex will request user for permissions if they are not granted or blocked.

If you want to add custom logic around requesting permissions, like request it based on some user action in the UI, then you can dispatch Notification.requestPermission() from your custom code.

Browser notifications handler

To display a browser notification, use the options key with a browser tag in it. Flex API docs contain an exhaustive list of available properties. If no browser key is passed to options, Flex will not show any browser notifications.

NotificationBar actions

A helper component NotificationBar.Action, that can be used for providing clickable action to notification definition.

interface NotificationBarActionProps {
    label: React.ReactText; // Can be simple text string or a template string
    onClick: NotificationBarActionCallback;
    icon?: string;

The full reference for the Notification Manager and a list of standard notifications are available in Flex API docs.

Register a custom notification with Browser notification handler

    id: "customNotification",
    closeButton: true,
    content: "Custom Notification",
    timeout: 0,
    type: NotificationType.warning,
    actions: [
            onClick={(_, notification) => {
    options: {
      browser: {
          title: "Custom Notification",
          body: "Hello World!"

Override standard notifications for a specific task type using Task Channel Definitions API

Use custom notification for new reservation of a Call task

Flex.DefaultTaskChannels.Call.notifications.override.IncomingTask = () => {

Change content of a standard notification for incoming call task

Flex.DefaultTaskChannels.Call.notifications.override.IncomingTask = (notification) => { 
  notification.content = "Hello, world!"; 

Change content of a standard notification for new chat message

Flex.DefaultTaskChannels.Chat.notifications.override.IncomingTask = (notification) => { 
  notification.content = "Hello, world!"; 

Turn off Standard Notifications

Do not show notificationBar notifications

Flex.MainContainer.defaultProps.showNotificationBar = false;

Disable notification by ID


Customize Standard Notifications

Change text of the notification

const notification = Flex.Notifications.registeredNotifications.get("notificationId");
if (notification) {
   notification.content = "Display some text";

Change text of the notification with template

flex.manager.getInstance().strings.myNotification = "Current time: {{time}}"
const notification = Flex.Notifications.registeredNotifications.get("notificationId");
if (notification) {
  notification.content = "myNotification";
Flex.Notifications.showNotification("notificationId", {time:})

Read more about overriding strings in Overview of Flex UI programmability.

Render custom component in a notification

const notification = Flex.Notifications.registeredNotifications.get("notificationId");
if (notification) {
   notification.content = <MyAwesomePopup/>;

Change props of the notification

const notification = Flex.Notifications.registeredNotifications.get("PendingReservationsOnActivityStateChange");
if (notification) {
   notification.content = "Some text to display";
   notification.backgroundColor = "blue";
   notification.closeButton = false;  

Register Custom Notifications

Option 1: string

  id: "myNotificationId",
  content: "Custom content", // string
  type: NotificationType.error

Option 2: template

  id: "myNotificationId",
  content: "NotificationMessage", // template
  type: NotificationType.error

Read more about overriding strings in Overview of Flex UI programmability.

Option 3: custom React component

interface CustomNotificationProps extends NotificationContentProps {
   customProp?: string;
   notificationContext?: any;

export class CustomNotificationElement extends React.Component<CustomNotificationProps, undefined> {
   render() {
       const { customProp, notificationContext } = this.props;
               <div />

    id: "myNotificationId",
    content: <CustomNotificationElement customProp="custom prop" />,
    type: NotificationType.error

Dispatch Custom Notifications

Option 1: string

Flex.Notifications.showNotification("myNotificationId", undefined);

Option 2 & 3: template & custom React component

Flex.Notifications.showNotification("myNotificationId", { message: "custom context" } );

Add Custom Notification Event Listeners

import * as Flex from "@twilio/flex-ui";

Notifications.addListener("beforeAddNotification", (payload) => {
  console.log("<---beforeTransferTask Listener--->", payload);
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

Thank you for your feedback!

Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!