WorkflowMemo

WorkflowMemo Type - Structured workflow metadata

Represents structured metadata associated with a Temporal workflow execution. This type provides a standardized way to store and retrieve workflow-related information such as titles, subtitles, and custom data.

Fields

Field	Type	Description
title	String	Optional title for the workflow, typically used for display purposes
subtitle	String	Optional subtitle providing additional context about the workflow
data	Map	Optional custom data map for storing arbitrary key-value pairs

Service

This type is defined in the Workflow service.

Breaking Changes

This type replaces the previous map[string]any representation of the memo field in WorkflowExecutionInfo. Previously, the memo was an unstructured map; it is now a structured type with specific fields.

Migration Notes

Before:

query {
  workflowExecutions(where: { ... }) {
    memo  # Was Map type (unstructured)
  }
}

After:

query {
  workflowExecutions(where: { ... }) {
    memo {
      title
      subtitle
      data
    }
  }
}

Usage Example

Query Workflow Executions with Memo

query {
  workflowExecutions(
    where: {
      typeName: "PickingWorkflow"
      statusIn: ["RUNNING", "COMPLETED"]
    }
  ) {
    execution {
      workflowId
      id
    }
    type {
      name
    }
    status
    startTime
    closeTime
    memo {
      title
      subtitle
      data
    }
  }
}

Example Response

{
  "data": {
    "workflowExecutions": [
      {
        "execution": {
          "workflowId": "picking-order-12345",
          "id": "run-abc-123"
        },
        "type": {
          "name": "PickingWorkflow"
        },
        "status": "RUNNING",
        "startTime": "2024-01-15T10:30:00Z",
        "closeTime": null,
        "memo": {
          "title": "Picking Order #12345",
          "subtitle": "Zone A - Priority High",
          "data": {
            "orderCount": 5,
            "assignee": "user-123",
            "priority": "high"
          }
        }
      }
    ]
  }
}

Related Types

• WorkflowExecutionInfo - Parent type containing the memo field

• TemporalWorkflow - Workflow execution information

• Workflow - Workflow definition

Notes

• The title field is commonly used for human-readable workflow identification in UIs

• The subtitle field provides additional context without cluttering the main title

• The data field allows storing arbitrary structured data that doesn't fit into title/subtitle

• All fields are optional and may be null if not set during workflow execution

• The memo is set during workflow start and can be used to pass display-friendly information

• Field names are case-insensitive: When setting memo data (e.g., through Temporal SDK), you can use any casing for field keys ("title", "Title", or "TITLE" all work the same way)