POST/organizations/{organizationId}/workflows

Create a workflow

Creates a draft workflow with typed trigger, condition, and action steps.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

Idempotency-Keyheader · string · uuidoptional

Unique key for retry-safe writes, retained for 24 hours.

Request body

application/jsonrequired

namestringrequired

triggerobjectrequired

stepsarray<object>required

stateenumoptional

Values: "draft" · "active"

Responses

201application/json

Workflow created.

{
  "id": "wfl_01J8FC8R3N4V6Q9P2K7",
  "name": "Alert enterprise CSM about failed exports",
  "state": "active",
  "trigger": {
    "event": "export.failed"
  },
  "steps_count": 2,
  "run_health": {
    "last_24h": 42,
    "failed": 0
  },
  "created_at": "2026-08-12T13:20:00Z",
  "updated_at": "2026-09-01T08:00:00Z"
}

idstringoptional

namestringoptional

statestringoptional

triggerobjectoptional

steps_countintegeroptional

run_healthobjectoptional

created_atstring · date-timeoptional

updated_atstring · date-timeoptional

422

Workflow graph is invalid.

curl --request POST \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/workflows' \ --header 'Idempotency-Key: 5ba89923-8c6d-44a3-9ab7-2fbbdb865f9a' \ --header 'Content-Type: application/json' \ --data '{ "name": "Alert enterprise CSM about failed exports", "trigger": { "event": "export.failed" }, "steps": [ { "id": "filter_enterprise", "type": "condition", "expression": "event.organization.plan == '\"'\"enterprise'\"'\"" }, { "id": "notify_slack", "type": "notification", "channel": "slack", "template": "Export {{ event.id }} failed" } ], "state": "draft"}'

{ "id": "wfl_01J8FC8R3N4V6Q9P2K7", "name": "Alert enterprise CSM about failed exports", "state": "active", "trigger": { "event": "export.failed" }, "steps_count": 2, "run_health": { "last_24h": 42, "failed": 0 }, "created_at": "2026-08-12T13:20:00Z", "updated_at": "2026-09-01T08:00:00Z" }