Skip to content

Create Workflow

Create a new workflow in Last Mile Intelligence.

createWorkflow

workflow

ParameterTypeRequiredDefaultDescription
Workflow DataJSONYes-Workflow object with required fields
FieldTypeRequiredDescription
namestringYesWorkflow name
descriptionstringNoWorkflow description
triggerstringYesEvent that triggers the workflow
stepsarrayYesArray of workflow steps
isActivebooleanNoWhether workflow is active (default: true)
TriggerDescription
order.createdWhen a new order is created
order.updatedWhen an order is updated
task.createdWhen a task is created
task.completedWhen a task is completed
route.startedWhen a route begins
route.completedWhen a route is finished
{
"id": "wf_new123",
"name": "New Order Notification",
"trigger": "order.created",
"steps": [
{
"id": "step_1",
"action": "send_notification",
"order": 1
}
],
"isActive": true,
"createdAt": "2024-06-21T09:00:00Z"
}
{
"success": false,
"error": "Validation failed",
"details": {
"trigger": "Invalid trigger type"
}
}
  • Missing API Token: LMI credential is missing API token
  • Invalid Trigger: Trigger type is not recognized
  • Invalid Steps: Workflow steps are malformed
  • Validation Error: Required fields missing or invalid
  • Permission Denied: API token lacks permission for this operation