API parameters to customize Desktop Assistant notifications

  • Release version: Xanadu
  • Updated March 28, 2025
  • 1 minute to read
  • Use these parameters in the API to customize the Desktop Assistant notifications.

    Parameter list Description
    Notification message Enter the notification message you would like to send.
    Notification title Enter a title to the notification.
    Recipient list Add the receipt list of users who can receive this notification.
    Referrer id Enter the corresponding sys_id of the referred table selected.
    Referrer table Select a type for record on which the notification should be triggered.
    Source Indicates the application from which it got triggered.
    Note:
    • Desktop Assistant supports only Major Incident Management and Proactive Engagement sources out of the box.
    • The notifications will be sent successfully for new sources, only if the new source is added as the new choice value for Notification source column in sn_dex_desktop_assistant_notification table, which will allow the Desktop Assistant to track the new source.
    The following example illustrates the API parameters to customize the Desktop Assistant notifications.
    var notificationObj = {
      notification_message: "Notification Message",
       notification_title: "DA MIM Notification",
      recipient_list: "Receiving sys_user sysid",
       referrer_id: "referrer record sys_id",
       referrer_table: "incident",
       source: "MIM"
    };
    var notifyUtils = new sn_dex_desktop.DesktopAppNotificationUtils();
    notifyUtils.sendDANotification(notificationObj);