Documentation Index
Fetch the complete documentation index at: https://docs.dualship.run/llms.txt
Use this file to discover all available pages before exploring further.
A flow is a JSON document with three main sections: metadata, trigger, and nodes.
Basic Structure
{
"id": "uuid",
"name": "Flow Name",
"slug": "flow-name",
"trigger": {
"type": "http",
"config": { ... }
},
"nodes": [
{ "id": "node1", "type": "...", "config": { ... } },
{ "id": "node2", "type": "...", "config": { ... } }
]
}
Trigger Types
Triggers define how a flow is invoked.
HTTP Trigger
The most common trigger type. Creates a REST endpoint.
{
"trigger": {
"type": "http",
"config": {
"method": "POST",
"path": "/payments"
}
}
}
| Field | Type | Required | Description |
|---|
method | string | Yes | HTTP method: GET, POST, PUT, DELETE, PATCH |
path | string | Yes | URL path for the endpoint |
Cron Trigger
Schedule flows to run at specific times.
{
"trigger": {
"type": "cron",
"config": {
"schedule": "0 9 * * *",
"timezone": "America/New_York"
}
}
}
| Field | Type | Required | Description |
|---|
schedule | string | Yes | Cron expression |
timezone | string | No | IANA timezone (default: UTC) |
Queue Trigger
Process messages asynchronously with automatic retries.
{
"trigger": {
"type": "queue",
"config": {
"name": "order-processing",
"parallelism": 1,
"retries": 5,
"timeout": "30s",
"backoff": {
"strategy": "exponential",
"initial": "1s",
"max": "1h"
}
}
}
}
| Field | Type | Required | Description |
|---|
name | string | Yes | Queue name (unique per project) |
parallelism | number | No | Concurrent consumers (1 = strict FIFO) |
retries | number | No | Max retry attempts (0 = no retries) |
timeout | string | No | Handler execution timeout |
backoff | object | No | Retry backoff strategy |
Node Structure
Every node has the same base structure:
{
"id": "unique_node_id",
"type": "node_type",
"config": { }
}
| Field | Type | Required | Description |
|---|
id | string | Yes | Unique identifier within the flow |
type | string | Yes | One of the 12 node types |
config | object | Yes | Type-specific configuration |
Execution Order
By default, nodes execute sequentially in the order they appear in the nodes array.
Node 1 -> Node 2 -> Node 3 -> Response
Branching
Control flow nodes (condition, switch) can branch execution:
Node 1 -> Condition
|
+---------+---------+
| |
(then) (else)
| |
Node 2 Node 3
| |
+---------+---------+
|
Node 4
then and else arrays.
Parallel Execution
The parallel node runs multiple branches concurrently:
Node 1 -> Parallel
|
+---------+---------+
| | |
Branch 1 Branch 2 Branch 3
| | |
+---------+---------+
|
Node 5
Context
Every flow execution has a context - a data store that nodes read from and write to.
Initial Context
When a flow starts, context is seeded with trigger data:
{
"request": {
"method": "POST",
"path": "/payments",
"headers": { "Authorization": "Bearer xxx" },
"query": { "debug": "true" },
"body": { "amount": 1000 }
},
"env": {
"environment": "production"
}
}
Node Outputs
After each node executes, its output is written to context:
Node "fetch_user" runs -> context["fetch_user.output"] = { ... }
Node "transform" runs -> context["transform.output"] = { ... }
{{fetch_user.output.body.name}}
{{transform.output.total}}
Flow States
Flows have a status that controls execution:
| Status | Description |
|---|
draft | In development, not executable |
published | Live and accepting requests |
disabled | Temporarily stopped |
archived | Soft deleted |
Versioning
Flows maintain version history for rollback:
current_version - Latest saved versionpublished_version - Currently deployed version
You can deploy specific versions to different environments (production, staging).
Next Steps
