Skip to main content
Server Source code Package

Express

Turn-key HTTP event collection server with Express.js. Handles JSON POST events, pixel tracking (GET), CORS, and health checks.

Features

  • Standalone or embedded: Start server automatically or integrate with existing Express app
  • CORS support: Configurable cross-origin resource sharing
  • Pixel tracking: 1x1 transparent GIF for GET requests
  • Health checks: Built-in /health and /ready endpoints
Where This Fits

The Express Source is a server source in the walkerOS flow:

It receives events via HTTP (POST/GET) and forwards them to configured destinations.

Installation

Loading...
path setting renamed to paths

The path setting has been renamed to paths (array). The old path still works but is deprecated and will be removed in the next major version.

// Before (deprecated)
settings: { path: '/events' }

// After
settings: { paths: ['/events'] }

Quick start

Standalone server

Loading...

App-Only Mode

Loading...

Configuration

PropertyTypeDescriptionMore
portintegerHTTP server port to listen on. Use 0 for random available port. If not provided, server will not start (app only mode)
pathstringDeprecated: use paths instead
pathsArray<any>Route paths to register. String shorthand registers GET+POST. RouteConfig allows per-route method control.
cors*boolean | objectCORS configuration: false = disabled, true = allow all origins (default), object = custom configuration
status*booleanEnable health check endpoints (/health, /ready)
* Required fields

HTTP methods

MethodEndpointDescription
POST/collectJSON event ingestion
GET/collectPixel tracking (returns 1x1 GIF)
OPTIONS/collectCORS preflight
GET/healthLiveness check
GET/readyReadiness check

Ingest Metadata

Extract request metadata (IP, user agent, headers) and forward it through the pipeline to transformers and destinations.

Loading...

Available Ingest Paths

PathDescription
ipClient IP address
headers.*HTTP headers (user-agent, origin, referer, etc.)
protocolRequest protocol (http/https)
methodHTTP method (GET, POST, etc.)
hostnameRequest hostname
urlFull request URL

Advanced Mapping

Use walkerOS mapping features for complex extraction:

Loading...

Example request

Loading...
💡 Need Professional Support?
Need professional support with your walkerOS implementation? Check out our services.