Transformations

Create transformation

Creates a reusable payload transformation template

post/api/v1/projects/{projectId}/transformations

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/projects/{projectId}/transformations
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

projectIdstring uuid required

Request body

namestring required

Human-readable name for the transformation

descriptionstring

Description of what this transformation does

templatestring required

The transformation itself: a JSON template with ${$.jsonpath} expressions when kind is TEMPLATE, or a JavaScript function handler(webhook) { ... } when kind is JAVASCRIPT

kind'TEMPLATE' | 'JAVASCRIPT'

The language the template is written in. Omitted means TEMPLATE, which is what every transformation was before JavaScript existed.

enabledboolean

Whether this transformation is active

Example request

{
  "name": "Stripe v2 → CRM v1",
  "description": "Normalizes Stripe payment events to CRM format",
  "kind": "TEMPLATE",
  "enabled": true
}

Response

Transformation created

Changes

No recorded changes to this operation across all 1 revision of this API.