Skip to main content
POST
Create automation

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.