API

Source code Package Browser ES5

The walker.js API destination allows you to send events to a custom API endpoint using walker.js library. This can be useful when you want to send data to a backend system for further processing or any external services.

Installation

TypeScript

Install the destination via npm

npm i @elbwalker/destination-web-api

import { elb } from '@elbwalker/walker.js';
import destinationAPI from '@elbwalker/destination-web-api';

elb('walker destination', destinationAPI, config);

Script

Load the destination via dynamic import

<script>
  // Upload the dist/index.mjs on your own server
  const destination = (
    await import(
      'https://cdn.jsdelivr.net/npm/@elbwalker/destination-web-api/dist/index.mjs'
    )
  ).default;

  elb('walker destination', destination, config);
</script>

Code

Copy the code from the index.browser.js file

(function () {
  'use strict';
  var Destination = (() => {})(); // This is the copied code

  elb('walker destination', Destination.default, config);
})();

Configuration

Set up the config for the destination.

Custom Config

{
  url: 'https://localhost:3000/api',
  transform: (event, config, mapping) => {
    return JSON.stringify(event);
  },
  transport: 'fetch',
}

{ url: 'https://localhost:3000/api', transform: (event, config, mapping) => { return JSON.stringify(event); }, transport: 'fetch', }

Result

No event yet.

No event yet.

Property	Type	Description
url*	string	URL to send the events to.
transform	function	A function to transform the events before sending them to the URL.
transport	fetch (default), xhr, beacon	The transport method to use when sending events.

Properties with a * are required.

If no transform function is provided, the event data will be transformed using JSON.stringify.

Mapping

By default the sendWeb function is used to send the events to an API.

Event

{
  event: "entity action",
  data: {
    string: "foo",
    number: 1,
    boolean: true,
    array: [
      0,
      "text",
      false
    ]
  },
  context: {
    dev: [
      "test",
      1
    ]
  },
  globals: {
    lang: "elb"
  },
  custom: {
    completely: "random"
  },
  user: {
    id: "us3r",
    device: "c00k13",
    session: "s3ss10n"
  },
  nested: [
    {
      type: "child",
      data: {
        is: "subordinated"
      },
      nested: [],
      context: {
        element: [
          "child",
          0
        ]
      }
    }
  ],
  consent: {
    functional: true
  },
  id: "1745367217000-gr0up-1",
  trigger: "test",
  entity: "entity",
  action: "action",
  timestamp: 1745367217000,
  timing: 3.14,
  group: "gr0up",
  count: 1,
  version: {
    source: "0.0.7",
    tagging: 1
  },
  source: {
    type: "web",
    id: "https://localhost:80",
    previous_id: "http://remotehost:9001"
  }
}

{ event: "entity action", data: { string: "foo", number: 1, boolean: true, array: [ 0, "text", false ] }, context: { dev: [ "test", 1 ] }, globals: { lang: "elb" }, custom: { completely: "random" }, user: { id: "us3r", device: "c00k13", session: "s3ss10n" }, nested: [ { type: "child", data: { is: "subordinated" }, nested: [], context: { element: [ "child", 0 ] } } ], consent: { functional: true }, id: "1745367217000-gr0up-1", trigger: "test", entity: "entity", action: "action", timestamp: 1745367217000, timing: 3.14, group: "gr0up", count: 1, version: { source: "0.0.7", tagging: 1 }, source: { type: "web", id: "https://localhost:80", previous_id: "http://remotehost:9001" } }

Custom Config

{
  data: "data"
}

{ data: "data" }

Result

No event yet.

No event yet.

info

If you need professional support with your walkerOS implementation, check out our services.