Workflow APIs
Access to REST API operations is only available to users with a business plan subscription.
Gathr’s REST API supports the following actions on Workflows:
Trigger workflow
This API will trigger a Gathr Workflow with the following REST call.
The trigger call can only be performed on Unscheduled Workflows or the Workflows that are scheduled with the frequency set to None.
Request URL
POST https://app.gathr.one/api/v1/application/workflow/trigger
Headers
| Parameter Name | Description |
|---|---|
Content-Type | application/json |
Authorization | < gathr-user-token > |
Request Body
{
"name":"<your_workflow_name>",
"projectName":"<your_project_name>"
}
Request Body Parameters
| Name | Required | Description |
|---|---|---|
name | YES | The name of the Workflow to be triggered. |
projectName | YES | The Gathr project name containing the Workflow to be triggered. |
Response
HTTP Status Code: 200
{"message": "Workflow action success.",
"status": "Success"}
HTTP Status Code: 400
{"message": "<A description of the error will be provided.>",
"status": "Error"}
Get Workflow Status
This API will get a Gathr Workflow’s status with the following REST call.
Request URL
POST https://app.gathr.one/api/v1/application/workflow/status
Headers
| Parameter Name | Description |
|---|---|
Content-Type | application/json |
Authorization | < gathr-user-token > |
Request Body
{
"name":"<your_workflow_name>",
"projectName":"<your_project_name>"
}
Request Body Parameters
| Name | Required | Description |
|---|---|---|
name | YES | The name of the Workflow to fetch its status. |
projectName | YES | The Gathr project name containing the Workflow for which the status is to be fetched. |
Response
HTTP Status Code: 200
{"application_status": "STOPPED",
"status": "success"}
{"application_status": "ACTIVE",
"status": "success"}
{"application_status": "ERROR",
"status": "success"}
{"application_status": "PAUSED",
"status": "success"}
HTTP Status Code: 400
{"error_description": "The workflow details were not found",
"status": "error"}
If you have any feedback on Gathr documentation, please email us!