Transforms API

Transforms modify webhook payloads before delivery using JSONata, JavaScript, Liquid, or XSLT.

Endpoints

Method	Path	Description
GET	`/api/transforms`	List transforms
POST	`/api/transforms`	Create transform
GET	`/api/transforms/{id}`	Get transform
PATCH	`/api/transforms/{id}`	Update transform
DELETE	`/api/transforms/{id}`	Delete transform

Transform Object

json

{
  "id": "tfm_abc123",
  "name": "GitHub to Slack",
  "description": "Format GitHub events for Slack",
  "type": "javascript",
  "code": "function transform(payload) { return { text: payload.action }; }",
  "inputFormat": "json",
  "outputFormat": "json",
  "routeCount": 3,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Transform Types

Type	Description
`jsonata`	JSONata expression (default)
`javascript`	JavaScript function
`liquid`	Liquid template
`xslt`	XSLT stylesheet

Input/Output Formats

Format	Description
`json`	JSON (default)
`xml`	XML
`text`	Plain text

List Transforms

http

GET /api/transforms

Query Parameters

Parameter	Type	Description
page	number	Page number (default: 1)
pageSize	number	Items per page (default: 20, max: 100)
search	string	Search by name
type	string	Filter by type: `jsonata`, `javascript`, `liquid`, `xslt`

Example

curlJavaScriptPython

bash

curl https://api.hookbase.app/api/transforms \
  -H "Authorization: Bearer whr_your_api_key"

javascript

const response = await fetch('https://api.hookbase.app/api/transforms', {
  headers: {
    'Authorization': 'Bearer whr_your_api_key'
  }
});
const { data } = await response.json();

python

import requests

response = requests.get(
  'https://api.hookbase.app/api/transforms',
  headers={'Authorization': 'Bearer whr_your_api_key'}
)
data = response.json()['data']

Response

json

{
  "data": [
    {
      "id": "tfm_abc123",
      "name": "GitHub to Slack",
      "type": "javascript",
      "routeCount": 3,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 5,
    "page": 1,
    "pageSize": 20
  }
}

Create Transform

http

POST /api/transforms

Request Body

Field	Type	Required	Description
name	string	Yes	Display name
code	string	Yes	Transform code
description	string	No	Optional description
type	string	No	Transform type (default: `jsonata`)
inputFormat	string	No	Input format (default: `json`)
outputFormat	string	No	Output format (default: `json`)

Example

curlJavaScriptPython

bash

curl -X POST https://api.hookbase.app/api/transforms \
  -H "Authorization: Bearer whr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Extract Fields",
    "type": "jsonata",
    "code": "{ \"event\": action, \"repo\": repository.full_name }",
    "description": "Extract key fields from GitHub webhooks"
  }'

javascript

const response = await fetch('https://api.hookbase.app/api/transforms', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer whr_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Extract Fields',
    type: 'jsonata',
    code: '{ "event": action, "repo": repository.full_name }',
    description: 'Extract key fields from GitHub webhooks'
  })
});
const data = await response.json();

python

import requests

response = requests.post(
  'https://api.hookbase.app/api/transforms',
  headers={'Authorization': 'Bearer whr_your_api_key'},
  json={
    'name': 'Extract Fields',
    'type': 'jsonata',
    'code': '{ "event": action, "repo": repository.full_name }',
    'description': 'Extract key fields from GitHub webhooks'
  }
)
data = response.json()

Response

json

{
  "id": "tfm_new123",
  "name": "Extract Fields",
  "description": "Extract key fields from GitHub webhooks",
  "type": "jsonata",
  "code": "{ \"event\": action, \"repo\": repository.full_name }",
  "inputFormat": "json",
  "outputFormat": "json",
  "routeCount": 0,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

TIP

The code is validated on creation. If there are syntax errors, the API returns a 400 response with details about the error.

Get Transform

http

GET /api/transforms/{id}

Example

curlJavaScriptPython

bash

curl https://api.hookbase.app/api/transforms/tfm_abc123 \
  -H "Authorization: Bearer whr_your_api_key"

javascript

const response = await fetch('https://api.hookbase.app/api/transforms/tfm_abc123', {
  headers: {
    'Authorization': 'Bearer whr_your_api_key'
  }
});
const data = await response.json();

python

import requests

response = requests.get(
  'https://api.hookbase.app/api/transforms/tfm_abc123',
  headers={'Authorization': 'Bearer whr_your_api_key'}
)
data = response.json()

Response

Returns the full transform object.

Update Transform

http

PATCH /api/transforms/{id}

Request Body

All fields are optional. Only provided fields are updated.

Field	Type	Description
name	string	Display name
code	string	Transform code
description	string	Optional description
type	string	Transform type
inputFormat	string	Input format
outputFormat	string	Output format

Example

curlJavaScriptPython

bash

curl -X PATCH https://api.hookbase.app/api/transforms/tfm_abc123 \
  -H "Authorization: Bearer whr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "{ \"event\": action, \"repo\": repository.full_name, \"sender\": sender.login }"
  }'

javascript

const response = await fetch('https://api.hookbase.app/api/transforms/tfm_abc123', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer whr_your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    code: '{ "event": action, "repo": repository.full_name, "sender": sender.login }'
  })
});
const data = await response.json();

python

import requests

response = requests.patch(
  'https://api.hookbase.app/api/transforms/tfm_abc123',
  headers={'Authorization': 'Bearer whr_your_api_key'},
  json={
    'code': '{ "event": action, "repo": repository.full_name, "sender": sender.login }'
  }
)
data = response.json()

Response

Returns the updated transform object.

Delete Transform

http

DELETE /api/transforms/{id}

WARNING

A transform cannot be deleted while it is assigned to active routes. Remove it from all routes first.

Example

curlJavaScriptPython

bash

curl -X DELETE https://api.hookbase.app/api/transforms/tfm_abc123 \
  -H "Authorization: Bearer whr_your_api_key"

javascript

const response = await fetch('https://api.hookbase.app/api/transforms/tfm_abc123', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer whr_your_api_key'
  }
});

python

import requests

response = requests.delete(
  'https://api.hookbase.app/api/transforms/tfm_abc123',
  headers={'Authorization': 'Bearer whr_your_api_key'}
)

Response

204 No Content

Error Responses

400 Bad Request

Invalid transform code:

json

{
  "error": "Bad Request",
  "message": "Transform code validation failed: Unexpected token at position 15",
  "code": "INVALID_CODE"
}

404 Not Found

Transform not found:

json

{
  "error": "Not Found",
  "message": "Transform with ID tfm_xyz not found",
  "code": "RESOURCE_NOT_FOUND"
}

409 Conflict

Transform in use:

json

{
  "error": "Conflict",
  "message": "Transform is assigned to 3 active routes",
  "code": "RESOURCE_IN_USE"
}

Transforms Guide — Types, examples, and best practices
Routes API — Assign transforms to routes

Transforms API ​

Endpoints ​

Transform Object ​

Transform Types ​

Input/Output Formats ​

List Transforms ​

Query Parameters ​

Example ​

Response ​

Create Transform ​

Request Body ​

Example ​

Response ​

Get Transform ​

Example ​

Response ​

Update Transform ​

Request Body ​

Example ​

Response ​

Delete Transform ​

Example ​

Response ​

Error Responses ​

400 Bad Request ​

404 Not Found ​

409 Conflict ​

Related ​

Transforms API

Endpoints

Transform Object

Transform Types

Input/Output Formats

List Transforms

Query Parameters

Example

Response

Create Transform

Request Body

Example

Response

Get Transform

Example

Response

Update Transform

Request Body

Example

Response

Delete Transform

Example

Response

Error Responses

400 Bad Request

404 Not Found

409 Conflict

Related