# Webhook Payload Mapper (`superfreshlabs/webhook-payload-mapper`) Actor

Transform supplied JSON payloads using explicit JSON-pointer mappings. Preview nested destination objects, flag missing sources and reject conflicting targets. No expressions, outgoing webhooks or code execution.

- **URL**: https://apify.com/superfreshlabs/webhook-payload-mapper.md
- **Developed by:** [Chris Norman](https://apify.com/superfreshlabs) (community)
- **Categories:** Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$250.00 / 1,000 completed webhook payload mapper reports

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Webhook Payload Mapper

Transform supplied JSON payloads using explicit JSON-pointer mappings. Preview nested destination objects, flag missing sources and reject conflicting targets. No expressions, outgoing webhooks or code execution.

### What this helps with

Developers connecting incompatible tools can reuse an exact saved mapping without running arbitrary transformation code.

### Input example

Fictional sample only. Supply authorized nonsensitive or redacted data. Your input and output are stored in Apify under its storage and access rules.

```json
{
  "jsonText": "[{\"customer\":{\"email\":\"fictional@example.com\"},\"order\":{\"id\":\"demo-100\"}},{\"customer\":{},\"order\":{\"id\":\"demo-101\"}}]",
  "mappings": [
    {
      "source": "/customer/email",
      "target": "/contact/email"
    },
    {
      "source": "/order/id",
      "target": "/external_id"
    }
  ]
}
```

### Output example

The default dataset contains an array with one report object:

```json
{
  "schemaVersion": "1.0",
  "tool": "webhook-payload-mapper",
  "inputSha256": "113a8bb1aee7891ac6f14d6fdf4258de9ecd28f332f3955f8a521e15902bf137",
  "summary": {
    "payloads": 2,
    "mappedPayloads": 1,
    "reviewPayloads": 1
  },
  "results": [
    {
      "index": 0,
      "status": "mapped",
      "issues": [],
      "mapped": {
        "contact": {
          "email": "fictional@example.com"
        },
        "external_id": "demo-100"
      }
    },
    {
      "index": 1,
      "status": "needs_review",
      "issues": [
        {
          "reason": "missing_source",
          "sourcePointer": "/customer/email"
        }
      ],
      "mapped": null
    }
  ],
  "boundaries": "Mapping preview only. Source JSON pointers support object keys and existing array indices. Target pointers create object keys, never arrays. No arbitrary expressions, type coercion, outbound requests, destination acceptance or signature verification. JSON numbers use Python float semantics for fractional/exponent values; represent exact financial/identifier values as strings."
}
```

### Scope and limits

Mapping preview only. Source JSON pointers support object keys and existing array indices. Target pointers create object keys, never arrays. No arbitrary expressions, type coercion, outbound requests, destination acceptance or signature verification. JSON numbers use Python float semantics for fractional/exponent values; represent exact financial/identifier values as strings.

Strict JSON array of1to1000 payloads; at most1MB. Exact decimal/identifier values should be strings.

1to50 objects: source JSON pointer,target JSON pointer,onMissing(error or omit). Targets create object keys, not arrays. Overlapping target pointers are rejected.

### Pricing and delivery

Initial trial price USD0.25 per completed report, including any record-level review findings; no charge per source row. The current Store pricing is authoritative. Configure a maximum spending budget before running. One paid event named `report`; no paid startup/default-dataset events and no usage passthrough. Invalid batch input fails before our custom charge.

Storage and billing are not transactional. Delivery/billing errors are marked uncertain where possible; the same run is never automatically fulfilled again. Inspect output and charge status before manually starting a new purchase. A successful diagnostic report may flag invalid records and does not guarantee destination acceptance.

### Agent use

Inspect the input schema, scope and current price, run with a bounded budget, wait for successful completion, then read the one report from the default dataset. Act on review findings before using mapped or converted data downstream. This tool does not call external APIs or execute supplied code.

Built by SuperFresh Labs. No customer results or earnings claimed. Demand and contribution remain unvalidated.

# Actor input Schema

## `jsonText` (type: `string`):

Strict JSON array of1to1000 payloads; at most1MB. Exact decimal/identifier values should be strings.

## `mappings` (type: `array`):

1to50 objects: source JSON pointer,target JSON pointer,onMissing(error or omit). Targets create object keys, not arrays. Overlapping target pointers are rejected.

## Actor input object example

```json
{
  "jsonText": "[{\"customer\":{\"email\":\"fictional@example.com\"},\"order\":{\"id\":\"demo-100\"}},{\"customer\":{},\"order\":{\"id\":\"demo-101\"}}]",
  "mappings": [
    {
      "source": "/customer/email",
      "target": "/contact/email"
    },
    {
      "source": "/order/id",
      "target": "/external_id"
    }
  ]
}
```

# Actor output Schema

## `report` (type: `string`):

One report item including summary, results and review findings. Read the documented scope before downstream use.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "jsonText": "[{\"customer\":{\"email\":\"fictional@example.com\"},\"order\":{\"id\":\"demo-100\"}},{\"customer\":{},\"order\":{\"id\":\"demo-101\"}}]",
    "mappings": [
        {
            "source": "/customer/email",
            "target": "/contact/email"
        },
        {
            "source": "/order/id",
            "target": "/external_id"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("superfreshlabs/webhook-payload-mapper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "jsonText": "[{\"customer\":{\"email\":\"fictional@example.com\"},\"order\":{\"id\":\"demo-100\"}},{\"customer\":{},\"order\":{\"id\":\"demo-101\"}}]",
    "mappings": [
        {
            "source": "/customer/email",
            "target": "/contact/email",
        },
        {
            "source": "/order/id",
            "target": "/external_id",
        },
    ],
}

# Run the Actor and wait for it to finish
run = client.actor("superfreshlabs/webhook-payload-mapper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "jsonText": "[{\\"customer\\":{\\"email\\":\\"fictional@example.com\\"},\\"order\\":{\\"id\\":\\"demo-100\\"}},{\\"customer\\":{},\\"order\\":{\\"id\\":\\"demo-101\\"}}]",
  "mappings": [
    {
      "source": "/customer/email",
      "target": "/contact/email"
    },
    {
      "source": "/order/id",
      "target": "/external_id"
    }
  ]
}' |
apify call superfreshlabs/webhook-payload-mapper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,superfreshlabs/webhook-payload-mapper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/3r2Sw82oYz0P219Ih/builds/bra8MRSqJCk6k7evt/openapi.json