Workflow

API reference for Cloudflare Workflow binding

Workflow

Creates a workflow binding for orchestrating and automating tasks in Cloudflare Workers.

Props

workflowName · string

Name of the workflow.

Hide default

className if provided, otherwise id

Show constraints

• Max length: 64
• Min length: 1

className · string

Name of the class that implements the workflow.

Hide default

workflowName if provided, otherwise id

Show constraints

• Max length: 255
• Min length: 1

scriptName · string

Name of the script containing the workflow implementation.

Hide default

Bound worker script

Output

id · string

Unique identifier for the workflow.

workflowName · string

Name of the workflow.

className · string

Class name used to identify the workflow.

scriptName · string

Name of the script containing the workflow implementation.

type · workflow

Type identifier for the binding.

Examples

Basic Workflow

const workflow = Workflow("my-workflow", {
  workflowName: "my-workflow",
  className: "MyWorkflow"
});

const worker = await Worker("api", {
  entrypoint: "./src/worker.ts",
  bindings: {
    WORKFLOW: workflow
  }
});

OFAC Compliance Workflow

const worker = await Worker("compliance", {
  entrypoint: "./src/worker.ts",
  bindings: {
    OFAC_WORKFLOW: Workflow("OFACWorkflow", {
      className: "OFACWorkflow",
      workflowName: "ofac-workflow"
    })
  }
});