Skip to main content
POST
/
instances
/
message
Start a Workflow
curl --request POST \
  --url https://{instance}.domo.com/api/workflow/v1/instances/message \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "messageName": "Start MyWorkflow",
  "version": "0.0.1",
  "modelId": "a8afdc89-9491-4ee4-b7c3-b9e9b86c0138",
  "data": {
    "parameter1": 13,
    "parameter2": 7
  }
}
'
{
  "id": "2052e10a-d142-4391-a731-2be1ab1c0188",
  "modelId": "a8afdc89-9491-4ee4-b7c3-b9e9b86c0138",
  "modelName": "AddTwoNumbers",
  "modelVersion": "1.1.0",
  "createdBy": "8811501",
  "createdOn": "2023-11-15T15:28:57.479Z",
  "updatedBy": "8811501",
  "updatedOn": "2023-11-15T15:28:57.479Z",
  "status": null
}

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Domo Developer Token for authentication

Body

application/json
​
messageName
string
required

Message passed to start the Workflow Instance, usually "Start {workflow_name}"

​
version
string
required

The version identifier (e.g., 0.0.1)

​
modelId
string
required

The ID of the Workflow

​
data
object
required

The start parameters required to kick off the Workflow. Structure this object to be consistent.

Example:
{ "parameter1": 13, "parameter2": 7 }

Response

Workflow started successfully

​
id
string

ID of the newly created workflow instance

Example:

"2052e10a-d142-4391-a731-2be1ab1c0188"

​
modelId
string

ID of the workflow

Example:

"a8afdc89-9491-4ee4-b7c3-b9e9b86c0138"

​
modelName
string

Name of the workflow

Example:

"AddTwoNumbers"

​
modelVersion
string

Workflow version number

Example:

"1.1.0"

​
createdBy
string

User ID of workflow creator

Example:

"8811501"

​
createdOn
string<date-time>

Timestamp when the instance was created

Example:

"2023-11-15T15:28:57.479Z"

​
updatedBy
string

User ID of last updater

Example:

"8811501"

​
updatedOn
string<date-time>

Timestamp when the instance was last updated

Example:

"2023-11-15T15:28:57.479Z"

​
status
enum<string> | null

Status of the workflow instance. Can be null, IN_PROGRESS, CANCELED, or COMPLETED. A null status means the workflow hasn't reported back as started yet.

Available options:
null,
IN_PROGRESS,
CANCELED,
COMPLETED
Example:

null