> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/cloudflare/cloudflare-typescript/llms.txt
> Use this file to discover all available pages before exploring further.
# Workflows
> Orchestrate long-running tasks with Cloudflare Workflows
Cloudflare Workflows enables you to build reliable, long-running workflows that can survive Worker restarts and failures. Use the API to create, manage, and monitor workflow executions.
## Overview
Access the Workflows API:
```typescript theme={null}
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env.CLOUDFLARE_API_TOKEN,
});
// Access Workflows resources
const workflows = client.workflows;
```
## Workflows
Manage workflow definitions.
### Create or update a workflow
Create or modify a workflow definition.
```typescript theme={null}
const workflow = await client.workflows.update(
'my-workflow',
{
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
class_name: 'MyWorkflow',
script_name: 'my-worker',
}
);
```
Name for the workflow
Your Cloudflare account ID
The exported Workflow class name from your Worker
The Worker script that contains the Workflow class
The workflow ID
The workflow name
The Workflow class name
The associated Worker script
ISO 8601 timestamp when the workflow was created
ISO 8601 timestamp when the workflow was last modified
### List workflows
Retrieve all workflows in your account.
```typescript theme={null}
for await (const workflow of client.workflows.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
console.log(workflow);
}
```
Your Cloudflare account ID
Filter workflows by name
Page number for pagination
Number of workflows per page (default: 20, max: 100)
Instance count statistics
Number of queued instances
Number of running instances
Number of completed instances
Number of errored instances
### Get a workflow
Retrieve details about a specific workflow.
```typescript theme={null}
const workflow = await client.workflows.get(
'my-workflow',
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
The workflow name
Your Cloudflare account ID
### Delete a workflow
Delete a workflow definition.
```typescript theme={null}
await client.workflows.delete(
'my-workflow',
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
The workflow name to delete
Your Cloudflare account ID
## Instances
Manage workflow execution instances.
### Create an instance
Start a new workflow instance.
```typescript theme={null}
const instance = await client.workflows.instances.create(
'my-workflow',
{
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
params: { userId: '123', action: 'process' },
}
);
```
The workflow name
Your Cloudflare account ID
Parameters to pass to the workflow instance
The instance ID
The workflow name
Instance status: 'queued', 'running', 'complete', 'errored', or 'terminated'
ISO 8601 timestamp when the instance was created
### List instances
Retrieve all instances for a workflow.
```typescript theme={null}
for await (const instance of client.workflows.instances.list(
'my-workflow',
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
)) {
console.log(instance);
}
```
The workflow name
Your Cloudflare account ID
Filter by status: 'queued', 'running', 'complete', 'errored', 'paused', 'waiting', 'terminated', or 'waitingForPause'
Page number for pagination
Number of instances per page (default: 20, max: 100)
### Get an instance
Retrieve details about a specific workflow instance.
```typescript theme={null}
const instance = await client.workflows.instances.get(
'my-workflow',
instanceId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
The workflow name
The instance ID
Your Cloudflare account ID
The instance ID
Current instance status
The workflow output (if completed)
Error details (if errored)
### Bulk instance operations
Terminate or pause multiple instances.
```typescript theme={null}
const result = await client.workflows.instances.bulk(
'my-workflow',
{
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
action: 'terminate',
instance_ids: [instanceId1, instanceId2],
}
);
```
The workflow name
Your Cloudflare account ID
Action to perform: 'terminate' or 'pause'
Array of instance IDs to act on
## Versions
Track workflow version history.
### List versions
Retrieve version history for a workflow.
```typescript theme={null}
for await (const version of client.workflows.versions.list(
'my-workflow',
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
)) {
console.log(version);
}
```
### Get a version
Retrieve details about a specific workflow version.
```typescript theme={null}
const version = await client.workflows.versions.get(
'my-workflow',
versionId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
```
## Defining workflows in Workers
Define a Workflow class in your Worker:
```typescript theme={null}
import { WorkflowEntrypoint, WorkflowStep } from 'cloudflare:workers';
export class MyWorkflow extends WorkflowEntrypoint {
async run(event, step) {
// Step 1: Fetch data
const data = await step.do('fetch-data', async () => {
const response = await fetch('https://api.example.com/data');
return response.json();
});
// Step 2: Process data
const result = await step.do('process-data', async () => {
return processData(data);
});
// Step 3: Store result
await step.do('store-result', async () => {
await env.DB.prepare('INSERT INTO results VALUES (?)')
.bind(JSON.stringify(result))
.run();
});
return { success: true, result };
}
}
export default {
async fetch(request, env) {
// Start a workflow instance
const instance = await env.MY_WORKFLOW.create({
params: { userId: '123' },
});
return Response.json({ instanceId: instance.id });
},
};
```
## Best practices
1. **Idempotent steps**: Each step should be idempotent to handle retries
2. **Step naming**: Use descriptive step names for easier debugging
3. **Error handling**: Use try-catch blocks within steps for granular error handling
4. **State management**: Store state in step results, not in memory
5. **Timeouts**: Be aware of step execution time limits
6. **Monitoring**: Regularly check instance status and error rates