StopWorkflowRun

StopWorkflowRun

This API stops a running workflow.

Input parameters

Parameter	Type	Required	Description
`accountId`	Number	Yes	Your account ID.
`runId`	String	Yes	The unique identifier of the workflow run to stop. Obtained from `StartWorkflowRun` API.

mutation {
  workflowAutomationStopWorkflowRun(
    accountId: 11933347
    runId: "7ffbe082-8efa-4d3d-901a-a08bcf22bcd3"
  ) {
    runId
  }
}

The mutation returns:

runId: The unique identifier of the stopped workflow run. Returns an empty runId if the workflow is not found.

Execute a workflow to get a runId

Monitor workflow status before stopping

Understand when to stop workflows