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

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`.

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

POST/workflows//validate
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}/validate' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "node": "string",
      "field": "string",
      "hint": "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 errors and warnings. Errors block publish.

application/json

What validation found. Errors block publish. Warnings do not.

errors?
warnings?

Was this page helpful?

Delete a workflow

Delete a workflow. Its published version stops running. This cannot be undone, so confirm with the user first. To stop it without deleting, use `deactivateWorkflow`.

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.