Skip to main content
The Worth Onboarding SDK embeds the Worth onboarding experience directly into your website’s DOM. Instead of managing an iframe, you give the SDK a mount point and a set of lifecycle callbacks, and it will render, run, and tear down the onboarding flow for you. When compared to its predecessor, SDK 3 offers greater performance, greater configurability, and native integration with your host application.
Already integrated with Onboarding SDK 2? See the Migration Guide for a full breakdown of what has changed and a step-by-step checklist for migrating to SDK 3.

​
Why Use the Onboarding SDK?

The SDK enables:
  • Faster integration: Reduce custom development work and integrate Worth’s onboarding functionality quickly
  • Branded experience: Maintain your brand identity while utilizing Worth’s core functionality
  • Flexible embedding: The onboarding flow mounts directly into a DOM element that you control
  • Type-safe communication: Built-in TypeScript support with type-safe message passing

​
Installation

Install the SDK via npm: 
npm install @worthai/onboarding-sdk

​
Quick Start

Note: The following example is illustrative code for vanilla TypeScript. Adapt to your framework’s patterns when using React or other JavaScript frameworks. 
import { createWorthOnboarding } from '@worthai/onboarding-sdk';

// Create a worth onboarding instance and communicate with it
const onboarding = createWorthOnboarding({
  // Make sure to have password login disabled on Worth Admin
  // before using inviteToken
  inviteToken: '{{YOUR_INVITE_TOKEN}}',
  // Listen for onboarding messages
  onStepSubmit: ({ stepId, values }) => {
    console.log('Step submitted:', stepId, values);
  },
  onComplete: ({ values }) => {
    console.log('Onboarding completed:', values);
  },
  onError: (error) => {
    console.error('Onboarding error:', error);
  },
});

// Mount the onboarding instance
await onboarding.mount('#worth-onboarding');

// When the containing route or component unloads:
// onboarding.unmount();

<!-- In your HTML: -->
<div id="worth-onboarding"></div>
See the full Quick Start Guide for a step-by-step walkthrough, including cleanup and error handling.

​
Scope and Limitations

​
What’s In Scope

  • ✅ Applicant onboarding flow embedded directly in the host page DOM
  • ✅ JavaScript/TypeScript web SDK
  • ✅ Modern browser support (last 2 versions of Chrome, Firefox, Safari, Edge)
  • ✅ Client-side rendering

​
What’s Out of Scope

  • ❌ Non-onboarding Worth products
  • ❌ Mobile native SDKs (iOS/Android)
  • ❌ Server-side rendering support
  • ❌ Offline functionality
  • ❌ Legacy browser support

​
Browser Support

The SDK supports modern browsers only:
  • Chrome (last 2 versions)
  • Firefox (last 2 versions)
  • Safari (last 2 versions)
  • Edge (last 2 versions)

​
Next Steps

​
Support

For questions or issues, please contact your Worth Customer Success team or reach out to support@joinworth.com.