Installation
Install the @converlay/sdk package to add server-side event tracking to any headless storefront — Hydrogen, Next.js, Remix, Nuxt, or plain HTML.
Install the package
npm
npm install @converlay/sdkpnpm
pnpm add @converlay/sdkyarn
yarn add @converlay/sdkPackage details
Zero dependencies, ~2 KB gzipped. Ships ESM + CJS dual build targeting ES2020.
Configuration options
| Option | Type | Default | Description |
|---|---|---|---|
shopDomain | string | — | Required. Your .myshopify.com domain |
endpoint | string | https://converlay.app/api/events/collect | Collection API endpoint |
autoPageView | boolean | false | Automatically send page_view on init |
debug | boolean | false | Log events to the browser console |
consent | ConsentInput | {analytics: true, marketing: true} | Initial consent state |
Entry points
| Import | Contents |
|---|---|
@converlay/sdk | createConverlay factory function |
@converlay/sdk/react | ConverlayProvider + useConverlay hook (peer dep: react >= 18) |