CHchift
Syncs

Run a flow now

Changed on

Starts the flow immediately. Pass several consumers to run it as configured for each of them, or exactly one consumer together with settings — settings apply to a single consumer's run. GET /syncs/{syncid}/flows/{flowid}/settings lists the settings this flow accepts. The response echoes the settings that were applied and anything worth knowing about the run.

Send preflight: true to get that answer without starting anything: the same request is checked the same way, and a refusal comes back as a blocking warning instead of an error.

post/syncs/{syncid}/flows/{flowid}/execute

Request

Path parameters

syncidstring required
flowidstring required

Request body

preflightboolean

Check the request without starting anything. Everything that decides whether the run may start is evaluated, and a refusal comes back as a blocking warning rather than an error, so you can warn someone before they confirm.

Response

Successful Response

chainexecutionidstring nullable

Unset for a preflight: nothing was started.

preview_executionidstring nullable
blockedboolean

Only a preflight reports this: the same request sent for real would be refused.

Changes