Start a flow

POST

https://api.platform.openintegrationhub.com/flows/{id}/start

flows

Initiates the flow's integration process by publishing an appropriate event to the event bus. Requires the 'flows.control' permission.

Request

Path Params

string <string>

required

ID of flow to start, must be a valid MongoDB ID.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Returns the id and new status of the flow

Body

data

object

optional

string

optional

Example:

5c99ec7e5ed40d3e7512cffa

status

string

optional

Example:

starting

meta

object

optional

Example

{
    "data": {
        "id": "5c99ec7e5ed40d3e7512cffa",
        "status": "starting"
    },
    "meta": {}
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠409409

Modified at 2025-01-16 10:16:32

Bulk update a number of existing flows

Stop a flow