TemporalWorkflow

TemporalWorkflow Type

Audience: Programmer

The TemporalWorkflow type represents a workflow instance in the Temporal workflow execution engine, providing basic identification information for the workflow.

Fields

Field	Type	Description
type	String!	The workflow type name
id	String!	Unique identifier for the workflow instance
runID	String!	Unique identifier for the specific workflow run

Related Types

• TemporalMetadata: Key-value metadata pairs (used in other contexts)

Usage Example

mutation CreateInventoryItem($input: CreateInventoryItemInput!) {
  createInventoryItem(input: $input) {
    id
    workflow {
      type
      id
      runID
    }
  }
}

JavaScript Example

const result = await client.mutate({
  mutation: gql`
    mutation CreateInventoryItem($input: CreateInventoryItemInput!) {
      createInventoryItem(input: $input) {
        id
        workflow {
          type
          id
          runID
        }
      }
    }
  `,
  variables: {
    input: {
      sku: "ITEM-001",
      quantity: 100
    }
  }
});

console.log('Workflow:', result.data.createInventoryItem.workflow);
// Output: { type: "InventoryItemWorkflow", id: "inv_123", runID: "run_456" }

Notes

• Used across multiple services (inventory, picking, receiving, workflow)

• Provides essential identifiers for tracking Temporal workflow execution

• Simplified structure focuses on core identification fields

Breaking Changes

Breaking Change (2025-01): The TemporalWorkflow type was significantly simplified. The following fields were removed:

• name → Use type instead

• workflowID → Use id instead

• workflowRunID → Use runID instead

• nextActivity → Removed (ActivityDetails type no longer exists)

• metadata → Removed from this type

• activityIndex → Removed

The ActivityDetails and TemporalActivityProperties types have been removed from the schema.