Sign in

v24

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2023-10-2712636.3 KB
flows

Add a new flow to the repository

This requires the 'flows.write' permissions. The new Flow will automatically be associated with the current user in the owners array, allowing editing and viewing by this user irrespective of tenancies. Supports bulk creation by passing an array of flow objects in the body.

post/flows

Request body

namestring required
descriptionstring
tenantstring
type'ordinary' | 'realtime' required

Flow type

cronstring

A cron string describing the interval at which this flow is run. If unset, the flow uses webhooks instead

Example request

{
  "name": "SnazzyToCodeComponent",
  "description": "This flow polls for persons and posts them on webhoo.site.",
  "graph": {
    "edges": [
      {
        "source": "step_1",
        "target": "step_2"
      }
    ]
  },
  "type": "ordinary",
  "cron": "* /2 * * * *"
}

Response

The created Flow.

metaobject

Example response

{
  "data": {
    "name": "SnazzyToCodeComponent",
    "description": "This flow polls for persons and posts them on webhoo.site.",
    "graph": {
      "edges": [
        {
          "source": "step_1",
          "target": "step_2"
        }
      ]
    },
    "type": "ordinary",
    "cron": "* /2 * * * *",
    "status": "inactive",
    "createdAt": "2019-07-30T12:52:45.957Z",
    "updatedAt": "2019-07-30T12:52:45.957Z"
  }
}