Test Workflow

Run a workflow in test mode without publishing. Use this to validate the full graph execution against input parameters before promoting to production.

Checksum (required for a successful test)

The test endpoint requires the current checksum of the workflow. If the checksum you send does not match the latest checksum on the server, the API returns a checksum mismatch error and the test does not run.

Recommended flow:

1. Call Get workflow by id (GET /dev/v1/workflow/{entity-id}) for the workflow you want to test.

2. From the response, copy data.checksum (the exact string returned by the API).

3. Paste that value into your test request body as checksum, together with params (keys matching your trigger node's input field names) and optional version (e.g. "draft").

Test workflow

post

Run a workflow in test mode without publishing. Validates full graph execution against given input parameters.

checksum is required and must match the server's current checksum — if not, the test is rejected. Always get the latest checksum from GET /dev/v1/workflow/{entity-id} → data.checksum before testing.

params keys must match the field names defined in the trigger node's data.input map. For the example workflow: orderId (string), cartTotal (numeric), customerTier (string).

version defaults to draft if omitted.

Response data contains per-node execution output (nodeOutputs), overall workflow output, status, and executionTime.

Canonical response file: examples/test_workflow_200.json

Authorizations

DevAuth

Nected-API-KeystringRequired

Your Nected API key. Obtain from your workspace settings.

Path parameters

entity-idstringRequired

The workflow entity ID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Body

application/json

Request body for the test endpoint

checksumstringOptional

Current checksum from Get workflow by id — must match server state

versionstringOptional

Version to test (defaults to draft)

Example: draft

Responses

200

OK — test execution result with node outputs.

application/json

Standard API response wrapper

codestringOptional

dataanyOptional

Response payload — shape varies by endpoint

messagestringOptional

pageNointegerOptional

pageSizeintegerOptional

totalCountintegerOptional

totalPagesintegerOptional

400

Bad Request (e.g. checksum mismatch)

application/json

500

Internal Server Error

application/json

post

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

HTTPcURLJavaScriptPython

POST /dev/v1/workflow/{entity-id}/test HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
  "params": {
    "orderId": "ORD-20260101-9921",
    "cartTotal": 1250,
    "customerTier": "gold"
  },
  "version": "draft"
}

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "output": {
      "Calculate_Discount": {
        "discountPct": 15,
        "discountAmount": 187.5,
        "finalAmount": 1062.5
      }
    },
    "nodeOutputs": {
      "node_abc123codenode01": {
        "status": "success",
        "executionTime": "2ms",
        "output": {
          "discountPct": 15,
          "discountAmount": 187.5,
          "finalAmount": 1062.5
        }
      }
    },
    "status": "success",
    "executionTime": "5ms"
  },
  "code": "success",
  "message": "Success."
}

Request body

Example on POST /dev/v1/workflow/{entity-id}/test in openapi.yaml:

{
  "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
  "params": {
    "orderId": "ORD-20260101-9921",
    "cartTotal": 1250.00,
    "customerTier": "gold"
  },
  "version": "draft"
}

Replace "checksum" with the value from GET /dev/v1/workflow/{entity-id} → data.checksum.