Dashboard component events

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Dashboard component events

    The Dashboard component events feature in ServiceNow allows you to configure and customize actions triggered by various events within a dashboard. These events enable you to control navigation, data display, and interaction behaviors in dashboards, enhancing user experience and workflow integration.

    Show full answer Show less

    Key Features

    • Event Handlers Configuration: Select and add event handlers to dashboard events to define custom responses and actions linked to data resources displayed on dashboards.
    • Navigate to Dashboard Overview Page: An event dispatched when the dashboard closes, redirecting to the dashboard library. You can customize the redirect route and title using a client script, enabling tailored navigation flows.
    • Dashboard Widget Clicked: This event allows overriding the default drilldown behavior when a dashboard visualization is clicked. By disabling default drilldowns and adding a custom event handler, you can implement personalized drilldown logic via client scripts.
    • URL Params Update Requested: Dispatched whenever URL parameters update during navigation, providing structured parameter data (such as dashboard sysid, tab sysid, and edit mode status). This enables implementation of custom navigation logic responsive to URL changes.

    Practical Use for ServiceNow Customers

    • Customize dashboard navigation and user interactions by modifying event handlers and client scripts.
    • Implement tailored drilldowns from dashboard widgets to enhance data exploration aligned with your business processes.
    • Leverage URL parameter events to synchronize dashboard state with browser navigation and support advanced user workflows.
    • Ensure your instance uses the latest Platform Analytics experience application from the ServiceNow Store to access full functionality.

    Select event handlers to configure the actions (events) provided with the dashboard component.

    The Events tab shows the events used by the dashboard component. To view the available events, select + Add event mapping. Select the event in the list to add one or more event handlers.

    Event handlers

    Event handlers work with data resources to link the dashboard actions to the data you want to display to your users. Select the event in the list to add one or more event handlers.

    Event descriptions

    Event Description
    Navigate to dashboard overview page Dispatched when the dashboard is closed and redirects to the dashboard library. You can customize this behavior by changing the route and title in the Redirect to dashboard list client script. To open client scripts, select the <> icon in the page's side bar.
    * @param {params} params
* @param {api} params.api
* @param {any} params.event
* @param {any} params.imports
* @param {ApiHelpers} params.helpers
*/
function handler({api}) {
    api.emit('SCREEN_STATUS_CHANGED', {status: 'closed'});
    api.emit('NAV_ITEM_SELECTED', {
        route: 'dashboard-library',
        title: 'Dashboard Library',
    });
}
    Dashboard Widget Clicked
    Add this event handler if you want to override the default drilldown with custom behavior when a visualization on the dashboard is clicked. It uses the Dashboard Widget Clicked client script. To add a custom drilldown:
    1. Set the defaultDrilldowns property to false.
    2. Add the Dashboard Widget Clicked event handler.
    3. Open the Dashboard Widget Clicked client script. To open client scripts, select the <> icon in the page's side bar.
    4. Locate the code api.emit('NAV_ITEM_SELECTED', payload); and update payload to align with your custom redirect logic.
    URL params update requested

    Dispatched whenever the dashboard component would normally update URL parameters and delegateUrlParams is true. This event provides structured parameter data that client scripts can use to implement custom navigation logic.

    URL parameters:
    • sysId: The sys_id of the dashboard being navigated to. Present when dashboard changes.
    • tabSysId: The sys_id of the selected tab. Present when tab changes.
    • edit: Whether the dashboard is in edit mode. Present when edit mode changes.
    All parameters have the following object fields:
    • value (string | boolean): The parameter value
    • description (string): Human-readable description of the parameter
    The sysId parameter also has the following object fields:
    • dashboardName (string): Title of the dashboard
    • isNewTab (boolean): true when the user performed a Cmd/Ctrl+click or middle-click in the dashboard picker, indicating intent to open in a new tab. Only sent for sysId parameter.
    Example:
    {
  "urlParams": {
    "sysId": {
      "value": "a1b2c3d4e5f6",
      "dashboardName": "Dashboard A",
      "description": "Dashboard sys_id",
      "isNewTab": false
    },
    "tabSysId": {
      "value": "f6e5d4c3b2a1",
      "description": "Tab sys_id"
    },
    "edit": {
      "value": true,
      "description": "Edit mode"
    }
  }
}

    For more information, see Dashboard URL parameter delegation.

    Note:
    This functionality requires the latest Platform Analytics experience application from the ServiceNow® Store.