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

Get a workflow run

One run of a workflow, with the result of each step. Use it to read the outcome of `testWorkflow`. A run is finished when `state` is `completed`, `failed` or `cancelled`.

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

GET/workflows//executions/
Path parameters
workflow_idrequired
execution_idrequired
Query parameters
user_idinteger

Reseller keys only: the id of one of your direct client users. The call then acts as that client, on that client's agents, numbers, campaigns and balance. Calls, sessions and bulk campaigns spend that client's balance and concurrency. Omit it to act on your own account. An empty value, 0, false or your own user id also means your own account. Any other value that is not a positive integer id is refused with 400 invalid_request. A key that is not a reseller's gets 403 when it names someone else. A user who is not your direct client gets 404. 

curl -X GET 'https://backend.omnidim.io/api/v1/workflows/{workflow_id}/executions/{execution_id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "execution": {
    "id": 0,
    "state": "running",
    "test": false,
    "steps": [
      {
        "node": "string",
        "status": "string",
        "error": "string",
        "output": "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.

execution_id*integer

The execution_id from testWorkflow.

Query Parameters

user_id?integer

Reseller keys only: the id of one of your direct client users. The call then acts as that client, on that client's agents, numbers, campaigns and balance. Calls, sessions and bulk campaigns spend that client's balance and concurrency. Omit it to act on your own account. An empty value, 0, false or your own user id also means your own account. Any other value that is not a positive integer id is refused with 400 invalid_request. A key that is not a reseller's gets 403 when it names someone else. A user who is not your direct client gets 404.

Response body

application/json

Response Body

The run.

application/json
execution?

Test a workflow

Runs the draft once with payload as the trigger data. Every node runs for real: WhatsApp messages, SMS, emails and calls go out and CRM records change. Ask the user before calling it, and use their own phone number or email in the payload. It returns an `execution_id` at once. Poll `getWorkflowExecution` for the result.

List simulations

Retrieve simulations with pagination.