Skip to main content

Looking for Quick Setup?

For getting started quickly, check out our streamlined integration guides:

Advanced Integration Patterns

For developers who need more complex implementations and real-world patterns:

Quick Reference

Universal Installation

All UserBoost integrations follow the same pattern:
  • NPM Package
  • Script Tag
  • REST API
npm install @userboost/sdk
import { UserBoost } from '@userboost/sdk';
UserBoost.init({ apiKey: 'your_key' });

Common Event Patterns

// User actions
ub.event('button_clicked', {
  user: { id: 'user_123' },
  properties: { button: 'signup', location: 'header' }
});

// Page/screen views
ub.event('page_viewed', {
  user: { id: 'user_123' },
  properties: { page: '/dashboard', referrer: document.referrer }
});

// Onboarding steps
ub.event('onboarding_step_completed', {
  user: { id: 'user_123' },
  properties: { step: 'profile_setup', completion: 75 }
});

Need Help?

I