Create Transformation

Create Transformation — Pabbly Hook API | Pabbly

API Docs

vv1

Overview

The Pabbly Hook API lets you programmatically manage webhook connections, transformations, events, and folders. Build, modify, and route incoming webhook payloads to downstream services through code, and automate the connections you would otherwise wire up in the Pabbly Hook dashboard.

Example request

curl https://hook.pabbly.com/api/v1/folders \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Base URL

All endpoints are relative to the base URL below. Combine the base URL with the path on each endpoint to get the full request URL.

Base URL

https://hook.pabbly.com/api/v1

Requests and responses

The API accepts JSON request bodies and returns JSON responses. Send Content-Type: application/json on every request that has a body. Path parameters are interpolated into the URL; query parameters and body fields are documented per endpoint.

Success response

{
  "success": true,
  "data": { /* … */ }
}

Errors

When a request fails, the response status code reflects the error category and the body carries a human-readable message. Treat any non-2xx status as a failure.

Status	Meaning
200, 201	Success
400	Bad request — missing or malformed parameters
401	Unauthorized — missing or invalid API credentials
404	Not found — the resource does not exist
429	Too many requests
5xx	Server error — retry with backoff

Error response

{
  "success": false,
  "error": "A human-readable explanation"
}

Authentication

The Pabbly Hook API uses HTTP Basic Auth. Every request must include your API Key and Secret Key as the username and password.

Auth header

Authorization: Basic <base64({{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}})>

Getting your credentials

Sign in to your Pabbly account and navigate to Settings → API Settings → Generate the Keys. You will see (or be able to generate) an API Key and a matching Secret Key. Treat the Secret Key like a password.

Making authenticated requests

Send your API Key as the HTTP Basic username and your Secret Key as the password on every request. The examples on the right show how to call /folders with proper authentication.

cURL

curl https://hook.pabbly.com/api/v1/folders \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Node.js

const credentials = Buffer
  .from('{{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}')
  .toString('base64');

const response = await fetch(
  'https://hook.pabbly.com/api/v1/folders',
  { headers: { Authorization: `Basic ${credentials}` } }
);
const data = await response.json();

Python

import requests
from requests.auth import HTTPBasicAuth

response = requests.get(
    'https://hook.pabbly.com/api/v1/folders',
    auth=HTTPBasicAuth('{{YOUR_API_KEY}}', '{{YOUR_SECRET_KEY}}'),
)
data = response.json()

Keep your credentials secret

Your credentials grant full access to your account. Never embed them in browser-side code, commit them to version control, or share them in support tickets. If you suspect a credential has been exposed, rotate it from the dashboard (Settings → API Settings → Generate the Keys) and update any servers that use it.

Create Folder

POST/folders

Create a new folder to group related webhook connections in your Pabbly Hook workspace.

Body parameters

namestringoptional

e.g. sample

POST/folders

curl -X POST https://hook.pabbly.com/api/v1/folders \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample"
  }'

Get All Folders

GET/folders

Return every folder in the account along with its ID and name.

GET/folders

curl https://hook.pabbly.com/api/v1/folders \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Rename Folder Name

PUT/folders/rename/{{folderId}}

Change the display name of an existing folder identified by its ID.

Path parameters

folderIdstringrequired

Body parameters

namestringoptional

e.g. subfolder 5

PUT/folders/rename/{{folderId}}

curl -X PUT https://hook.pabbly.com/api/v1/folders/rename/{{folderId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "subfolder 5"
  }'

Move Connection From Folder

PUT/folders/move-connection

Move a connection out of its current folder and into a different one.

Body parameters

connectionIdsarrayoptional

e.g. ["conn_4d2890e85bc340b3be31406456a1a7a6"]

fromFolderIdstringoptional

e.g. 664ef7516cf2e1f425971214

toFolderIdstringoptional

e.g. 664edfc3b2be40a4309362be

PUT/folders/move-connection

curl -X PUT https://hook.pabbly.com/api/v1/folders/move-connection \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "connectionIds": [
      "conn_4d2890e85bc340b3be31406456a1a7a6"
    ],
    "fromFolderId": "664ef7516cf2e1f425971214",
    "toFolderId": "664edfc3b2be40a4309362be"
  }'

Delete Folder And Move Connections to Home Folder

DELETE/folders/{{folderId}}

Delete a folder and relocate every connection inside it to the root (home) folder.

Path parameters

folderIdstringrequired

DELETE/folders/{{folderId}}

curl -X DELETE https://hook.pabbly.com/api/v1/folders/{{folderId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Create Connection

POST/connections

Create a new webhook connection that accepts incoming HTTP requests and forwards them through your configured workflow.

Body parameters

namestringoptional

e.g. Create Custom Response for test 1

folder_idstringoptional

e.g. 67592783069f7717b89ba992

sourceobjectoptional

e.g. {"allowed_http_methods":["PUT","POST"],"custom_response":{"status":"active","content_type":"text/plain","content":{"name":"$request.query.name$","details":{"age":"$request.query.age$"}}}}

destinationobjectoptional

e.g. {"url":"https://webhook.site/60e71a16-e9fe-4bb0-b906-35f66277ddd1","rate_limit":4,"rate_limit_period":"minute","http_method":"POST"}

retryobjectoptional

e.g. {"status":"active","limit":5,"interval":1,"time_limit_period":"minute","strategy":"linear"}

delayobjectoptional

e.g. {"status":"inactive","interval":0}

trs_idstringoptional

e.g. trs_672cade8d3adcf3a0d314b1b

filterobjectoptional

e.g. {"status":"active","body":{"amount":{"$gt":100},"category":{"$eq":"electronics"}},"headers":{"content_type":"text/plain"},"query":{"param1":"value1","param2":"value2"},"path":"/webhook/"}

POST/connections

curl -X POST https://hook.pabbly.com/api/v1/connections \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Create Custom Response for test 1",
    "folder_id": "67592783069f7717b89ba992",
    "source": {
      "allowed_http_methods": [
        "PUT",
        "POST"
      ],
      "custom_response": {
        "status": "active",
        "content_type": "text/plain",
        "content": {
          "name": "$request.query.name$",
          "details": {
            "age": "$request.query.age$"
          }
        }
      }
    },
    "destination": {
      "url": "https://webhook.site/60e71a16-e9fe-4bb0-b906-35f66277ddd1",
      "rate_limit": 4,
      "rate_limit_period": "minute",
      "http_method": "POST"
    },
    "retry": {
      "status": "active",
      "limit": 5,
      "interval": 1,
      "time_limit_period": "minute",
      "strategy": "linear"
    },
    "delay": {
      "status": "inactive",
      "interval": 0
    },
    "trs_id": "trs_672cade8d3adcf3a0d314b1b",
    "filter": {
      "status": "active",
      "body": {
        "amount": {
          "$gt": 100
        },
        "category": {
          "$eq": "electronics"
        }
      },
      "headers": {
        "content_type": "text/plain"
      },
      "query": {
        "param1": "value1",
        "param2": "value2"
      },
      "path": "/webhook/"
    }
  }'

Update Connection

PATCH/connections/{{connectionId}}

Partially update a connection's attributes — name, settings, transformations — without replacing the full resource.

Path parameters

connectionIdstringrequired

Body parameters

namestringoptional

e.g. Sample

sourceobjectoptional

e.g. {"allowed_http_methods":["PUT","POST","GET"],"custom_response":{"status":"active","content_type":"text/plain","content":{"name":"$request.query.name$","details":{"age":"$request.query.age$"}}}}

destinationobjectoptional

e.g. {"url":"https://webhook.site/60e71a16-e9fe-4bb0-b906-35f66277ddd1","rate_limit":1,"rate_limit_period":"minute","http_method":"GET"}

retryobjectoptional

e.g. {"status":"active","limit":5,"interval":1,"time_limit_period":"minute","strategy":"linear"}

delayobjectoptional

e.g. {"status":"active","interval":1,"time_limit_period":"minute"}

trs_idstringoptional

e.g. trs_672cade8d3adcf3a0d314b1b

filterobjectoptional

e.g. {"status":"active","body":{"amount":{"$gt":100},"category":{"$eq":"electronics"}},"headers":{"content_type":"text/plain"},"query":{"param1":"value1","param2":"value2"},"path":"/webhook/"}

PATCH/connections/{{connectionId}}

curl -X PATCH https://hook.pabbly.com/api/v1/connections/{{connectionId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sample",
    "source": {
      "allowed_http_methods": [
        "PUT",
        "POST",
        "GET"
      ],
      "custom_response": {
        "status": "active",
        "content_type": "text/plain",
        "content": {
          "name": "$request.query.name$",
          "details": {
            "age": "$request.query.age$"
          }
        }
      }
    },
    "destination": {
      "url": "https://webhook.site/60e71a16-e9fe-4bb0-b906-35f66277ddd1",
      "rate_limit": 1,
      "rate_limit_period": "minute",
      "http_method": "GET"
    },
    "retry": {
      "status": "active",
      "limit": 5,
      "interval": 1,
      "time_limit_period": "minute",
      "strategy": "linear"
    },
    "delay": {
      "status": "active",
      "interval": 1,
      "time_limit_period": "minute"
    },
    "trs_id": "trs_672cade8d3adcf3a0d314b1b",
    "filter": {
      "status": "active",
      "body": {
        "amount": {
          "$gt": 100
        },
        "category": {
          "$eq": "electronics"
        }
      },
      "headers": {
        "content_type": "text/plain"
      },
      "query": {
        "param1": "value1",
        "param2": "value2"
      },
      "path": "/webhook/"
    }
  }'

Disable Connection

PUT/connections/disable

Stop a connection from accepting incoming webhook requests. Existing history is retained; new triggers are rejected until re-enabled.

Body parameters

connection_idsarrayoptional

e.g. ["conn_ee3a07ef5a574f58abc4a2d98a5c2d3b"]

PUT/connections/disable

curl -X PUT https://hook.pabbly.com/api/v1/connections/disable \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "connection_ids": [
      "conn_ee3a07ef5a574f58abc4a2d98a5c2d3b"
    ]
  }'

Enable Connection

PUT/connections/enable

Re-activate a previously disabled connection so it can receive webhook requests again.

Body parameters

connection_idsarrayoptional

e.g. ["conn_ee3a07ef5a574f58abc4a2d98a5c2d3b"]

PUT/connections/enable

curl -X PUT https://hook.pabbly.com/api/v1/connections/enable \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "connection_ids": [
      "conn_ee3a07ef5a574f58abc4a2d98a5c2d3b"
    ]
  }'

Delete Connection And Move To Trash

DELETE/connections/

Soft-delete a connection by moving it to trash. Can be restored within the retention window before permanent deletion.

Body parameters

connection_idsarrayoptional

e.g. ["conn_bdafbe30d2f04625822304af01e8216e"]

DELETE/connections/

curl -X DELETE https://hook.pabbly.com/api/v1/connections/ \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Filter Connection

GET/connections?filter={filter}&status={status}&folder_id={folder_id}&name={name}&page={page}&limit={limit}

List connections matching the specified filters (folder, status, name).

Query parameters

filterbooleanoptional

e.g. true

statusstringoptional

e.g. active

folder_idstringoptional

e.g. 67592783069f7717b89ba992

namestringoptional

e.g. Sample

pageintegeroptional

e.g. 1

limitintegeroptional

e.g. 10

GET/connections?filter={filter}&status={status}&folder_id={folder_id}&name={name}&page={page}&limit={limit}

curl https://hook.pabbly.com/api/v1/connections?filter={{filter}}&status={{status}}&folder_id={{folder_id}}&name={{name}}&page={{page}}&limit={{limit}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Get Single Connection By Connection_id

GET/connections/{{connectionId}}

Fetch the full details of one connection by its unique ID.

Path parameters

connectionIdstringrequired

GET/connections/{{connectionId}}

curl https://hook.pabbly.com/api/v1/connections/{{connectionId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

POST/transformations

Create a transformation rule that modifies incoming webhook payloads before they're forwarded to downstream services.

Body parameters

namestringoptional

e.g. fourth Transformation

codestringoptional

e.g. (request, context) => {let itemCounter = 0;request.payload.items = request.payload.items || [];request.payload.items.forEach(item => {if (item.status === 'active') {itemCounter++;item.updated_at = new Date().toISOString(); } else { item.status = 'inactive'; } });request.payload.summary = {activeItemCount: itemCounter, totalItems: request.payload.items.length};request.headers['X-Item-Count'] = itemCounter.toString(); request.queryParams.processedAt = new Date().toISOString();try { if (!request.payload.customerId) { throw new Error('customerId is missing'); } } catch (error) { console.error('Transformation error:', error.message); throw error;} return request;}

POST/transformations

curl -X POST https://hook.pabbly.com/api/v1/transformations \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "fourth Transformation",
    "code": "(request, context) => {let itemCounter = 0;request.payload.items = request.payload.items || [];request.payload.items.forEach(item => {if (item.status === 'active') {itemCounter++;item.updated_at = new Date().toISOString(); } else {  item.status = 'inactive'; } });request.payload.summary = {activeItemCount: itemCounter, totalItems: request.payload.items.length};request.headers['X-Item-Count'] = itemCounter.toString(); request.queryParams.processedAt = new Date().toISOString();try { if (!request.payload.customerId) {   throw new Error('customerId is missing');  } } catch (error) { console.error('Transformation error:', error.message);  throw error;} return request;}"
  }'

Get Single Transformation By Trs_id

GET/transformations/{{transformationId}}

Fetch the full configuration of one transformation by its unique transformation ID.

Path parameters

transformationIdstringrequired

GET/transformations/{{transformationId}}

curl https://hook.pabbly.com/api/v1/transformations/{{transformationId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Get All Transformation

GET/transformations/get-all/

List every transformation defined in the account.

GET/transformations/get-all/

curl https://hook.pabbly.com/api/v1/transformations/get-all/ \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Update Transformation By Trs_id

PUT/transformations/{{transformationId}}

Update an existing transformation's rules or output mapping.

Path parameters

transformationIdstringrequired

Body parameters

namestringoptional

e.g. five transformation

codestringoptional

PUT/transformations/{{transformationId}}

curl -X PUT https://hook.pabbly.com/api/v1/transformations/{{transformationId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}} \
  -H "Content-Type: application/json" \
  -d '{
    "name": "five transformation",
    "code": "(request, context) => {let itemCounter = 0;request.payload.items = request.payload.items || [];request.payload.items.forEach(item => {if (item.status === 'active') {itemCounter++;item.updated_at = new Date().toISOString(); } else {  item.status = 'inactive'; } });request.payload.summary = {activeItemCount: itemCounter, totalItems: request.payload.items.length};request.headers['X-Item-Count'] = itemCounter.toString(); request.queryParams.processedAt = new Date().toISOString();try { if (!request.payload.customerId) {   throw new Error('customerId is missing');  } } catch (error) { console.error('Transformation error:', error.message);  throw error;} return request;}"
  }'

Delete Transformation Based On Trs_id

DELETE/transformations/{{transformationId}}

Permanently delete a transformation. Connections using it fall back to passing payloads through unchanged.

Path parameters

transformationIdstringrequired

DELETE/transformations/{{transformationId}}

curl -X DELETE https://hook.pabbly.com/api/v1/transformations/{{transformationId}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Filter Request

GET

/requests?filter={filter}&connection_id={connection_id}&requestId={requestId}&status={status}&dateRange={dateRange}&page={page}&limit={limit}

List incoming webhook requests matching the specified filters (connection, date range, status).

Query parameters

filterbooleanoptional

e.g. true

connection_idstringoptional

e.g. conn_38657a4a43544e4fa9a911696d72a20e

requestIdstringoptional

e.g. req_e038786447e14a2e9282f69229d809a1

statusstringoptional

e.g. blocked

dateRangestringoptional

e.g. 2024-05-01,2024-06-31

pageintegeroptional

e.g. 220

limitintegeroptional

e.g. 1

GET

/requests?filter={filter}&connection_id={connection_id}&requestId={requestId}&status={status}&dateRange={dateRange}&page={page}&limit={limit}

curl https://hook.pabbly.com/api/v1/requests?filter={{filter}}&connection_id={{connection_id}}&requestId={{requestId}}&status={{status}}&dateRange={{dateRange}}&page={{page}}&limit={{limit}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Retrieve All Request

GET/requests?page={page}&limit={limit}

Return the full history of incoming webhook requests for the account.

Query parameters

pageintegeroptional

e.g. 1

limitintegeroptional

e.g. 100

GET/requests?page={page}&limit={limit}

curl https://hook.pabbly.com/api/v1/requests?page={{page}}&limit={{limit}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Filter Events

GET/events?filter={filter}&limit={limit}&requestId={requestId}&status={status}

List webhook delivery events matching the specified filters (connection, status, date range).

Query parameters

filterbooleanoptional

e.g. true

limitintegeroptional

e.g. 10

requestIdstringoptional

e.g. req_cd5a26f12b4549c59247742e12e9f7ab

statusstringoptional

e.g. SUCCESSFUL

GET/events?filter={filter}&limit={limit}&requestId={requestId}&status={status}

curl https://hook.pabbly.com/api/v1/events?filter={{filter}}&limit={{limit}}&requestId={{requestId}}&status={{status}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}

Retrieve All Events

GET/events?page={page}&limit={limit}

Return the full event log of webhook deliveries for the account.

Query parameters

pageintegeroptional

e.g. 1

limitintegeroptional

e.g. 100

GET/events?page={page}&limit={limit}

curl https://hook.pabbly.com/api/v1/events?page={{page}}&limit={{limit}} \
  -u {{YOUR_API_KEY}}:{{YOUR_SECRET_KEY}}