Check Workflow Status

checkWorkflowStatus Mutation

Checks the status of a running workflow instance in the Temporal workflow engine.

Arguments

Name	Type	Description
input	CheckWorkflowStatusInput!	Input data for checking the workflow status

Return Type

CheckWorkflowStatusResponse - Contains the status information for the requested workflow.

Input Fields

CheckWorkflowStatusInput:

Field	Type	Description
id	String!	Required workflow ID to check status for
runID	String!	Required workflow run ID to check status for

Return Fields

CheckWorkflowStatusResponse:

Field	Type	Description
status	String!	Current status of the workflow (e.g., "RUNNING", "COMPLETED", "FAILED", "CANCELED")
workflow	TemporalWorkflow	Workflow instance details if available

Usage Example

mutation {
  checkWorkflowStatus(
    input: {
      id: "inventory-restock-workflow-123",
      runID: "abc123de-f456-7890-ghij-klmnopqrstuv"
    }
  ) {
    status
    workflow {
      id
      runID
      status
      type
      startedAt
      completedAt
      result
      failure
    }
  }
}

JavaScript Example

const CHECK_WORKFLOW_STATUS = gql`
  mutation CheckWorkflowStatus($input: CheckWorkflowStatusInput!) {
    checkWorkflowStatus(input: $input) {
      status
      workflow {
        id
        runID
        status
        type
        startedAt
        completedAt
        result
        failure
      }
    }
  }
`;

const { data } = await client.mutate({
  mutation: CHECK_WORKFLOW_STATUS,
  variables: {
    input: {
      id: "inventory-restock-workflow-123",
      runID: "abc123de-f456-7890-ghij-klmnopqrstuv"
    }
  }
});

console.log(`Workflow status: ${data.checkWorkflowStatus.status}`);
if (data.checkWorkflowStatus.workflow) {
  console.log(`Workflow type: ${data.checkWorkflowStatus.workflow.type}`);
  console.log(`Started at: ${data.checkWorkflowStatus.workflow.startedAt}`);
}

Possible Status Values

• RUNNING: The workflow is currently executing

• COMPLETED: The workflow has completed successfully

• FAILED: The workflow has failed with an error

• CANCELED: The workflow was canceled

• TERMINATED: The workflow was terminated

• CONTINUED_AS_NEW: The workflow continued as a new execution

• TIMED_OUT: The workflow timed out

Important Notes

• This mutation queries the Temporal workflow engine for real-time status

• Both id and runID are required to uniquely identify the workflow instance

• The workflow instance must exist in the Temporal cluster for the query to succeed

• Use this mutation to monitor long-running workflow executions

• Status information includes execution details, results, and failure information if applicable

• This is a read operation despite being a mutation (following GraphQL conventions for operations that might have side effects)