Schema definition for workflow trigger response.
What this schema does
Defines the object fields used for workflow trigger response data exchanged by this API.
Used in endpoints
This schema is used as a response structure in the following endpoints:
POST /v1/workflows/{definitionId}/latest(response code(s): 200)
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| runId | string | Yes | Unique identifier for the workflow run triggered by the request. |
| definitionId | string | Yes | Unique identifier for the workflow definition. |
| version | integer | Yes | Version number of the workflow definition that was executed. |
| status | string | Yes | Current execution status of the triggered workflow run. |
{
"runId": "string",
"definitionId": "string",
"version": 0,
"status": "string"
}