Skip to main content
POST
/
automation
Create automation
curl --request POST \
  --url https://apiweb.mile.app/api/v3/automation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "event": "<string>",
  "automationType": "<string>",
  "dataType": "<string>",
  "isActive": "<string>"
}
'
{
  "status": true,
  "message": "Success",
  "data": {
    "name": "Auto create task automation",
    "event": "onTaskFinished",
    "automationType": "createTask",
    "dataType": "task",
    "automationDetails": {
      "flow": "Delivery",
      "flowId": "667b75b29edc36517c609ac2",
      "taskData": {
        "customerName": "vasco",
        "address": "Jakarta",
        "description": "$refFlow.name"
      }
    },
    "rules": {
      "flow": "Pickup",
      "flowId": "667b712f63020e5f182f0cb2",
      "fields": {
        "name": "roger",
        "address": "kemayoran"
      }
    },
    "organizationId": "621dd813eb3ebf16b94dbde3",
    "isActive": true,
    "updatedTime": "2022-07-13T03:16:40+00:00",
    "createdTime": "2022-07-13T03:16:40+00:00",
    "_id": "62ce3918d3f3e1681a3a54b1"
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
ā€‹
name
string
required

Automation's name. Example: Auto create task automation

ā€‹
event
string
required

Act as a trigger that start an automation. There are 8 different types. enum: onTaskCreated, onTaskFinished, onTaskAssigned, onDataSourceCreated, onRoutingResultFinished, onRoutingResultDispatched, onStartTrip, onFinishTrip onTaskCreated: Automation will happen when a task is created. onTaskFinished: Automation will happen when a task is finished (status task: Done). onTaskAssigned: Automation will happen when a task is assigned to field user(s). onDataSourceCreated: Automation will happen when a data source is created. onRoutingResultFinished: Automation will happen when a routing created is created. onRoutingResultDispatched: Automation will happen when a routing is dispatched. onStartTrip: Automation will happen when a start trip is triggered. onFinishTrip: Automation will happen when a finish trip is triggered. Example: onTaskFinished

ā€‹
automationType
string
required

Automation's type. The changes you want to automate. There are 6 different types: enum: createTask, createAssignTask, moveTask, assignTask, webhook, createOrUpdateDataSource, notification createTask: The task will create when an event happens. Example: createTask

ā€‹
dataType
string

Automation's data type. There are 4 different types. enum: task, data, routingResult, locationHistory Default: task

ā€‹
isActive
string

Automation's active state, only active automation will proceed by system Default: true

Response

Success

ā€‹
status
boolean

Status of response.

ā€‹
message
string

Message of API response.

ā€‹
data
object

Detail of object automation.