Skip to main content
POST
Create a scripted transform

Headers

Idempotency-Key
string

Makes a POST safe to retry for 24 hours: the same key, credential, path and body returns the stored response (Idempotent-Replayed: true) instead of running again. 422 if the key was used for a different request; 409 while the first is in flight.

Required string length: 1 - 255

Path Parameters

project_id
string
required

Body

application/json
name
string
required
Required string length: 1 - 80
source
string
required

A JSONata expression over { headers, body, method, query } (an endpoint) or the record { id, dataset, received_at, data } (a destination). It returns an object with body (replaces the payload; for a destination, what is sent), headers (destination only: string values; Hookie's own, framing and credential headers are ignored), drop: true (filter the event out, with an optional reason). Regular expressions, $eval and open-ended ranges are refused; $log(value, label) records a line in the test panel. Length and step budget depend on the plan.

enabled
boolean
default:true
target
object | null

What the transform runs on: one endpoint (at ingest, before its criteria, mappings and the record) or one destination (on that delivery's body). null is a draft: it can be tested, not run. One transform per target.

note
string

Shown beside the version.

Maximum string length: 200

Response

Created, as version 1.

id
string
required
ok
enum<boolean>
required
Available options:
true
transform
object