For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workflow

The Workflow API lets you list, create, read, update, test, and publish workflows in your workspace via the DevAPI v1. All paths use the entity type workflow.

Workflow types: Unlike rules, workflows have a single structure — a directed graph of nodes connected by edges. The request payload for create and update is the full graph; the response format is the same (create returns data.id and data.checksum; update returns data.checksum).

Create vs get: The JSON body you send to create a workflow matches the data object returned by get workflow by id, except create does not include id, checksum, version, status, staticUrl, versionInfo, or timestamps. Use the full payloads in openapi.yaml (Examples dropdown) and Create/create_workflow.json — not a minimal { name } stub.

List vs get: GET /dev/v1/workflow returns summary rows plus paginationInfo (see Get/GET_ALL.json), not the full workflow graph.

Scheduling is not supported for workflows. Only rules support scheduling.

Base URL

All endpoints are prefixed with /dev/v1/workflow.

Authentication

Header
Type
Required
Description

Nected-API-Key

string

Yes

Your Nected API key.

Nected-Branch

string

No

Branch name (optional).


Endpoints

Method
Path
Description

GET

/dev/v1/workflow

List workflows (Get all)

POST

/dev/v1/workflow

Create workflow

GET

/dev/v1/workflow/{entity-id}

Get workflow by id

PATCH

/dev/v1/workflow/{entity-id}

Update workflow

POST

/dev/v1/workflow/{entity-id}/test

Test workflow

POST

/dev/v1/workflow/{entity-id}/publish

Publish workflow

GET

/dev/v1/workflow/{entity-id}/version

List published versions

Last updated