latestOpenAPI 3.1.02026-08-2284340459.3 KB

cd4c91e0e6c2

Data Flows
MCP

Add Data Flow

Authorization scope: data flow:write

This endpoint creates a data flow.


📖 Instructions for usage

create_data_flow

Create a new source-to-target data flow.

Parameters
----------
name : Display name for the data flow.
source_name : Connector type for the source, as shown by list_connections —
    e.g. mysql, postgresql, snowflake, salesforce, hubspot, facebook ads, tiktok.
    Not an exhaustive list: new connectors are added regularly, so pass the type
    of your connection even if it is not listed here. (blueprint / blueprint_custom
    flows are created in the console, not here.)
source_connection_id : cross_id of the source connection (from list_connections).
target_name : Connector type for the target (same convention as source_name).
target_connection_id : cross_id of the target connection.
loading_method : How data is loaded into the target. Common values:
    append, merge, replace. Defaults to "append".
target_settings : Optional dict with target-specific fields, e.g.:
    {"database_name": "MY_DB", "schema_name": "PUBLIC", "table_name": "my_table"}
    Required fields vary by target connector type.

Note: blueprint / blueprint_custom (recipe) sources are NOT supported here — create
those flows in the Boomi Data Integration console.

To see a real example of this object, list your data flows and GET a similar one — use its definition as a reference.

📚 Per-source request/response examples: https://bitbucket.org/boomii/data-integration-sources-examples/src/main/

post/v1/accounts/{account_id}/environments/{environment_id}/rivers

Path parameters

account_idstring required
environment_idstring required

Query parameters

river_cross_idstring nullable

Request body

namestring required

The name of the river.

kind'sub_river' | 'main_river'

River kind

type'source_to_target' | 'actions' | 'logic' | 'connector_executor' required

All of the EXTERNAL river types

group_idstring nullable

The id of the group the river belongs to.

group_namestring nullable

The name of the group the river belongs to.

cross_idstring nullable

The cross_id of the river to be deployed.

deployment_definitionobject nullable

The deployment definition of the river to be deployed.

account_idstring nullable

The account id.

environment_idstring nullable

The environment id.

environment_namestring nullable

The name of the environment.

Response

Successful Response

cross_idstring required

The river cross id.

account_idstring required

The account id.

kind'sub_river' | 'main_river'

River kind

type'source_to_target' | 'actions' | 'logic' | 'connector_executor' required

All of the EXTERNAL river types

namestring required

The name of the river.

environment_idstring required

The environment cross id.

environment_namestring required

The environment name.

group_idstring required

The group id.

group_namestring required

The group name.