OPopenintegrationhub
flows

Start a flow

Changed on

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

post/flows/{id}/start

Request

Path parameters

idstring string required

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

Response

Returns the id and new status of the flow

metaobject

Example response

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

Changes

  • eafe7d98cdb8Revision changes
    • info

      added the non-success response with the status

  • a65fada07ca8Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status