Requests

initialSetup

• "NewTab Messages".InitialSetupRequest
• Returns "NewTab Messages".InitialSetupResponse
• See also
  • Widget Config for the initial page widgets
  • Update Notification for the optional data
  • Customizer Drawer Feature Flags for optional feature flags like the customizer drawer about release notes (windows only).

/**
 * Example of the `InitialSetupResponse`
 *
 * @type {import("../../types/new-tab.js").InitialSetupResponse}
 */
// prettier-ignore
const initialSetupResponse = {
    widgets: [
        { id: 'updateNotification' },
        { id: 'rmf' },
        { id: 'favorites' },
        { id: 'privacyStats' }
    ],
    widgetConfigs: [
        { id: 'rmf', visibility: 'visible' },
        { id: 'nextSteps', visibility: 'visible' },
        { id: 'favorites', visibility: 'visible' },
        { id: 'privacyStats', visibility: 'visible' },
    ],
    env: 'production',
    locale: 'en',
    platform: { name: 'windows' },
    updateNotification: { content: null },
    customizer: {
        theme: 'system',
        userImages: [],
        userColor: null,
        background: { kind: 'default' },
        defaultStyles: {
            lightBackgroundColor: '#E9EBEC',
            darkBackgroundColor: '#27282A',
        },
    },
};
Copy

Notifications

contextMenu

• "NewTab Messages".ContextMenuNotification
• Sent when the user right-clicks in the page
• Note: Other widgets might prevent this (and send their own, eg: favorites)
• Sends: "NewTab Messages".ContextMenuNotify
• DEPRECATED: The visibilityMenuItems property is deprecated and will be removed in a future version. Native apps should populate the context menu themselves instead of relying on frontend to tell it what widgets exist in the New Tab Page.
• Example:

{
  "visibilityMenuItems": [
    {
      "id": "favorites",
      "title": "Favorites"
    },
    {
      "id": "privacyStats",
      "title": "Privacy Stats"
    }
  ]
}
Copy

open

• "NewTab Messages".OpenNotification
• Sent when the user clicks on a link, such as 'settings'
• Sends: "NewTab Messages".OpenAction
• Example:

{
  "target": "settings"
}
Copy

telemetryEvent

• "NewTab Messages".TelemetryEventNotification
• These are generic events that might be useful to observe. For example, you can use these to decide when to send pixels.
• Sends a standard format { attributes: { name: string', value?: any } } - see telemetryEvent
• Example:

{
  "attributes": {
    "name": "stats_toggle",
    "value": "show_more"
  }
}
Copy

reportInitException

• "NewTab Messages".ReportInitExceptionNotification
• Sent when the application fails to initialize (for example, a JavaScript exception prevented it)
• Sends: { message: string } - see "NewTab Messages".ReportInitExceptionNotify

reportPageException

• "NewTab Messages".ReportPageExceptionNotification
• Sent when the application failed after initialization (for example, a JavaScript exception prevented it)
• Sends: { message: string } - see "NewTab Messages".ReportPageExceptionNotify