Amplitude
Amplitude is a product analytics platform with
built-in identity, revenue, groups, and optional session replay, feature
experiments, and guides & surveys. This destination forwards walkerOS events
to Amplitude via the official
@amplitude/unified
SDK, translating events into amplitude.track(...), identify(...),
revenue(...), setGroup(...), and setOptOut(...) calls.
Amplitude is a web destination in the walkerOS flow:
Loads the Amplitude Analytics SDK, forwards every walkerOS event, and lets you layer on identity, revenue, groups, consent toggling, and optional plugins.
Installation
Setup
- Integrated
- Bundled
Configuration reference
All fields of Amplitude's BrowserOptions pass through to
amplitude.init(apiKey, options). walkerOS-specific additions are:
| Property | Type | Description | More |
|---|---|---|---|
apiKey | string | Your Amplitude project API key. Find it in your Amplitude project settings under "General" → "API Keys" (like a1b2c3d4e5f6789012345678abcdef12). | |
serverZone | 'US' | 'EU' | Amplitude server zone. Default: US. | |
flushIntervalMillis | integer | How often (in ms) to flush the event queue. Default: 1000. | |
flushQueueSize | integer | Max queued events before a flush. Default: 30. | |
flushMaxRetries | integer | Max retries on failed flush. Default: 5. | |
transport | 'fetch' | 'xhr' | 'beacon' | HTTP transport. Default: fetch. | |
useBatch | boolean | Use the Amplitude batch endpoint instead of the standard endpoint. Default: false. | |
appVersion | string | Application version; tagged onto every event. | |
identify | any | walkerOS mapping value resolving to an identity object. Keys: user, device, session, set, setOnce, add, append, prepend, preInsert, postInsert, remove, unset, clearAll. | |
sessionReplay | any | Session Replay options. When present, session replay is enabled via @amplitude/unified with the provided options. | |
experiment | any | Feature Experiment config. Must include `deploymentKey`. When present, the experiment plugin from @amplitude/unified is configured with the provided options. | |
engagement | any | Guides & Surveys config. Pass `true` for defaults, or an options object for custom configuration. Enabled via @amplitude/unified. |
Mapping data.examples
The code data.examples are interactive. You can edit the code to generate your individual event mapping.
Default event forwarding
Every walkerOS event becomes amplitude.track(event.name, event_properties).
Without include config, event_properties is empty. Add include: ['data']
to the destination config to forward event data as properties.
User login identify
Set the user ID and enrich user properties with the full operation
vocabulary (set, setOnce, add, ...). Use skip: true to suppress
the default track call.
Multi-product order with revenue loop
Use loop inside settings.revenue to fire one amplitude.revenue()
call per nested product. The order-level track() still fires once.
Subscription revenue
Single-object revenue mapping for non-cart flows like subscription
renewals. Currency falls back to "EUR" when data.currency is missing.
Group assignment with properties
Assign a user to a group and enrich group properties in one rule.
Consent
Declare the required consent keys on config.consent. When a walker
consent event arrives, the destination's on('consent') handler toggles
amplitude.setOptOut() with strict semantics: all required keys must be
granted for opt-in, any missing grant opts out.
config: {
consent: { analytics: true },
settings: { apiKey: 'YOUR_KEY' },
}
Plugins
All three plugin packages are npm-bundled with the destination (~135 KB for Session Replay plus Experiment and Engagement payloads). Enable them via destination settings:
settings: {
apiKey: 'YOUR_KEY',
sessionReplay: { sampleRate: 1 },
experiment: { deploymentKey: 'DEPLOYMENT_KEY' },
engagement: true,
}