Trial-run a transformation

POST

/v1/transformations/run

curl --request POST \
  --url https://api.hooks.events/v1/transformations/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "transformationId": "example", "event": { "additionalProperty": "example" } }'

• Production

Requires the endpoints:write scope.

Authorizations

• apiKey
• sessionCookie

Request Body^required

Media typeapplication/json

object

code

string

>= 1 characters <= 20000 characters

transformationId

string

>= 1 characters

event

object

key

additional properties

Example ^generated

{
  "code": "example",
  "transformationId": "example",
  "event": {
    "additionalProperty": "example"
  }
}

Responses

200

Success

Media typeapplication/json

object

skipped

required

boolean

kind

string

Allowed values: object string

output

required

reason

string

key

additional properties

Example

{
  "kind": "object"
}

400

Validation error

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

401

Missing or invalid credentials

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

403

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

429

Rate limited

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

Headers

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets