Setup

• Widget ID: "activity"
• Add it to the widgets + widgetConfigs fields on initialSetup
• Example:

{
  "...": "...",
  "widgets": [
    {"...":  "..."},
    {"id":  "activity"}
  ],
  "widgetConfigs": [
    {"...":  "..."},
    {"id": "activity", "visibility": "visible" }
  ]
}
Copy

Requests:

activity_getData

• "NewTab Messages".ActivityGetDataRequest
• Used to fetch the initial data (during the first render)
• returns "NewTab Messages".ActivityData

{
  "activity": [
    {
      "favicon": "<any img url>",
      "url": "https://www.youtube.com",
      "title": "youtube.com",
      "etldPlusOne": "youtube.com",
      "favorite": true,
      "trackersFound": true,
      "trackingStatus": {
        "trackerCompanies": [{ "displayName": "Adobe Analytics" }],
        "totalCount": 0
      },
      "history": [
        {
          "title": "Electric Callboy - Hypa Hypa (OFFICIAL VIDEO) - YouTube",
          "url": "https://youtube.com/watch?v=abc",
          "relativeTime": "Just now"
        }
      ]
    }
  ]
}
Copy

Notes: - on macOS, history.title should be a path-like string to match current implementations - etldPlusOne will be used for fallback favicons/colors, so the logic should match the NTP

activity_getConfig

• "NewTab Messages".ActivityGetConfigRequest
• Used to fetch the initial config data (eg: expanded vs collapsed)
• returns "NewTab Messages".ActivityConfig

activity_getUrls

• "NewTab Messages".ActivityGetUrlsRequest
• Used to fetch the initial config data (eg: expanded vs collapsed)
• returns "NewTab Messages".UrlInfo

{
  "urls": ["..."],
  "totalTrackersBlocked": 123
}
Copy

activity_getDataForUrls

• "NewTab Messages".ActivityGetDataForUrlsRequest
• Used to confirm the burn action - native side may or may not show a modal
• sends "NewTab Messages".DataForUrlsParams
• returns "NewTab Messages".ActivityData
• Note: This response is the same format as activity_getData, where DomainActivity items are delivered under .activity

{
  "activity": [
    {"...":  "..."}
  ]
}
Copy

activity_confirmBurn

• "NewTab Messages".ActivityConfirmBurnRequest
• Used to confirm the burn action - native side may or may not show a modal
• sends "NewTab Messages".ConfirmBurnParams
• returns "NewTab Messages".ConfirmBurnResponse

Sends

{ "url": "..." }
Copy

Response:

{ "action": "burn" }
Copy

Response (do nothing)

{ "action": "none" }
Copy

If { "action": "burn" } is returned, the burn animation will play, and will follow by sending the notification activity_burnAnimationComplete

Subscriptions:

activity_onDataUpdate

• "NewTab Messages".ActivityOnDataUpdateSubscription
• The activity data used in the feed.
• returns "NewTab Messages".ActivityData

activity_onDataPatch

• "NewTab Messages".ActivityOnDataPatchSubscription
• The activity data used in the feed.
• returns "NewTab Messages".UrlInfo + optional "NewTab Messages".PatchData

{
  "urls": ["..."],
  "totalTrackersBlocked": 123
}
Copy

{
  "urls": ["..."],
  "totalTrackersBlocked": 123,
  "patch": {
    "...": "..."
  }
}
Copy

activity_onConfigUpdate

• "NewTab Messages".ActivityOnDataUpdateSubscription
• The widget config
• returns "NewTab Messages".ActivityConfig

Notifications:

activity_setConfig

• "NewTab Messages".ActivitySetConfigNotification
• Sent when the user toggles the expansion of the activity feed
• sends "NewTab Messages".ActivityConfig
• example payload:

  {
    "expansion": "collapsed"
  }
  Copy

activity_addFavorite

• "NewTab Messages".ActivityAddFavoriteNotification
• Sent when the user clicks the favorite icon
• sends "NewTab Messages".ActivityAddFavoriteNotify
• example payload: { "url": "..." }

activity_removeFavorite

• "NewTab Messages".ActivityRemoveFavoriteNotification
• Sent when the user clicks the favorite icon, if already a favorite
• sends "NewTab Messages".ActivityRemoveFavoriteNotify
• example payload: { "url": "..." }

activity_removeItem

• "NewTab Messages".ActivityRemoveItemNotification
• (windows only) Sent when the user clicks the cross icon
• sends "NewTab Messages".ActivityRemoveItemNotify
• example payload: { "url": "..." }

activity_open

• "NewTab Messages".ActivityOpenNotification
• Sent when a user clicks a link, sends "NewTab Messages".ActivityOpenAction

example payload (with id):

{ 
  "url": "https://example.com/path", 
  "target": "same-tab" 
}
Copy

example payload without id (for example, on history items)

{
  "url": "https://example.com/path",
  "target": "same-tab"
}
Copy

activity_burnAnimationComplete

• Sent when the burn animation completes