WorkflowInstanceCreateOptions

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:10136

Type Parameters

PARAMS

PARAMS = unknown

Properties

id?

optional id: string

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:10140

An id for your Workflow instance. Must be unique within the Workflow.

---

params?

optional params: PARAMS

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:10144

The event payload the Workflow instance is triggered with

---

retention?

optional retention: object

Defined in: .pnpm-home/store/v11/links/@cloudflare/workers-types/4.20251118.0/2891147a4db443bf13ca098dcb7381fb6bac5793758b7fd187ebaf5bc0deb969/node_modules/@cloudflare/workers-types/index.ts:10149

The retention policy for Workflow instance. Defaults to the maximum retention period available for the owner’s account.

errorRetention?

optional errorRetention: WorkflowSleepDuration

successRetention?

optional successRetention: WorkflowSleepDuration