> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/types/temporalworkflow.md).

# 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

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

## JavaScript Example

```javascript
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

{% hint style="warning" %}
**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.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/types/temporalworkflow.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.