helo-sdk
v1.1.5
Published
Browser-based Helo Web SDK for event tracking, identity, and profile updates
Maintainers
heloaiReadme
helo-sdk
Browser TypeScript SDK for Helo event tracking, identity, and profile updates.
Licensed by Helo.ai.
Install
npm install helo-sdkQuick start
import { HELO_SDK } from "helo-sdk";
HELO_SDK.init({
apiKey: "pk_live_…",
projectId: "proj_…",
});
HELO_SDK.track("signup_click", { plan: "starter" });
await HELO_SDK.identify("cust_123", { email: "[email protected]" });
await HELO_SDK.logout();Browser script: load dist/browser/helo-sdk.min.js, then use window.HELO_SDK.
Essentials
| Call | When |
|------|------|
| init(config) | Once on page load |
| identify(...) | User logs in |
| logout() | User logs out |
| track(name, props?) | Custom events |
| trackTransaction(name, props?) | Revenue events (transaction: true + monetary validation) |
| flush() | Force send now |
Config highlights: environment (production | staging), optional baseUrl, captureClicks, requireConsent, debugLevel, onError.
Skip auto-captured clicks with data-helo-ignore.
Documentation
Full API reference, payloads, and integration guides live on the Helo SDK documentation website (this README stays intentionally short).
In-repo source for that site: api-docs.md.
License
Proprietary — © Helo.ai. All rights reserved. See LICENSE.