Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hookdeck Transformations API

Manage transformations — sandboxed JavaScript executed against events to mutate headers, body, path, or query string before delivery. Also includes a sandboxed run endpoint for testing transformation code against sample event payloads.

Hookdeck Transformations API is one of 17 APIs that Hookdeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Transformations, Webhooks, and Event Gateways. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 10 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.hookdeck.com/2025-07-01.

10 operations 6 paths 12 schemas 1 DELETE5 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hookdeck.com/2025-07-01
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Hookdeck Transformations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Transformations 10

A transformation represents JavaScript code that will be executed on a connection's requests. Transformations are applied to connections using Rules.

GET
/transformations
Retrieve transformations
getTransformations 7 params → 200400422
POST
/transformations
Create a transformation
createTransformation body → 200400422
PUT
/transformations
Create/Update a transformation
upsertTransformation body → 200400422
GET
/transformations/count
Get transformations count
getTransformationsCount → 200400422
GET
/transformations/{id}
Retrieve a transformation
getTransformation 1 param → 200404
DELETE
/transformations/{id}
Delete a transformation
deleteTransformation 1 param → 200404
PUT
/transformations/{id}
Update a transformation
updateTransformation 1 param body → 200400404422
PUT
/transformations/run
Test a transformation
testTransformation body → 200400422
GET
/transformations/{id}/executions
Get transformation executions
getTransformationExecutions 10 params → 200400422
GET
/transformations/{id}/executions/{execution_id}
Get a transformation execution
getTransformationExecution 2 params → 200404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are TransformationExecution (13 properties), Transformation (9 properties), ShortEventData (6 properties), TransformationExecutorOutput (6 properties). Each schema is shown below with its type and property counts.

TransformationPaginatedResult
object
3 properties
TransformationExecutionLogLevel
string
The minimum log level to open the issue on
TransformationExecution
object
13 properties 9 required
ShortEventData
object
Request data
6 properties 5 required
TransformationExecutorOutput
object
6 properties 1 required
APIErrorResponse
object
Error response model
4 properties 3 required
Operators
object
6 properties
OrderByDirection
Transformation
object
9 properties 6 required
ConsoleLine
object
2 properties 2 required
TransformationExecutionPaginatedResult
object
3 properties
SeekPagination
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hookdeck-transformations-api-openapi.yml Raw ↑

Other APIs Hookdeck publishes across the network.

Hookdeck Connections API
Hookdeck Sources API
Hookdeck Destinations API
Hookdeck Events API
Hookdeck Requests API
Hookdeck Bookmarks API
Hookdeck Issues API
Hookdeck Metrics API
Hookdeck Integrations API
Hookdeck Notifications API
Hookdeck Attempts API
Hookdeck Bulk cancel events API