Execute a Workflow

Use this endpoint to start a new workflow execution. The request does not wait for the workflow to finish. Use the Idempotency-Key header to ensure safe retries. An Idempotency-Key is unique across workflows: a key already used to execute a different workflow answers 409 FLK-0511 and returns nothing of that execution; send a new Idempotency-Key for each distinct execution. A repeated key replays the first execution while it exists: an execution with a write step is kept without a time limit; a read-only one may be deleted after the retention window, after which the same key starts a new execution (see /v1/settings/execution-retention). A workflow with several triggers starts at the one triggerNodeId names. A workflow with an allowedCallers list answers 403 FLK-0519 to a caller outside it requesting a new execution, and no execution is created. When the run reaches a wait node, the execution turns waiting and resumes at the deadline or shortly after; it fails instead when the deadline or the resume falls more than 16 hours after the start.

POST /v1/workflows/{workflowId}/executions

Execute a Workflow

cURL

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/workflows/{workflowId}/executions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "inputData": {
    "transactionId": "txn-98765",
    "amount": 1500,
    "currency": "BRL",
    "customerId": "cust-12345",
    "message": "Payment received"
  },
  "triggerNodeId": "trigger-1"
}
'

200

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "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>.

Encabezados

Idempotency-Key · string · requerido

Unique idempotency key to ensure safe retries of the same request. A repeated key replays the first execution while it exists: an execution with a write step is kept without a time limit; a read-only one may be deleted after the retention window, after which the same key starts a new execution (see /v1/settings/execution-retention).

Parámetros de ruta

workflowId · string<uuid> · requerido

Unique identifier of the workflow.

Cuerpo

application/json

Request body containing the execution input data.

inputData · object · requerido

Input data passed to the workflow. Available to all nodes during execution. Maximum payload size is 1 MB.

Show child attributes

Ejemplo:

{
  "transactionId": "txn-98765",
  "amount": 1500,
  "currency": "BRL",
  "customerId": "cust-12345",
  "message": "Payment received"
}

triggerNodeId · string

Trigger node the execution starts at. Required when the workflow has several triggers; without it, or with a node that is not one of its triggers, the call answers 422 FLK-0515.

Ejemplo:

"trigger-1"

Respuesta

200

application/json

Indicates that an identical request was already processed. Returns the original execution.

executionId · string<uuid>

Unique identifier of the execution.

Ejemplo:

"f7e6d5c4-b3a2-1098-7654-321fedcba098"

startedAt · string<date-time>

Timestamp when the execution started.

Ejemplo:

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

status · string

Status of the execution.

Ejemplo:

"running"

workflowId · string<uuid>

ID of the workflow being executed.

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"