Skip to main content

Create Workflow Evaluation

POST 

/api/automation/workflows/:workflow/evaluations

Creates a new evaluation for the workflow. Returns the created evaluation with HTTP 201 (unwrapped — the resource fields are at the response root).

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields:

  • name (string, required, max 255)
  • description (string, nullable)
  • test_data (array, required, min 1 item) — each entry is an object representing one test case's trigger/input payload
  • test_data.* (array/object, required)
  • assertions (array, nullable) — optional assertions evaluated against each test case's output

Route name: automation.evaluations.store

Request​

Responses​

Created

Response Headers
    Content-Type