Sync docs for PR #825: Workflow Integration Enhancements#28018
Closed
agents-git-bot[bot] wants to merge 1 commit into
Closed
Sync docs for PR #825: Workflow Integration Enhancements#28018agents-git-bot[bot] wants to merge 1 commit into
agents-git-bot[bot] wants to merge 1 commit into
Conversation
agents-git-bot
Bot
requested review from
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
as code owners
February 1, 2026 17:29
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
|
Preview URL: https://23003029.preview.developers.cloudflare.com Files with changes (up to 15)
|
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
Bot
force-pushed
the
sync-docs-pr-825
branch
from
February 1, 2026 17:50
2300302 to
8ad39e8
Compare
Contributor
|
CI run failed: build logs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
AgentWorkflowbase class for tight Agent-Workflow integrationcf_agents_workflowstable)onWorkflowProgress,onWorkflowComplete,onWorkflowError,onWorkflowEventterminateWorkflow(),pauseWorkflow(),resumeWorkflow(),restartWorkflow()getWorkflows()- now returnsWorkflowPageinstead of arraystep.updateAgentState()andstep.mergeAgentState()waitForApproval()helperBreaking Change:
getWorkflows()now returnsWorkflowPagewith pagination support instead of a simple array (acceptable since workflows are pre-release)Known Limitations:
terminate,pause,resume,restart) not yet supported in local dev withwrangler dev- work when deployed to Cloudflare (tracked in workflows:terminate(),pause(),resume(), andrestart()workflow methods not supported in local development agents#823)Documentation Style
Follows Cloudflare docs standards:
TypeScriptExamplecomponents for all code blocksWranglerConfigcomponent for wrangler configuration/workflows/,/agents/api-reference/store-and-sync-state/)Source PR
Note: This is an automated documentation sync from the cloudflare/agents repository.