Skip to Content
Quickstart

Quickstart

Pick your platform. Each SDK’s full quickstart, with every option and caveat, lives on its own platform page.

Install

npm install onesygnal-web-sdk

Initialize

import oneSygnal from 'onesygnal-web-sdk'; oneSygnal.init('YOUR_API_KEY', { apiUrl: 'https://sdk-api.1sygnal.app' });

apiUrl is required on web — natives default it, web doesn’t.

Track and identify

oneSygnal.track('page_viewed', { path: window.location.pathname }); oneSygnal.identify('user_123', { plan: 'pro' });

See the Web SDK for the full API, event names, and troubleshooting.