API Documentation

This page provides API documentation for workflows

To get all your workflows use this get API.

HTTP Request
GET https://api.hexomatic.com/v2/app/services/v1/workflows?key={YOUR_API_KEY}&limit={LIMIT}&offset={OFFSET}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexomatic settingsand copy your API key

LIMIT

number

this filed is optional and indicates the number of workflows to be received as a result

OFFSET

number

this filed is optional and indicates the point starting from where the workflows will be provided

Response Body

if request is successful you will get

JSON representation
{
"error": false,
"workflows": [
 Workflow
]
}
Fields
error

boolean

if the error returns false, it means that no error has occurred

Workflow []

object(Workflow)

Workflow represents a workflow object

Workflow

workflow object structure

JSON representation
Workflow = {
"id": Number,
"name": String,
"active": Boolean,
"steps": [
{
"index": Number,
"automation_name": String
}
],
"execution_data": {
"status": String
},
"created_at": String,
"updated_at": String
}
Fields
id

number

workflow id

name

string

workflow name

active

boolean

is workflow scheduled

steps

object

list of automations included in workflow (automation id and name )

execution_data

object

current status of the workflow

created_at

string

created date of the workflow

updated_at

string

updated date of the workflow

Example
object {
"error": false,
"workflows": [
{
"id": 6,
"name": "New workflow 02.07.21 01:50:50",
"active": false,
"steps": [
{
"index": 0,
"automation_name": "data_input"
}
],
"execution_data": {
"status": ""
},
"created_at": "2021-07-02T13:51:08.023Z",
"updated_at": "2021-07-02T13:51:18.738Z"
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
object {
"error": true,
"message": "invalid API key"
}



To get workflow logs use this API.

HTTP Request
GET https://api.hexomatic.com/v2/app/services/v1/workflow-logs?workflow_id={YOUR_WORKFLOW_ID}&key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit settings and copy your API key

YOUR_WORKFLOW_ID

string

if you did get workflows request you must have recieved all the workflows' ids, you can take YOUR_WORKFLOW_ID from there

Response Body

if request is successful you will get

JSON representation
{
"error": false,
"logs": [
 Log
]
}
Fields
error

boolean

if the error returns false, it means that no error has occurred

Log []

object(Log)

Log represents a log object

Log

Log object structure

JSON representation
Log = {
"log": String,
"type": String
}
Fields
log

string

date when log was created

type

string

description of the done operation

Example
object {
"error": false,
"logs": [
{
"log": "2021-07-02T13:51:08.023Z",
"type": "data_input started"
},
{
"log": "2021-07-02T13:51:08.023Z",
"type": "Passing input data"
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
object {
"error": true,
"message": "invalid API key"
}



To get completed workflow data use this API.

HTTP Request
GET https://api.hexomatic.com/v2/app/services/v1/workflows/{YOUR_WORKFLOW_ID}?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit settings and copy your API key

YOUR_WORKFLOW_ID

string

if you did get workflows request you must have recieved all the workflows' ids, you can take YOUR_WORKFLOW_ID from there

Response Body

if request is successful you will get

JSON representation
{
"error": false,
"workflows": {
 WorkflowsData
}
}
Fields
error

boolean

if the error returns false, it means that no error has occurred

workflow

object(WorkflowsData)

WorkflowsData represents a WorkflowsData object

WorkflowsData

WorkflowsData object structure

JSON representation
WorkflowsData = {
"id": Number,
"name": String
"active": Boolean
"status": String
"data": {
"content": [
String[]
],
"headers": [
String[]
]
},
}
Fields
id

number

workflow id

name

string

workflow name

active

boolean

is workflow active

status

string

workflow status

data

object

workflow data

Example
object {
"error": false,
"workflow": {
"id": 1,
"name": "New workflow 01.11.21 05:50:30",
"active": false,
"status": "completed",
"data": {
"content": [
[
"https:/example.com/category/23",
"https:/example.com/item/16764253"
],
[
"",
"https:/example.com/item/16883183"
]
],
"headers": [
[
"__url",
"propertyName1"
]
}
}
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
object {
"error": true,
"message": "invalid API key"
}



To delete workflow use this API.

HTTP Request
DELETE https://api.hexomatic.com/v2/app/services/v1/workflows?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit settings and copy your API key

Request Body
Fields
workflows_ids

array(ids)

you should provide array of id or ids to select specific workflow/workflows

Response Body

if request is successful you will get

JSON representation
{
"error": false
}
Fields
error

boolean

if the error returns false, it means that no error has occurred

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
object {
"error": true,
"message": "invalid API key"
}



To update workflows status use the following API.

HTTP Request
PUT https://api.hexomatic.com/v2/app/services/v1/workflows?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit settings and copy your API key

Request Body
Fields
workflows_ids

array (ids or id)

you should provide array of id or ids to select specific workflow/workflows

active

boolean

you should provide true or false to change the selected workflow/workflows status

Example
{
"workflows_ids": [351],
"active": true
}
Response Body

if request is successful you will get

JSON representation
{
"error": false
}
Fields
error

boolean

if the error returns false, it means that no error has occurred

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
object {
"error": true,
"message": "invalid API key"
}



Scheduled Maintenance Notice

We are performing major infrastructure upgrades to enhance the performance of our services. Maintenance will take place during the next 24 hours. While we’ll work to minimize downtime, brief interruptions may occur, and some services might take an additional day to be fully restored.

Thank you for your patience and understanding as we improve your experience.
— The Hexact Team