Web API Destination
The web API destination allows you to send events from the browser to any HTTP endpoint with customizable data transformation and transport methods.
Where This Fits
Web API is a web destination in the walkerOS flow:
Sends events from the browser to any HTTP endpoint using fetch, XHR, or beacon transport with customizable request formatting.
Installation
Loading...
Setup
- Integrated
- Bundled
Loading...
Configuration reference
| Property | Type | Description | More |
|---|---|---|---|
url | string | The HTTP endpoint URL to send events to | |
headers | Record<string, string> | Additional HTTP headers to include with requests | |
method | string | HTTP method for the request | |
transform | function | Function to transform event data before sending | |
transport | 'fetch' | 'xhr' | 'beacon' | Transport method for sending requests |
Required fields
Usage
Basic Usage
Loading...
Advanced Usage with Transform
Loading...
Examples
Sending to Analytics API
Loading...
Using Beacon Transport
For critical events that need to be sent even when the page is unloading:
Loading...
Custom Data Mapping
Use mapping rules to control which events are sent:
Loading...
Transport methods
- fetch (default): Modern, promise-based HTTP requests
- xhr: Traditional XMLHttpRequest for older browser compatibility
- beacon: Uses Navigator.sendBeacon() for reliable data transmission during page unload
Mapping
By default the sendWeb function
is used to send the events to an API.
Event
Loading...
Mapping
Loading...
Result
Loading...
💡 Need Professional Support?
Need professional support with your walkerOS implementation? Check out our services.