Mutation
mutation CancelWorkflowExecution($input: CancelWorkflowExecutionInput!) {
cancelWorkflowExecution(input: $input) {
workflowExecution {
id
workflowId
workflow {
id
name
trigger
startStepId
steps {
__typename
}
publishedAt {
__typename
}
}
triggeredBy
executionStatus
errorMessage
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"workflowExecutionId": "id"
}
}Response
{
"data": {
"cancelWorkflowExecution": {
"workflowExecution": {
"id": "id",
"workflowId": "id",
"workflow": {
"id": "id",
"name": "string",
"trigger": "string",
"startStepId": "id",
"steps": [
{
"__typename": "WorkflowStep"
}
],
"publishedAt": {
"__typename": "DateTime"
}
},
"triggeredBy": "string",
"executionStatus": "QUEUED",
"errorMessage": "string"
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
cancelWorkflowExecution
Cancel a QUEUED or WAITING workflow execution. It stops where it is: a waiting execution does not take its wait step’s cancelled branch. Fails with workflow_execution_not_cancellable for any other status.
MUTATION
cancelWorkflowExecution(input: CancelWorkflowExecutionInput!): CancelWorkflowExecutionOutput!Arguments
input
required
Returns
workflowExecution
The cancelled execution, now CANCELLED.
error
Mutation
mutation CancelWorkflowExecution($input: CancelWorkflowExecutionInput!) {
cancelWorkflowExecution(input: $input) {
workflowExecution {
id
workflowId
workflow {
id
name
trigger
startStepId
steps {
__typename
}
publishedAt {
__typename
}
}
triggeredBy
executionStatus
errorMessage
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"workflowExecutionId": "id"
}
}Response
{
"data": {
"cancelWorkflowExecution": {
"workflowExecution": {
"id": "id",
"workflowId": "id",
"workflow": {
"id": "id",
"name": "string",
"trigger": "string",
"startStepId": "id",
"steps": [
{
"__typename": "WorkflowStep"
}
],
"publishedAt": {
"__typename": "DateTime"
}
},
"triggeredBy": "string",
"executionStatus": "QUEUED",
"errorMessage": "string"
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

