Skip to content

Sync docs for PR #825: Workflow Integration Enhancements#28018

Closed
agents-git-bot[bot] wants to merge 1 commit into
productionfrom
sync-docs-pr-825
Closed

Sync docs for PR #825: Workflow Integration Enhancements#28018
agents-git-bot[bot] wants to merge 1 commit into
productionfrom
sync-docs-pr-825

Conversation

@agents-git-bot

@agents-git-bot agents-git-bot Bot commented Feb 1, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR syncs documentation for cloudflare/agents#825: Workflow Integration Enhancements.

Changes

Completely rewrote /agents/api-reference/run-workflows/ to document the new comprehensive Workflow Integration features:

New Features Documented:

  • AgentWorkflow base class for tight Agent-Workflow integration
  • Automatic workflow tracking in Agent SQLite database (cf_agents_workflows table)
  • Lifecycle callbacks: onWorkflowProgress, onWorkflowComplete, onWorkflowError, onWorkflowEvent
  • Workflow control methods: terminateWorkflow(), pauseWorkflow(), resumeWorkflow(), restartWorkflow()
  • Cursor-based pagination for getWorkflows() - now returns WorkflowPage instead of array
  • Bidirectional communication patterns between Workflows and Agents
  • State synchronization via step.updateAgentState() and step.mergeAgentState()
  • Human-in-the-loop approval flows with waitForApproval() helper
  • Comprehensive examples and patterns for common use cases

Breaking Change:

  • getWorkflows() now returns WorkflowPage with pagination support instead of a simple array (acceptable since workflows are pre-release)

Known Limitations:

Documentation Style

Follows Cloudflare docs standards:

  • Uses TypeScriptExample components for all code blocks
  • Uses WranglerConfig component for wrangler configuration
  • Full relative links (e.g., /workflows/, /agents/api-reference/store-and-sync-state/)
  • No contractions or exclamation marks
  • Structured with clear API reference sections and practical examples

Source PR


Note: This is an automated documentation sync from the cloudflare/agents repository.

@agents-git-bot
agents-git-bot Bot requested a review from a team February 1, 2026 17:29
@agents-git-bot
agents-git-bot Bot requested a review from a team as a code owner February 1, 2026 17:29
@github-actions github-actions Bot added product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/m labels Feb 1, 2026
@github-actions

github-actions Bot commented Feb 1, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/agents/ @irvinebroque, @rita3ko, @elithrar, @thomasgauvin, @threepointone, @whoiskatrin, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

@github-actions

github-actions Bot commented Feb 1, 2026

Copy link
Copy Markdown
Contributor

This update comprehensively documents the new Workflow Integration features added in cloudflare/agents#825:

- New AgentWorkflow base class for tight Agent-Workflow integration
- Workflow tracking in Agent SQLite database with cf_agents_workflows table
- Lifecycle callbacks: onWorkflowProgress, onWorkflowComplete, onWorkflowError, onWorkflowEvent
- New workflow control methods: terminateWorkflow, pauseWorkflow, resumeWorkflow, restartWorkflow
- Cursor-based pagination for getWorkflows() with WorkflowPage return type
- Bidirectional communication patterns (Workflow ↔ Agent)
- State synchronization via step.updateAgentState and step.mergeAgentState
- Human-in-the-loop approval flow with waitForApproval helper
- Comprehensive patterns and examples for common use cases

Breaking change: getWorkflows() now returns WorkflowPage instead of array (pre-release).

Note: Workflow control methods not yet supported in local dev - work when deployed.

Related: cloudflare/agents#825, cloudflare/agents#823
@agents-git-bot agents-git-bot Bot changed the title Workflow Integration Enhancements Sync docs for PR #825: Workflow Integration Enhancements Feb 1, 2026
@github-actions

github-actions Bot commented Feb 1, 2026

Copy link
Copy Markdown
Contributor

CI run failed: build logs

@github-actions
github-actions Bot deleted the sync-docs-pr-825 branch April 3, 2026 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants