Use userorbit.startTour() to request a tour from your application's own button or workflow.

Start the tour

Initialize Userorbit for the correct workspace first. Pass the tour ID to the SDK:

await userorbit.startTour("YOUR_TOUR_ID");
JavaScript

Replace the placeholder with the tour's ID. Ensure the tour is available to the initialized SDK and that the first step can display on the current page.

Understand the returned promise

The method returns a promise and waits for the queued start operation. Resolving the promise does not mean the user completed the tour, and should not be used as a tour-completion signal.

If the tour is not found, the SDK logs a warning asking you to check initialization and the tour's existence.

Test the integration

Trigger the call as an eligible demo user. Check that the correct tour appears and that the target is visible. Review browser console messages if it does not start.

For a shareable entry point without adding a custom button, open Edit Tour > Settings > Launch link and test the generated link.

Was this helpful?