Open the Userorbit widget to a specific view

Use the Userorbit widget API when you want your own buttons, links, or product UI to open a specific part of the in-app widget.

Before you start

Once the Userorbit SDK is loaded, call window.userorbit.openWidget() from your application.

Open a module

Pass tab to choose the first view users see. Supported values are home, feedback, roadmap, updates, and help.

// Open announcements / updates
window.userorbit.openWidget({ tab: "updates" });

// Open roadmap
window.userorbit.openWidget({ tab: "roadmap" });

// Open help center
window.userorbit.openWidget({ tab: "help" });

// Open feedback
window.userorbit.openWidget({ tab: "feedback" });

Show only one module

Use activeTabs when you want the widget to behave like a standalone module and hide the other tabs.

window.userorbit.openWidget({
  tab: "updates",
  activeTabs: ["updates"]
});

window.userorbit.openWidget({
  tab: "roadmap",
  activeTabs: ["roadmap"]
});

window.userorbit.openWidget({
  tab: "help",
  activeTabs: ["help"]
});

If you want users to move between modules after the widget opens, omit activeTabs or include multiple tabs.

Open a specific item

You can also deep-link into a specific announcement, roadmap item, feedback topic, or help article.

window.userorbit.openWidget({
  tab: "updates",
  announcementId: "<announcement-id>"
});

window.userorbit.openWidget({
  tab: "roadmap",
  roadmapId: "<roadmap-id>"
});

window.userorbit.openWidget({
  tab: "feedback",
  topicId: "<topic-id>"
});

window.userorbit.openWidget({
  tab: "help",
  articleId: "<article-id>"
});

Open the feedback form directly

window.userorbit.openWidget({
  tab: "feedback",
  showFeedbackForm: true
});

For a compact standalone feedback form, use:

window.userorbit.openWidget({
  tab: "feedback",
  showFeedbackForm: true,
  compact: true
});

Option reference

Option	Use
`tab`	Opens the widget to a module: `home`, `feedback`, `roadmap`, `updates`, or `help`.
`activeTabs`	Limits which modules are available in the widget. Use one value for a standalone module.
`announcementId`	Opens a specific announcement in the updates view.
`roadmapId`	Opens a specific roadmap item.
`topicId`	Opens a specific feedback topic.
`articleId`	Opens a specific help-center article.
`showFeedbackForm`	Opens the feedback form instead of the feedback list.
`compact`	Opens the compact feedback form when used with `showFeedbackForm`.
`modal`	Opens the widget in modal mode.
`position`	Controls the widget position: `bottom-right`, `bottom-left`, or `top-right`.
`locale` / `language`	Opens localized help-center content when available.

Help Center