Skip to main content
POST
Create a Workflow

Authorizations

X-API-Key
string
header
required

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

Body

application/json

Request body containing the workflow definition.

name
string
required

Unique name for the workflow.

Required string length: 1 - 100
Example:

"Payment Notification Flow"

description
string

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

Maximum string length: 500
Example:

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

edges
object[]

Connections between nodes that define the execution flow. Each edge links a source node to a target node, optionally with a condition.

Maximum array length: 200
metadata
object

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

Example:
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

Response

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

createdAt
string<date-time>

Timestamp when the workflow was created.

Example:

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

status
string

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

Example:

"draft"

version
string

Version of the workflow definition.

Example:

"1.0.0"

workflowId
string<uuid>

Unique identifier of the created workflow.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"