Quickstart
Install the Web SDK, initialize it once at app start, and send your first event.
1. Install
Available via npm / yarn for bundled apps; a CDN snippet is also published for static sites.
⚠ TODO — Engineering
Paste the install command(s) for the Web SDK. Include the package manager (CocoaPods, SPM, Gradle, npm, yarn, etc.) and the latest version pin.
2. Initialize
Initialize the SDK as early as possible — typically in the <head> for synchronous initialization, or after consent is captured for opt-in flows.
⚠ TODO — Engineering
Paste the initialization snippet. Include the API key parameter name, region/endpoint parameter, and any required runtime callbacks. If the SDK supports multiple languages on this runtime (Swift+Obj-C, Kotlin+Java, JS+TS), wrap each in a
<div class='tab'> — the tab switcher in js/docs.js handles the rest.3. Identify a user
⚠ TODO — Engineering
Paste a user-identify snippet showing how to attach a user identifier and basic user properties (email, plan, locale). Note any privacy considerations (PII handling, hashed IDs).
4. Send your first event
⚠ TODO — Engineering
Paste an event-tracking snippet. Use a realistic example event (e.g.
app_opened or checkout_started) with 1-2 properties.5. Verify
⚠ TODO — Engineering
Tell the developer how to verify the Web SDK is connected — link to the live-events view in the panel, mention the typical 1-2 second latency, and what 'success' looks like.
Next steps
- Full API reference — every public method.
- Server-side events — for backend integrations.
- Concepts — Sense / Decide / Act / Learn.