Skip to main content

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:
You can alternatively set it on Notifications Panel if you have directly embedded it:
Using APIs:

considerAllNotifications

Controls the notification count and unread indicator for the notification panel. When enabled, the notification count and unread badge include items from all tabs; when disabled (default), they only include items from the “For You” tab. Default: false
Using Props:

enableCurrentDocumentOnly

Programmatically filters notifications to show only those from the current document. By default it shows notifications for the 15 most recently active documents accessible to the current user in the current organization.
Hooks:
API:

setMaxDays

Notifications older than the specified number of days will not be displayed. Default: 15 days.
Using API:

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.

pageSize

Control initial notification load count.

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:
Using APIs:

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:
Using API:

Data

getNotificationsData

  • Get the notifications data for the current user.
  • The returned data includes notifications from up to the number of days specified by max days configuration.
  • “For You” tab: By default only the latest 50 notifications are fetched. This is done to reduce clutter and noise.
  • “Document” and “All” tabs: By default, up to 15 notifications are fetched for each of the 15 most recently active documents accessible to the current user. This highlights the most relevant and recent activity.
  • 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:
Using API:
To unsubscribe from the subscription:

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:
Using Hooks:
Using API:

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

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.

Actions

markNotificationAsReadById

  • Mark a single notification as read using its notificationId.
  • The notification will be marked as read in all tabs.

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.

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.

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:
Using APIs:

enableSettingsAtOrganizationLevel

Enable organization-level notification settings. When enabled, settings apply to all documents in the organization instead of per-document. Params: none Returns: void
Using Props:
Using APIs:

settingsLayout

Control how notification settings are displayed. Two layout modes are available. Default: accordion Type: NotificationSettingsLayout Options:
  • accordion: Settings displayed in expandable accordion
  • dropdown: Settings displayed in dropdown menu

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:
Using Hook:
Using API:

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

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:
Using API:

getSettings

Using Hook:
Using API:

Notification Delivery

Batching and Delay Configuration

Configure a delay-and-batch pipeline for notification delivery. When enabled, notifications pass through a delay hold, a seen check, and optional batching before being delivered.
This configuration is set at the API Key level in the Velt Console. It applies to all documents in the organization.
Delivery pipeline:
  1. Delay — Holds the notification for delaySeconds before proceeding.
  2. Seen check — If the recipient has already seen the triggering activity during the delay window, the notification is suppressed.
  3. Batch — Collects additional activities within the batch window before flushing as a single digest.
  4. Deliver — Sends the notification (or batched digest) to the recipient.
Webhooks and workflow triggers always fire immediately and are never subject to delay or batching.
Document-level and user-level batching operate independently. A notification can accumulate in both windows simultaneously; whichever window closes first (by time or maxActivities) triggers a flush for that scope.