API parameters to configure Desktop Assistant notifications

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read

    • sendDANotification() method parameters in the DesktopAppNotificationUtils script include for configuring Desktop Assistant notifications.

    Parameter Description
    notification_message

    Body text displayed on the notification card. The value must be a non-empty string and not exceed 1000 characters. If this condition is not met, the API returns a 400 error.
    notification_title

    Title text displayed at the top of the Desktop Assistant notification card. If omitted, the notification card displays an empty title without raising an error.
    recipient_list

    The sys_id values of the intended recipients, sourced from the User (sys_user) table and provided as a comma-separated string.
    referrer_id

    The sys_id of the record that the notification links to.

    This parameter works in combination with referrer_table. If only one of these two parameters is provided, the link behavior is unpredictable.
    referrer_table

    The name of the table containing the record that the notification links to. For example, incident or sc_request.

    This parameter works in combination with referrer_id. If only one of these two parameters is provided, the link behavior is unpredictable.
    source The source application that triggered the notification.
    Accepted values are mim (Major Incident Management) and pe (Proactive Engagement). The value is case-insensitive. Any other value causes the API to return a 400 error.
    Note:
    Desktop Assistant sends notifications for a new source only if the source is added as a choice value in the Notification source field of the Desktop Assistant notification (sn_dex_desktop_assistant_notification) table. This enables Desktop Assistant to recognize and track the source.

    Parameter interactions and precedence

    Scenario Behavior
    notification_message is empty, missing, or not a string value. Returns a 400 error.
    notification_title is missing or not a string value. The Desktop Assistant client displays an empty title. No error is raised.
    source is not mim or pe Returns a 400 error: Source record missing in Desktop Assistant Notification Source table
    enable_push_notification is false Returns a 400 error immediately. No record is created and no flow runs.
    notification_time_to_live is set to more than 7 days The value is capped at seven days.
    notification_time_to_live property is not set Defaults to seven days.
    Only one of referrer_table or referrer_id is provided No error is raised and both fields are stored, but the notification on the Desktop Assistant client may not link to the correct record.

    Desktop Assistant notification card element‑to‑source mapping

    Desktop Assistant client UI element Source parameter or field
    Notification title (card header) notification_title
    Notification body text notification_message
    Timestamp Derived from the sys_created_on field on the Desktop Assistant Notification Queue (sn_dex_desktop_notify_queue) record.

    Not an API parameter.
    System tray notification Displayed when the notification status is Pending at the time the Desktop Assistant client checks for new notifications.

    Not an API parameter.