MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Workflows

Publish a workflow

Make the draft the live version. Real events then run it, unless the workflow is paused. Run `validateWorkflow` first: publish is refused while the draft has errors. Ask the user before you publish.

Workflow builder. Included from the Jump Starter plan. See plans.

POST/workflows//publish
Path parameters
workflow_idrequired
Query parameters
user_idinteger

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients). 

curl -X POST 'https://omnidim.io/api/v1/workflows/{workflow_id}/publish' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "workflow": {
    "id": 0,
    "name": "string",
    "status": "draft",
    "published_version_id": 0,
    "webhook_url": "string",
    "draft": {
      "version_id": 0,
      "revision": "string",
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": "string"
        }
      ],
      "edges": [
        {
          "from": "string",
          "to": "string",
          "handle": "string"
        }
      ]
    }
  },
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "node": "string",
      "field": "string",
      "hint": "string"
    }
  ]
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

workflow_id*integer

Id of the workflow.

Query Parameters

user_id?integer

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.

Response body

application/json

Response Body

The draft is now live.

application/json
workflow?
warnings?

Was this page helpful?

Validate a workflow draft

Check the draft and list what blocks publish. It changes nothing. Call it after your edits and fix every error before `publishWorkflow`.

Activate a workflow

Turn the published workflow on, so real events run it. Use it to resume a workflow you paused with `deactivateWorkflow`.