MEmentium
workflow-editor

Deploy Workflow

Deploy (activate/deactivate) a v3 workflow.

This endpoint:

  1. Parses the YAML and validates every node against the node registry.
  2. Materializes WorkflowNode + WorkflowNodeConnection rows in the DB.
  3. If the workflow is a draft, promotes it to its parent (same as v2).
  4. Sets is_active and increments deployed_version.

Can also be called on an already-deployed workflow to deactivate it.

patch/v3/workflow-editor/drafts/{workflow_id}/deploy

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

workflow_idstring uuid required

Headers

mentium-workspace-idstring nullable

Request body

is_activeboolean

Whether to activate or deactivate the workflow.

Response

Successful Response

idstring required
namestring nullable
is_activeboolean required
is_draftboolean required
deployed_versioninteger required
yaml_contentstring required
node_countinteger

Number of materialized nodes

webhook_api_keystring nullable

Raw API key for the HTTP trigger webhook. Only present on the first deploy when require_auth is enabled. Store it securely; the server does not retain the plaintext.

Changes

No recorded changes to this operation across all 2 revisions of this API.