Skip to main content

API Destination

Web Source code Package

The API destination allows you to send events to any HTTP endpoint with customizable data transformation and transport methods.

Installation​

Loading...

Setup​

Loading...

Configuration reference​

PropertyTypeDescriptionMore
url*stringThe HTTP endpoint URL to send events to
headersRecord<string, string>Additional HTTP headers to include with requests
methodstringHTTP method for the request
transformfunctionFunction 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.