Setup

• Widget ID: nextSteps
• Add it to the widgets field on initialSetup
• Example:

{
  "...": "...",
  "widgets": [
    {"id":  "nextSteps"},
    {"...":  "..."}
  ]
}
Copy

Requests:

nextSteps_getData

• "NewTab Messages".NextStepsGetDataRequest
• Used to fetch the initial data (during the first render)
• returns "NewTab Messages".NextStepsData - either {content: null} or {content: Array<{id: string}>}
• Note: Please use null to represent when there's nothing to show (instead of an empty array.)
• IDs: Please find the list of supported IDs here "NewTab Messages".NextStepsCards
• Example:

{
  "content": [
    { "id": "bringStuff" },
    { "id": "defaultApp" }
  ]
}
Copy

or:

{
  "content": null
}
Copy

nextSteps_getConfig

• "NewTab Messages".NextStepsGetConfigRequest
• Used to fetch the initial config (during the first render)
• returns "NewTab Messages".NextStepsConfig

Subscriptions:

nextSteps_onDataUpdate

• "NewTab Messages".NextStepsOnDataUpdateSubscription.
• The messages available for the platform
• returns "NewTab Messages".NextStepsData
• as mentioned in the request, please use null to represent when there's nothing to show (instead of an empty array.)

nextSteps_onConfigUpdate

• "NewTab Messages".NextStepsOnConfigUpdateSubscription.
• The widget-specific config, to toggle things like the expansion
• returns "NewTab Messages".NextStepsConfig

Notifications:

nextSteps_action

• "NewTab Messages".NextStepsActionNotification
• Sent when the user clicks the action button
• sends "NewTab Messages".NextStepsActionNotify
• example payload:

{
  "id": "defaultApp"
}
Copy

nextSteps_dismiss

• "NewTab Messages".NextStepsDismissNotification
• Sent when the user clicks the dismiss button
• sends "NewTab Messages".NextStepsDismissNotify
• example payload:

{
  "id": "defaultApp"
}
Copy

nextSteps_setConfig

• "NewTab Messages".NextStepsSetConfigNotification
• Sent when the user toggles the expansion of the next steps
• sends "NewTab Messages".NextStepsConfig
• example payload:

{
  "expansion": "collapsed"
}
Copy