Welcome to Userorbit! This reference article provides quick answers to the most common questions new users have when getting started with our platform.
Frequently Asked Questions
How do I install Userorbit?
Userorbit can be installed by embedding the SDK script into your application. The snippet connects your product to our platform, enabling all Userorbit features. See the Install the Userorbit script on your site guide for detailed instructions.
How do I identify users?
To personalize user experiences and track analytics, pass user identity during SDK initialization. Pass userId, email, name, and custom attributes in the init() config. There is no separate identify method. See the User identity API reference for details.
Can I use Userorbit with a SPA (Single Page Application)?
Yes, Userorbit works with SPAs. Call userorbit.registerRouteChange() on each client-side route change so page-targeted tours and surveys can trigger correctly. Framework-specific guides are available for React, Vue, Angular, and Next.js.
Does Userorbit work with React/Vue/Angular?
Absolutely! Userorbit works with popular JavaScript frameworks. The SDK installs via npm install userorbit-js and initializes with userorbit.init({accountId: "YOUR_ACCOUNT_ID"}). Dedicated guides are available for React, Vue, Angular, and Next.js in the help center.
How do I test tours before going live?
You can test tours in a staging environment or by using Userorbit preview mode, which allows you to experience tours as your users would without publishing them. This helps ensure everything looks and functions correctly.
How do I invite my team?
Inviting team members can be done from Settings → Team members in the admin panel. You can assign different roles and permissions to control access levels.
What is the difference between tours and checklists?
Product Tours are interactive, guided walkthroughs designed to showcase features and onboarding flows. Checklists are task-oriented lists that help users complete specific actions or milestones.
How do I set up a custom domain?
Setting up a custom domain allows you to brand your Userorbit-powered content with your own URL. This can be configured in your workspace settings under Settings → General.
Can I use Userorbit on multiple products?
Yes, Userorbit supports managing multiple projects under a single workspace. Each project can have its own widget configuration, contacts, and module settings, providing clear separation and organization.
How do I contact support?
You can contact Userorbit support through the widget in your application, by emailing our support team, or by visiting our help center. Our team is available to assist with any questions or issues you may encounter.
Notes
- For the most up-to-date information and advanced configurations, always refer to the detailed articles in the help center.
- Keep your SDK up to date to access the latest features and improvements. Check Settings → Widget in your admin panel for the latest snippet.