Introduction
This API allows you to adjust and create values in the workflow “Firefighting” module of CustomerGauge.
For example, if you have an external help desk system you can add new entries into the workflow to “CLOSE” a firefighting issue with a comment and user.
Good to know
API response format:
Our APIs return data in either JSON or XML format (depending on request by .json or .xml).
About this API
Resource Information
| Response formats | JSON (default), XML |
| HTTP method | POST |
| Response family | Workflow |
| Header | Authorization: api_key XXXXX |
Resource URL
Europe Production Server: https://api.eu.customergauge.com/v4.1/workflow.json
US Production Server: https://api.us.customergauge.com/v4.1/workflow.json
Australia Production Server: https://api.au.customergauge.com/v4.1/workflow.json
How to call
POST Data
Post data as key value based on upload mapping.
POST Data Example
| number_customergauge required | CG-ID Example Values: 12 |
| status optional | Workflow status Example Values: CLOSE You can use OPEN, IN-PROGRESS, PROGRESS, CLOSED or CLOSE. |
| comment optional | Workflow Comment Example Values: Solved the issue Use URL Encoded strings |
| assigned_to optional | Workflow Assigned to Example Values: des.patch@directness.net Email of valid user in the CustomerGauge system |
Example Requests
curl -H "Authorization: api_key XXXXX" -X POST https://api.eu.customergauge.com/v4.1/workflow.json -d number_customergauge=12 -d status=CLOSE -d comment="Solved the issue" -d assigned_to=des.patch@directness.net
Example Result
Message reported on successful operation:
{
"Data": {
"number_customergauge": 12
}
}Message reported on failed operation:
{
"Error": {
"Message": "Workflow not found",
"Code": 400200
}
}Not the API you're looking for?
Or view: