API

This section is intended for developers utilizing our APIs to add channels.

Below you will find the keys to generate secret payloads for adding or updating a channel via the Script API.

Refer to the configuration page for detailed information on the purpose and usage of each input.

EVENT_SINK_URL

This secret contains the full URL of the endpoint that will receive the POST requests with events as a JSON payload.

Example value

https://my-domain.com/event

Type

TEXT

Optional

false

EVENT_SINK_FILTER

This secret contains a JSON string describing the event filter with the following structure:

{ events: string[] }

Events are matched using case sensitivity, meaning AddToCart is not the same as addtocart.

Example value

{ "events": ["AddToCart", "Purchase", "MyCustomEvent"] }

Type

TEXT

Optional

true

EVENT_SINK_HEADERS

This secret contains a static list of headers that will be appended with each POST request. It is a JSON string containing the following structure:

[string, string][]

Example value

[
  ["Authentication", "Bearer deadbeef1337"],
  ["X-Caller", "EdgeTag Event Sink"]
]

Type

TEXT

Optional

true