Pular para o conteúdo principal
POST
/
v1
/
workflows
Criar um workflow
curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/workflows \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Payment Notification Flow",
  "description": "Receives a webhook trigger and logs the payment event.",
  "nodes": [
    {
      "id": "trigger-1",
      "type": "trigger",
      "name": "Webhook Trigger",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "triggerId": "webhook"
      }
    },
    {
      "id": "log-event",
      "type": "action",
      "name": "Log Payment Event",
      "position": {
        "x": 200,
        "y": 0
      },
      "data": {
        "action": "log"
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "trigger-1",
      "target": "log-event"
    }
  ],
  "metadata": {
    "team": "payments",
    "environment": "sandbox"
  }
}
'
{
  "createdAt": "2026-03-17T14:30:00Z",
  "status": "draft",
  "version": "1.0.0",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Autorizações

​
X-API-Key
string
header
obrigatório

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Corpo

application/json

Corpo da solicitação contendo a definição do workflow.

​
name
string
obrigatório

Nome único para o workflow.

Required string length: 1 - 100
Exemplo:

"Payment Notification Flow"

​
description
string

Descrição opcional legível por humanos do propósito do workflow.

Maximum string length: 500
Exemplo:

"Receives a webhook trigger and logs the payment event."

​
edges
object[]

Conexões entre nós que definem o fluxo de execução. Cada aresta vincula um nó de origem a um nó de destino, opcionalmente com uma condição.

Maximum array length: 200
​
metadata
object

Pares chave-valor personalizados para etiquetar ou categorizar o workflow.

Exemplo:
{
  "team": "payments",
  "environment": "sandbox"
}
​
nodes
object[]

Os passos que compõem este workflow. Cada nó é uma unidade de trabalho: um gatilho, uma chamada de executor, uma ramificação condicional ou uma ação.

Maximum array length: 100

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

​
createdAt
string<date-time>

Marca temporal de quando o workflow foi criado.

Exemplo:

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

​
status
string

Status inicial do workflow (sempre draft na criação).

Exemplo:

"draft"

​
version
string

Versão da definição do workflow.

Exemplo:

"1.0.0"

​
workflowId
string<uuid>

Identificador único do workflow criado.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"