workflow:preview-step

workflow family

Resolve one step's receiver + args through the real substitution code, with an optional mock trigger/step payload standing in for run history — never dispatches, reads no run history

Effect: ask; Awaits an outcome — the call returns the response below.
Caller: view_workflows; The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost: free; What one call costs, so you can budget before acting.
Reversible: no; This cannot be undone. Dry-run it first where the contract allows.
Idempotent: yes; Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code

Codex

Cursor

Gemini CLI

Claude Desktop

ChatGPT

curl -X POST https://one.ie/api/ask/workflow:preview-step \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "workflowId": "wf_abc", "stepId": "step_1", "mockTrigger": { "email": "a@b.com" } }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

workflowId string required
stepId string required
mockTrigger object optional
mockSteps object optional

Response

What comes back from the call.

receiver string | null
data object
error string

Traffic

Every call to workflow:preview-step, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names workflow:preview-step, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 1

one.ie/web/src/lib/bind-receiver.ts:140

Workflow 1

one.ie/web/src/components/workflows/StepDetailPanel.tsx:233

Docs 1

one.ie/web/src/content/blog/the-workflow-engine-was-teaching-itself-the-wrong-lessons.md:33

→

Answered by

workflow:preview-step one.ie/web/src/lib/workflow-receivers.ts:1838 Dispatched through POST /api/ask/workflow:preview-step, after the envelope validates the payload.

workflow family · 17 more

workflow:apply-diff workflow:apply-tql workflow:create workflow:delete workflow:fade workflow:get workflow:list workflow:run workflow:runs workflow:settled-notify workflow:step-stats workflow:stop workflow:tql workflow:trigger workflow:update workflow:validate workflow:webhook-subscribe

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workflowId": {
      "type": "string"
    },
    "stepId": {
      "type": "string"
    },
    "mockTrigger": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "mockSteps": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    }
  },
  "required": [
    "workflowId",
    "stepId"
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "receiver": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "data": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "receiver",
    "data"
  ]
}