POST pipeline output to a REST endpoint

Use this destination when the system you need to feed has no native connector but does have an HTTP API. The REST endpoint destination POSTs data to an HTTP endpoint. It supports synchronous and asynchronous modes, bearer token authentication, and configurable timeouts.

Request

The pipeline sends an HTTP POST request with the following JSON payload:

{
  "pipelineToken": "abc-123",
  "pipelineName": "orders",
  "data": {
    "size": 100,
    "header": ["order_id", "amount", "region"],
    "rows": [
      ["1001", "59.99", "us-east"],
      ["1002", "24.50", "eu-west"]
    ],
    "rawData": null
  }
}

Payload Field	Description
`pipelineToken`	Token identifying the pipeline run
`pipelineName`	Name of the pipeline being sent
`data.size`	Number of rows in this batch
`data.header`	Array of column names
`data.rows`	Array of row arrays, each matching the header order
`data.rawData`	Raw string content when sending JSON or XML data instead of rows

Expected Response

The endpoint must return a JSON response with the following structure:

{
  "data": {
    "size": 100,
    "header": ["order_id", "status"],
    "rows": [
      ["1001", "accepted"],
      ["1002", "accepted"]
    ],
    "rawData": null
  }
}

The response data is forwarded to downstream steps in the pipeline.

Batching

By default (batchSize = 0) the pipeline makes exactly one call carrying every row. Set batchSize to a positive number to send row-based (CSV) payloads in batches of that many rows, one call per batch, in source order. Each batched request carries the same envelope plus two extra top-level fields:

{
  "pipelineToken": "abc-123",
  "pipelineName": "orders",
  "batch": 1,
  "ofBatches": 3,
  "data": {
    "size": 6983,
    "header": ["order_id", "amount", "region"],
    "rows": ["1001,59.99,us-east", "1002,24.50,eu-west"]
  }
}

Field	Description
`batch`	1-based index of this batch
`ofBatches`	Total number of batches in the run (`ceil(rows / batchSize)`)

Batched requests are only checked for an {"error": ...} response; the response data is not forwarded anywhere. JSON and XML payloads (rawData) are always sent in a single call regardless of batchSize. With async set, each batch waits for its own callback before the next batch is sent.

Sync and Async Modes

Set async to control whether the pipeline waits for a response:

`async`	Behavior
`false`	The pipeline waits for the endpoint to return a response before proceeding (default).
`true`	The pipeline sends the request, then waits for the endpoint to call back `POST /api/v1/restendpoint/callback` with the same `pipelineToken` and the result payload. If no callback arrives within `timeoutMs`, the job fails.

Authentication

Set bearerToken to include an Authorization: Bearer {token} header on every request. If omitted, requests are sent without authentication.

Timeout

The timeoutMs field controls the maximum time in milliseconds the pipeline will wait — for the HTTP response when async is false, or for the callback when async is true. The default is 300000 ms (5 minutes).

Configuration Example

{
  "name": "orders_rest",
  "source": { "..." : "..." },
  "destination": {
    "restEndpoint": {
      "endpoint": "https://api.example.com/ingest",
      "async": false,
      "bearerToken": "eyJhbGciOiJIUzI1NiIs...",
      "timeoutMs": 300000,
      "batchSize": 0
    }
  }
}

Field Reference

Field	Required	Default	Description
`endpoint`	yes		Target endpoint URL
`async`	no	`false`	If `true`, send the request and wait for a callback to `/api/v1/restendpoint/callback` instead of the HTTP response
`bearerToken`	no		Bearer token added as `Authorization: Bearer` header
`apiKey`	no		API key sent as an `x-api-key` header
`timeoutMs`	no	`300000`	Response (sync) or callback (async) timeout in milliseconds
`batchSize`	no	`0`	Rows per call for row-based payloads. `0` = one call with every row (the default behaviour); `> 0` adds `batch` / `ofBatches` to each request

Completion Notification

A pipeline notification is published to ActiveMQ on completion. See Notifications for details.

Getting Started

Connect your agent

Assistant

Catalog

Taps

Ingestion

Destinations

Data Quality

Transformation

AI Features

Configuration

Governance & Security

Production

Integrations

Recipes

Examples

POST pipeline output to a REST endpoint

Request

Expected Response

Batching

Sync and Async Modes

Authentication

Timeout

Configuration Example

Field Reference

Completion Notification

​Request

​Expected Response

​Batching

​Sync and Async Modes

​Authentication

​Timeout

​Configuration Example

​Field Reference

​Completion Notification

Request

Expected Response

Batching

Sync and Async Modes

Authentication

Timeout

Configuration Example

Field Reference

Completion Notification