Cflow API Documentation

CFLOW API Calls URL

The URL used to access the Web API depends on where your initial Cflow account was set up. Use the appropriate URLs as shown below

US Region : https://us.cflowapps.com/integromat/api

AP Region : https://ap.cflowapps.com/integromat/api

Note: All examples given below use the US region URL. Please replace it with the URL appropriate for your region.

1) Authentication

Cflow uses API Key and User Key, Username to authenticate requests.

* Login Cflow and Navigate to Dashboard=>Admin=> API Settings>Get API Key
* Navigate to Profile =>API Key => UserKey.

End Point HTTP Method
https://us.cflowapps.com/integromat/api/connection/GetConnection GET

Request Parameters:

Headers Type
apikey string
userkey string
username string

Above request parameters will be needed for every endpoint call for authentication.

Headers
——–
apikey: “ABC123”,

Content-Type: “application/json”, userkey: “ABC123”
HTTP Method: GET

Response:


* 200 – OK
Everything worked as expected.
* 401 – Unauthorized
No valid API key provided.

2) Get workflows

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/getworkflows GET

Request Parameters:

Parameter Type
username string

Response:


{
“Workflows”: [
{
“WorkflowDisplayName”: “Test”,
“WorkflowName”: “Test”
},
{
“WorkflowDisplayName”: “User Workflow”,
“WorkflowName”: “User Workflow”
},
{
“WorkflowDisplayName”: “SampleWorkflow”,
“WorkflowName”: “SampleWorkflow”
},
{
“WorkflowDisplayName”: “TrWorkflow”,
“WorkflowName”: “TrWorkflow”
}
]
}

3) Get Process

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/getprocess GET

Request Parameters:

Parameter Type
username string
WorkflowName string

Response:


[
{
“ProcessStage”: “User Workflow”,
“ProcessStageDisplayName”: “User Workflow”,
“ProcessID”: “27405”
},
{
“ProcessStage”: “Manager Review”,
“ProcessStageDisplayName”: “Manager Review”,
“ProcessID”: “27406”
},
{
“ProcessStage”: “END”,
“ProcessStageDisplayName”: “END”,
“ProcessID”: “27407”
}
]

4) Get Status

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/getstatus GET

Request Parameters:

Parameter Type
group_id string
WorkflowName string

Response:


{
“Status”: [
{
“Group_ID”: “27406”,
“Field_Status”: “New”
},
{
“Group_ID”: “27406”,
“Field_Status”: “Approved”
},
{
“Group_ID”: “27406”,
“Field_Status”: “Rejected”
}
]
}

5) Submit Record

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/submitrecord POST

Request Parameters:

Parameter Type
username string
WorkflowName string

Request Sample [Field Inputs]:


{
“main”:
{
“WorkflowName”:”SampleWorkflow”
},
“dynamicobj”:
{
“City”:”trichy”,
“Name1″:”ashoka”,
“Email”:”ashoka@cavintek.com”,
“Build_Date”:”3/26/2022 6:30:00 PM”,
“Work_Status”: [
“Stage”
],
“Completed_work”:[
“stage testing completed”,
“live testing completed”
]

}
}

Response:


{
“Record_Id”: “44”
}

6) Update Record

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/updaterecord POST

Request Parameters:

Parameter Type
username string
WorkflowName string
group_id string
RecordId string

Request Sample[Fields Inputs]:


{

“main”:
{
“WorkflowName”:”SampleWorkflow”,
“group_id”:”27408″,
“RecordId”:”32″

},
“Values”:
{
“City”:”tiruchirappalli”,
“Name1″:”ashoka”,
“Email”:”ashoka@cavintek.com”,
“Build_Date”:”3/26/2022 6:30:00 PM”
}

}

Response:


{
“Record_Id”: “32”
}

7) Get WorkFlow Process Fields

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/getworkflowprocessfieldsformap GET

Request Parameters:

Parameter Type
username string
WorkflowName string
group_id string

Response:


[
{
“name”: “City”,
“type”: “text”,
“label”: “City”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Email”,
“type”: “text”,
“label”: “Email”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved By2”,
“type”: “text”,
“label”: “END Approved By”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved Date2”,
“type”: “date”,
“label”: “END Approved Date”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “GoogleSheetRowNumber”,
“type”: “text”,
“label”: “GoogleSheetRowNumber”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved By1”,
“type”: “text”,
“label”: “Manager Review Approved By”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved Date1”,
“type”: “date”,
“label”: “Manager Review Approved Date”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Comments1”,
“type”: “text”,
“label”: “Manager Review Comments”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: “”,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Status1”,
“type”: “select”,
“label”: “Manager Review Status”,
“options”: [
{
“label”: “New”,
“value”: “New”
},
{
“label”: “Approved”,
“value”: “Approved”
},
{
“label”: “Rejected”,
“value”: “Rejected”
}
],
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Name”,
“type”: “text”,
“label”: “Name”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Phone”,
“type”: “text”,
“label”: “Phone”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “RecordId”,
“type”: “text”,
“label”: “Record ID”,
“options”: null,
“spec”: null,
“help”: “Record ID”,
“default:”: null,
“required”: true,
“multiple”: false,
“multiline”: false
}
]

8) Get WorkFlow FieldSets

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/getworkflowfieldsets GET

Request Parameters:

Parameter Type
username string
WorkflowName string

Response:


[
{
“name”: “Name”,
“type”: “text”,
“label”: “Name”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Phone”,
“type”: “text”,
“label”: “Phone”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Email”,
“type”: “text”,
“label”: “Email”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “City”,
“type”: “text”,
“label”: “City”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “GoogleSheetRowNumber”,
“type”: “text”,
“label”: “GoogleSheetRowNumber”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
}
]

9) Get Workflow Process Fieldsets

End Point HTTP Method
https://us.cflowapps.com/integromat/api/cflow/getworkflowprocessfieldsets GET

Request Parameters:

Parameter Type
username string
WorkflowName string
group_id string

Response:


[
{
“name”: “City”,
“type”: “text”,
“label”: “City”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Email”,
“type”: “text”,
“label”: “Email”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved By2”,
“type”: “text”,
“label”: “END Approved By”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved Date2”,
“type”: “date”,
“label”: “END Approved Date”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “GoogleSheetRowNumber”,
“type”: “text”,
“label”: “GoogleSheetRowNumber”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved By1”,
“type”: “text”,
“label”: “Manager Review Approved By”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Approved Date1”,
“type”: “date”,
“label”: “Manager Review Approved Date”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Comments1”,
“type”: “text”,
“label”: “Manager Review Comments”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: “”,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “R_Status1”,
“type”: “select”,
“label”: “Manager Review Status”,
“options”: [
{
“label”: “New”,
“value”: “New”
},
{
“label”: “Approved”,
“value”: “Approved”
},
{
“label”: “Rejected”,
“value”: “Rejected”
}
],
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Name”,
“type”: “text”,
“label”: “Name”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
},
{
“name”: “Phone”,
“type”: “text”,
“label”: “Phone”,
“options”: null,
“spec”: null,
“help”: “”,
“default:”: null,
“required”: false,
“multiple”: false,
“multiline”: false
}
]

Leave a Reply

Your email address will not be published. Required fields are marked *