Create a Workflow

Use this endpoint to create a new workflow definition. New workflows are created in draft status. allowedCallers lists who may run the workflow; only a person writes it (an application gets 403 FLK-0365). Only a person writes a protected provider configuration, or a workflow that uses a protected or deleted one: an application gets 403 FLK-0365. Create and update accept only protected provider configurations on it (422 FLK-0367), and activation needs a non-empty allowedCallers list (422 FLK-0366). Every edge that leaves a node runs; of a conditional, every edge on the one output it chooses. A node that two parallel branches of one run reach answers 422 FLK-0187. Branches from different outputs of a conditional may rejoin. A wait node pauses the execution for data.durationSeconds, for example {"id": "wait-1", "type": "wait", "data": {"durationSeconds": 120}}. While paused, the execution status is waiting. When it resumes, later nodes read the output {deadline, firedAt} under the node ID, for example wait-1.firedAt. Rules checked at save, each answering 422: durationSeconds is an integer from 1 to 43200 (FLK-0183); no wait below a fan-out (FLK-0184); waits along one path add up to at most 43200 seconds (FLK-0185); a workflow with a wait has no loop (FLK-0186).

POST /v1/workflows

Create a Workflow

cURL

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Payment Notification Flow",
  "description": "Receives a webhook trigger and sets the payment output.",
  "nodes": [
    {
      "id": "trigger-1",
      "type": "trigger",
      "name": "Webhook Trigger",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "triggerType": "webhook",
        "path": "payments/received",
        "method": "POST",
        "input_contract": "open",
        "format": "json"
      }
    },
    {
      "id": "set-output",
      "type": "action",
      "name": "Set Payment Output",
      "position": {
        "x": 200,
        "y": 0
      },
      "data": {
        "actionType": "set_output",
        "output": {
          "status": "received"
        }
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "trigger-1",
      "target": "set-output"
    }
  ],
  "metadata": {
    "team": "payments",
    "environment": "sandbox"
  }
}
'

201

{
  "createdAt": "2026-03-17T14:30:00Z",
  "status": "draft",
  "version": "1.0.0",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider. Send it in the Authorization header as Bearer <token>.

Cuerpo

application/json

Request body containing the workflow definition.

name · string · requerido

Unique name for the workflow.

Required string length: 1 - 100

Ejemplo:

"Payment Notification Flow"

description · string

Optional human-readable description of the workflow's purpose.

Maximum string length: 500

Ejemplo:

"Receives a webhook trigger and sets the payment output."

edges · object[]

Connections between nodes that define the execution flow. Each edge links a source node to a target node. Branching is routed by the edge's sourceHandle, which must match the outcome handle its conditional source node produces.

Maximum array length: 200

Show child attributes

metadata · object

Custom key-value pairs for tagging or categorizing the workflow.

Show child attributes

Ejemplo:

{
  "team": "payments",
  "environment": "sandbox"
}

nodes · object[]

The steps that make up this workflow. Each node is a unit of work — a trigger, an executor call, a conditional branch, or an action.

Maximum array length: 100

Show child attributes

allowedCallers · object[]

Who may run the workflow: applications by client ID and people by user ID. An empty list lets any caller that the route authorizes run it. Only a person writes this list. A caller outside the list gets 403 FLK-0519 when requesting a new execution, and no execution is created. A schedule or Streaming Hub trigger carries no caller, so it never runs a workflow that has a list.

Show child attributes

Respuesta

201

application/json

Indicates that the resource was successfully created and the operation was completed as expected.

createdAt · string<date-time>

Timestamp when the workflow was created.

Ejemplo:

"2026-03-17T14:30:00Z"

status · string

Initial status of the workflow (always draft on creation).

Ejemplo:

"draft"

version · string

Version of the workflow definition.

Ejemplo:

"1.0.0"

workflowId · string<uuid>

Unique identifier of the created workflow.

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"