Skip to main content
POST
Create a transform function

Body

application/json
name
string
required

Lowercase identifier for the function (letters, digits, underscores; must start with a letter). Unique per tenant.

Example:

"normalize_event_names"

stage
enum<string>
required

Where the transform runs: source rewrites every inbound event after ingest; destination rewrites the per-destination payload just before delivery.

Available options:
source,
destination
Example:

"source"

spec
object
required

The declarative transform spec — version (currently 1) plus an ordered operations array of bounded object ops (set, default, copy, rename, remove, coalesce, lowercase, uppercase, trim, drop_event) over dot-paths.

Example:
description
string | null

Optional human-readable note (max 500 chars) shown in the rule builder.

Example:

"Snake-case all event names before downstream delivery"

destination_key
string | null

Destination binding — required context when stage is destination; null for a source-stage function.

Example:

null

enabled
boolean
default:true

Whether the pipeline applies the transform. Defaults to true; set false to author ahead of activation.

Example:

true

Response

Successful response.