Destinations
Destinations are the endpoints where walkerOS sends your processed events. They transform standardized walkerOS events into the specific formats required by analytics platforms, marketing tools, data warehouses, and custom APIs.
Each destination operates independently, so one failed destination won't affect others.
When delivery fails
An event that a destination did not deliver is never counted as delivered. The
push result lists the destination under failed with a reason (a code, a
message and whether a retry could help), the destination's failed counter
moves, the event goes to its dead-letter queue and the collector writes one
ERROR line per cause and minute. This covers a failed request (including an
error status or a rejected answer inside a 200), a missing required setting,
an event the destination cannot send, a vendor script that did not load, and a
destination whose init failed. See Logger
for the codes.
Two things are not failures. An event without the destination's required
consent waits: the push result lists the destination under queued with the
reason consent, no line is logged, and the event is sent once consent is
granted. A server flow built by the CLI skips such an event instead, with one
DEBUG line (see
consent-denied events on a server).
A rule with ignore: true or silent: true
is a decision, not an error, and every destination honours both. A silent rule whose side-effect mapping (identify, group and the like) resolves to nothing sends nothing, counts as delivered and writes one DEBUG line that names the call and the mapping key, never the value. Events a
destination batches answer queued until the flush.
Analytics tools
| Destination | Web | Server |
|---|---|---|
| Amplitude | Yes | Yes |
| Clarity | Yes | - |
| d8a | Yes | - |
| FullStory | Yes | - |
| GA4 | Yes | - |
| GTM | Yes | - |
| Heap | Yes | - |
| Hotjar | Yes | - |
| Matomo | Yes | - |
| Mixpanel | Yes | Yes |
| mParticle | - | Yes |
| Optimizely | Yes | - |
| Piano | Yes | - |
| Piwik PRO | Yes | Yes |
| Plausible | Yes | - |
| PostHog | Yes | Yes |
| RudderStack | - | Yes |
| Segment | Yes | Yes |
| Snowplow | Yes | - |
Marketing tools
| Web | Server | |
|---|---|---|
| Bing | - | Bing UET Conversions API |
| Criteo | - | Criteo Events API |
| Customer.io | - | Customer.io |
| Google Ads | Google Data Manager API | |
| HubSpot | - | HubSpot |
| Klaviyo | - | Klaviyo |
| LinkedIn Insight Tag | LinkedIn Conversions API | |
| Meta | Meta Pixel | Meta Conversions API |
| Pinterest Tag | Pinterest Conversions API | |
| - | Reddit Conversions API | |
| Slack | - | Slack |
| Snapchat | - | Snapchat Conversions API |
| TikTok | TikTok Pixel | TikTok Events API |
| X (Twitter) | - | X (Twitter) Conversions API |
Data warehouses
| Destination | Web | Server |
|---|---|---|
| API | Yes | Yes |
| Apache Kafka | - | Yes |
| AWS Firehose | - | Yes |
| AWS SNS | - | Yes |
| ClickHouse | - | Yes |
| File | - | Yes |
| GCP BigQuery | - | Yes |
| Google Pub/Sub | - | Yes |
| Redis Streams | - | Yes |
| SQLite | - | Yes |
Server SDK destinations
The server destinations for Segment, RudderStack, Amplitude and PostHog batch by default (15, 20, 200 and 20 events, each with a 10 second wait) and send a batch through pushBatch. Each event keeps its own outcome, so a failed delivery fails that event and lands in the dead-letter queue. config.batch: { size: 1 } sends each event at once; there is no JSON switch that turns the default batch off. Options are in Batch scheduling.
- Acknowledgement: a batched event answers
queuedwith the reasonbatch, so a server source acknowledges the producer when the event is queued. A failed flush is reported (one ERROR line with the status, the failed counter, the dead-letter queue) but the message is not redelivered. - Retry budget: the SDK retries inside the destination's
config.timeout: a quarter of it per attempt, at most two retries. A value set in the settings wins. RudderStack has atimeoutsetting. Amplitude's requests time out through walkerOS's own transport, and a vendor that never answers fails after the budget. - Deduplication: each destination passes
event.idas the vendor's dedup id (messageIdfor Segment and RudderStack,insert_idfor Amplitude, a UUID derived fromevent.idon PostHog'scaptureonly; other call types of Segment, RudderStack and Amplitude use<event id>-<type>). Delivery is at least once, and the vendor drops duplicates.
Create your own
Build a custom destination for any endpoint. See Create your own destination for a step-by-step guide.
Configuration
These fields are available on every destination, regardless of package. They
wrap the package-specific settings field, which is documented on each
destination's page.
| Property | Type | Description | More |
|---|---|---|---|
consent | WalkerOS.Consent | Required consent states to send events to this destination | |
credentials | Destination.Credentials | Optional credentials (destination-defined shape) | |
data | any | any | Global data transformation applied to all events for this destination | |
include | Array<string> | Event sections to flatten into context.data | |
env | Destination.Env | Environment dependencies (platform-specific) | |
id | string | Destination instance identifier (defaults to destination key) | |
loadScript | boolean | Whether to load external script (for web destinations) | |
mapping | Mapping.Rules | Entity-action specific mapping rules for this destination | |
policy | Mapping.Policy | Pre-processing policy rules applied before event mapping | |
queue | boolean | Whether a destination added later receives events pushed earlier in the current run (default true). Consent-denied events are queued regardless. | |
require | Array<string> | Defer destination initialization until these collector events fire (e.g., ["consent"]) | |
logger | Logger.Config | Logger configuration (level, handler) to override the collector defaults | |
setup | boolean | object | Provisioning options for `walkeros setup`, which runs only when invoked (boolean enables defaults, object configures specifics) | |
before | Route | Transformer chain run for this destination only, before it receives the event. | |
next | Route | Post-push transformer chain. Runs after destination push completes; push response is available at ingest._response. | |
cache | EventCache.Config | Cache configuration for deduplication; skip push on cache HIT | |
state | State.Config | State.Config[] | Declarative store get/set operations applied around this destination | |
disabled | boolean | Completely skip this destination (no init, no push, no queue) | |
queueMax | number | Maximum consent-denied events retained in queuePush for this destination. FIFO drop on overflow. Default 1000. | |
dlqMax | number | Maximum failed-push entries retained in dlq for this destination. FIFO drop on overflow. Default 100. | |
timeout | number | Per-destination delivery timeout in ms (default 10000); a delivery that does not settle in this window is routed to the DLQ like a thrown push. | |
batch | number | object | Enables batching for all of this destination's events into one shared default buffer; a mapping rule's own batch splits that entity-action into its own buffer and overrides per field. Bare number is the debounce wait window; object form supports wait (debounce ms), size (count cap, default 1000), age (max ms since first entry, default 30000). | |
breaker | number | object | Per-destination circuit breaker (presence-gated). After threshold consecutive retryable failures (such as a network error, a timeout, or a 429 or 5xx answer; any other 4xx, a missing setting or a runtime failure does not count) the breaker opens and events fail with breaker-open (counted, kept in the DLQ) until cooldown ms elapse, then one probe is admitted; success closes it, failure re-opens it. Partial-batch row failures are breaker-neutral. Bare number is the threshold; object form supports threshold (default 5) and cooldown (default 30000ms). |