Flows

Create a flow

POST/v1/flows

Connects a source to a destination. A source can deliver to a destination through only one flow.

Parameters

Body parameters9

source_idstringRequired

The source (src_…).

destination_idstringRequired

The destination (dst_…).

name?string

Defaults to source → destination.

filter?object

Conditions an event must match to be delivered.

transform_id?string

A transform (trf_…) applied before delivery.

delay_seconds?integer

Wait before the first delivery.

compaction?object | string

Rules, or a preset name, for merging updates about the same thing.

ordering?object

Per-key ordering and concurrency.

region?string

Where the flow's data is stored and delivered from.

Returns

201The sample response is on the right.Errors return error and message; see Errors and limits.

curl -X POST "https://api.getensue.com/v1/flows" \ -H "authorization: Bearer $ENSUE_API_KEY" \ -H "content-type: application/json" \ -d '{"source_id":"src_…","destination_id":"dst_…","filter":null,"transform_id":"trf_…"}'

const res = await fetch("https://api.getensue.com/v1/flows", { method: "POST", headers: { authorization: `Bearer ${process.env.ENSUE_API_KEY}`, "content-type": "application/json", }, body: JSON.stringify({ "source_id": "src_…", "destination_id": "dst_…", "filter": null, "transform_id": "trf_…" }), }); console.log(await res.json());

import os, requests res = requests.post( "https://api.getensue.com/v1/flows", headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"}, json={ "source_id": "src_…", "destination_id": "dst_…", "filter": None, "transform_id": "trf_…" }, ) print(res.json())