Technical Integration

Everything you need to integrate SmartOnboard into your frontend and backend stacks. Choose the method that best fits your needs.

Authentication

All API requests must include your API key. For the tracking snippet, use the data-key attribute. For REST API calls, include the X-API-Key header.

X-API-Key: YOUR_API_KEY

Tracking Snippet

The easiest way to track users is by adding our lightweight snippet to your site's <head>.

<script
  src="https://app.smartonboard.io/api/v1/sb.js"
  data-key="YOUR_API_KEY"
></script>

Custom Events

Track specific actions like "clicked_upgrade" or "completed_onboarding" using the window.SmartOnboard.track method.

window.SmartOnboard.track("event_name", { plan: "pro" });

Identify Users

Associate tracked events with a specific user ID to see individual user journeys.

window.SmartOnboard.identify("user_123");

REST API

Send events from your backend using our REST API. Useful for tracking server-side actions.

POST/api/events

{ "event": "server_side_action", "userId": "user_123", "properties": { "source": "backend" } }

Limits & Constraints

Rate Limiting

1,000 requests per minute per workspace. Batched events count as a single request.

Payload Size

Maximum event payload size is 64KB. Properties beyond this limit will be truncated.

Back to Docs Go to Dashboard