​
Configuration

​
setTabConfig

  • Using this config, you can customize the name of the tabs or disable them altogether.
  • By default, all the three tabs are enabled.
You can set it on Notifications Tool:
<VeltNotificationsTool tabConfig={{
    "forYou": {
        name: 'Custom For You',
        enable: true,
    },
    "documents": {
        name: 'Custom Document',
        enable: false,
    },
    "all": {
        name: 'Custom All',
        enable: true,
    },
}
} />
You can alternatively set it on Notifications Panel if you have directly embedded it:
<VeltNotificationsPanel tabConfig={{
    "forYou": {
        name: 'Custom For You',
        enable: true,
    },
    "documents": {
        name: 'Custom Document',
        enable: false,
    },
    "all": {
        name: 'Custom All',
        enable: true,
    },
}
} />
Using APIs:
const notificationElement = useNotificationUtils();

​​const tabConfig = {
	"forYou": {
		name: 'Custom For You',
		enable: true,
	},
	"documents": {
		name: 'Custom Document',
		enable: false,
	},
	"all": {
		name: 'Custom All',
		enable: true,
	},
};

notificationElement.setTabConfig(tabConfig);

​
setMaxDays

Notifications older than the specified number of days will not be displayed. Default: 15 days. 
<VeltNotificationsTool maxDays={15} />
Using API:
const notificationElement = useNotificationUtils();
notificationElement.setMaxDays(15);

​
panelOpenMode

Notificaitons Panel opens in one of the following ways:
  • popover: It opens as a popover on the Notification Tool.
  • sidebar: It opens as a sidebar from the right edge of the screen.
Default: popover. 
<VeltNotificationsTool panelOpenMode='sidebar' />
<VeltNotificationsPanel panelOpenMode='sidebar' />

​
enableReadNotificationsOnForYouTab

  • You can control whether read notifications are displayed in the “For You” tab. By default, read notifications are removed from this tab.
  • This feature allows you to customize the visibility of read notifications in the “For You” tab, providing more flexibility in how notifications are displayed to users.
Default: false.
Using Props:
<VeltNotificationsTool readNotificationsOnForYouTab={true} />
<VeltNotificationsPanel readNotificationsOnForYouTab={true} />
Using APIs:
const notificationElement = useNotificationUtils();
// Enable to keep read notifications in the for you tab
notificationElement.enableReadNotificationsOnForYouTab();
// Disable to hide read notifications in the for you tab
notificationElement.disableReadNotificationsOnForYouTab();

​
enableSelfNotifications

  • By default notifications api and components exclude notifications where the current user is the action user.
  • This feature allows you to enable self notifications.
Default: false.
Using props:
<VeltNotificationsTool selfNotifications={true} />
<VeltNotificationsPanel selfNotifications={true} />
Using API:
const notificationElement = useNotificationUtils();
notificationElement.enableSelfNotifications(); // Enables self notifications.
notificationElement.disableSelfNotifications(); // Disables self notifications.

​
Data

​
getNotificationsData

  • Get the notifications data for the current user.
  • Params:
    • query: Optional. GetNotificationsDataQuery
      • type: Filter for notification type: all, for you, or documents.
        • forYou: returns notifications where the current user is involved.
        • all / documents: returns all notifications from the documents the user has access to.
  • Returns Notification[]
Using Hooks:
// Without query
const notificationData = useNotificationsData();

// With query
const notificationsData = useNotificationsData({ type: 'forYou' });

useEffect(() => {
  if (notificationsData) {
    console.log(notificationsData);
  }
}, [notificationsData]);
Using API:
const notificationElement = client.getNotificationElement();

// Without query
let subscription = notificationElement.getNotificationsData().subscribe((notifications) => {
    console.log("Notifications: ", notifications)
});

// With query
let subscription = notificationElement.getNotificationsData({ type: 'forYou' }).subscribe((notifications) => {
    console.log("Notifications: ", notifications)
});
To unsubscribe from the subscription:
subscription?.unsubscribe()

​
getUnreadNotificationsCount

  • Retrieve the count of unread notifications, which includes a breakdown for different tabs.
  • The ‘Document’ tab is not included in the response because it contains all the notifications present in the ‘All’ tab.
Sample response: 
{ 
  forYou: 4, // # of unread notifications in the "For You" tab
  all: 5     // # of unread notifications in the "All" or "Document" tab
}
Using Hooks:
const unreadCount = useUnreadNotificationsCount();

useEffect(() => {
  console.log('Unread Count', unreadCount);
}, [unreadCount]);
Using API:
const notificationElement = client.getNotificationElement();
notificationElement.getUnreadNotificationsCount().subscribe((data) => {
  console.log('Unread notifications count:', data);
});

​
Event Subscription

​
on

  • Subscribe to Notification Events. Here is the list of events you can subscribe to and the event objects you will receive.
Event TypeDescriptionEvent Object
settingsUpdatedTriggered when the settings are updated by the user using UI or the APISettingsUpdatedEvent
// Hook
const settingsUpdatedEvent  = useNotificationEventCallback('settingsUpdated')

useEffect(() => {
    console.log('settingsUpdatedEvent', settingsUpdatedEvent)
}, [settingsUpdatedEvent])


// API Method
const notificationElement = useNotificationUtils();
notificationElement.on('settingsUpdated').subscribe((event) => {
     console.log('settingsUpdatedEvent', event);
});

​
onNotificationClick

  • The onNotificationClick event fires when a notification is clicked in the Notifications Panel.
  • It returns a Notification object with details about the clicked notification.
  • Listen to this event via either the Notification Tool or the Notification Panel, but not both.
  • Use this event to implement custom actions in response to notification clicks, such as navigating to a specific part of the app.
<VeltNotificationsTool onNotificationClick={(notification) => onNotificationClickEvent(notification)} />

<VeltNotificationsPanel onNotificationClick={(notification) => onNotificationClickEvent(notification)} />

const onNotificationClickEvent = (notification) => {
	console.log('onNotificationClick: ', notification);
}

​
Actions

​
markNotificationAsReadById

  • Mark a single notification as read using its notificationId.
  • The notification will be marked as read in all tabs.
const notificationElement = client.getNotificationElement();
notificationElement.markNotificationAsReadById("notificationId");

​
openNotificationsPanel

  • Programmatically open or close the notification panel using the provided APIs.
  • This will not work if you have embedded the notification panel in your app.
const notificationElement = useNotificationUtils()
notificationElement.openNotificationsPanel()
notificationElement.closeNotificationsPanel()

​
setAllNotificationsAsRead

  • Mark all notifications as read, either globally or for a specific tab.
  • Using ‘all’ or ‘document’ as the tabId marks all notifications as read across all tabs (equivalent to calling setAllNotificationsAsRead() without arguments).
  • Using ‘for-you’ as the tabId only marks notifications in the ‘for-you’ tab as read.
const notificationElement = client.getNotificationElement();

// Mark all notifications as read
notificationElement.setAllNotificationsAsRead();

// Mark all notifications as read for a specific tab
notificationElement.setAllNotificationsAsRead({ tabId: 'for-you' });
notificationElement.setAllNotificationsAsRead({ tabId: 'all' });
notificationElement.setAllNotificationsAsRead({ tabId: 'document' });

​
Notification Settings

  1. This feature currently only updates the settings for the current user in the current Velt document. If you are using multiple documents or folders, the settings will apply to the root document.
  2. Make sure to first enable the settings feature in Velt Console.

​
enableSettings

  • Enable or disable the settings feature for notifications. This allows users to configure their notification preferences.
  • Params: none
  • Returns: void
Using Props:
// You can enable this on either the tool or the panel
<VeltNotificationsTool settings={true} />
<VeltNotificationsPanel settings={true} />
Using APIs:
const notificationElement = useNotificationUtils();
notificationElement.enableSettings(); // enables the settings feature
notificationElement.disableSettings(); // disables the settings feature

​
setSettingsInitialConfig

  • Set the initial default configuration for notification settings. This defines the available settings options and their default values.
  • By default we have config added for inbox (in-app notifications) and email.
  • You can extend this to add more channels where you intend to send notifications to your users. eg: slack, jira, asana, linear etc.
  • If you do extend it to other custom channels, you will need to send the data to those channels yourself using our webhooks. Learn more
  • This config will automatically generate the settings UI for the user to configure their notification preferences.
  • Params: NotificationInitialSettingsConfig[]
    • Here is what the value types mean:
      • ALL: Subscribes the user to all notifications whether or not the user is involved in the notification on the current document.
      • MINE: Subscribes the user to notifications that are related to the current user on the current document.
      • NONE: Subscribes the user to no notifications on this channel on the current document.
  • Returns: void
Default: 
[
  {
    name: 'Inbox',
    id: 'inbox',
    default: 'ALL',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
  {
    name: 'Email',
    id: 'email',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
]
Using Hook:
const { setSettingsInitialConfig, setSettings, settings } = useNotificationSettings();
setSettingsInitialConfig([
  {
    name: 'Inbox',
    id: 'inbox',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
  {
    name: 'Slack',
    id: 'slack',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
  {
    name: 'Linear',
    id: 'linear',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
]);
Using API:
const notificationElement = useNotificationUtils();
notificationElement.setSettingsInitialConfig([
  {
    name: 'Inbox',
    id: 'inbox',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
  {
    name: 'Slack',
    id: 'slack',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
  {
    name: 'Linear',
    id: 'linear',
    default: 'MINE',
    enable: true,
    values: [
      {
        name: 'All',
        id: 'ALL',
      },
      {
        name: 'Only Involved',
        id: 'MINE',
      },
      {
        name: 'None',
        id: 'NONE',
      }
    ]
  },
]);

​
muteAllNotifications

  • Mutes all notifications across all the channels for the current user in this current document.
  • In case of multiple documents or folders, this will mute all notifications for the user in the root document.
  • Params: none
  • Returns: void
const notificationElement = client.getNotificationElement();
notificationElement.muteAllNotifications();

​
setSettings

  • Update notification settings configuration for the current user.
  • Here you need to provide the id of the channel config and its value id.
  • Params: NotificationSettingsConfig
  • Here is what the value types mean:
    • ALL: Subscribes the user to all notifications whether or not the user is involved in the notification on the current document.
    • MINE: Subscribes the user to notifications that are related to the current user on the current document.
    • NONE: Subscribes the user to no notifications on this channel on the current document.
  • Returns: void
Using Hook:
const { setSettingsInitialConfig, setSettings, settings } = useNotificationSettings();
setSettings({
  'email': 'MINE',
  'inbox': 'NONE',
  'slack': 'ALL',
  'linear': 'MINE'
});
Using API:
const notificationElement = useNotificationUtils();
notificationElement.setSettings({
  'email': 'MINE',
  'inbox': 'NONE',
  'slack': 'ALL',
  'linear': 'MINE'
});

​
getSettings

Using Hook:
const { setSettingsInitialConfig, setSettings, settings } = useNotificationSettings();
// setSettingsInitialConfig will set the default settings for the notifications.
// setSettings will update the settings for the notifications in the server.
// settings will return the current settings for the notifications. Initially it will be null and will be updated when the settings are fetched.
Using API:
const notificationsElement = useNotificationUtils();
notificationsElement.getSettings().subscribe((settings) => {
  console.log('current settings are', settings);
});