diff --git a/src/content/docs/workflows/build/events-and-parameters.mdx b/src/content/docs/workflows/build/events-and-parameters.mdx index 57b5fe0fbe5aa84..143632df05b212d 100644 --- a/src/content/docs/workflows/build/events-and-parameters.mdx +++ b/src/content/docs/workflows/build/events-and-parameters.mdx @@ -70,7 +70,7 @@ export type WorkflowEvent = { payload: T; // The timestamp that the Workflow was triggered timestamp: Date; - // ID of the associated instance + // ID of the current Workflow instance instanceId: string; }; ``` diff --git a/src/content/docs/workflows/build/rules-of-workflows.mdx b/src/content/docs/workflows/build/rules-of-workflows.mdx index ec2e50c49957885..7ce9e43bd8f9e19 100644 --- a/src/content/docs/workflows/build/rules-of-workflows.mdx +++ b/src/content/docs/workflows/build/rules-of-workflows.mdx @@ -219,17 +219,17 @@ interface MyEvent { export class MyWorkflow extends WorkflowEntrypoint { async run(event: WorkflowEvent, step: WorkflowStep) { // 🔴 Bad: Mutating the event - // This will not be persisted across steps and `event.data` will + // This will not be persisted across steps and `event.payload` will // take on its original value. await step.do("bad step that mutates the incoming event", async () => { - let userData = await env.KV.get(event.user) - event.data = userData + let userData = await env.KV.get(event.payload.user) + event.payload = userData }) // ✅ Good: persist data by returning it as state from your step // Use that state in subsequent steps let userData = await step.do("good step that returns state", async () => { - return await env.KV.get(event.user) + return await env.KV.get(event.payload.user) }) let someOtherData = await step.do("following step that uses that state", async () => { @@ -252,14 +252,15 @@ export class MyWorkflow extends WorkflowEntrypoint { // 🔴 Bad: Naming the step non-deterministically prevents it from being cached // This will cause the step to be re-run if subsequent steps fail. await step.do(`step #1 running at: ${Date.now()}`, async () => { - let userData = await env.KV.get(event.user) - event.data = userData + let userData = await env.KV.get(event.payload.user) + // Do not mutate event.payload + event.payload = userData }) // ✅ Good: give steps a deterministic name. // Return dynamic values in your state, or log them instead. let state = await step.do("fetch user data from KV", async () => { - let userData = await env.KV.get(event.user) + let userData = await env.KV.get(event.payload.user) console.log(`fetched at ${Date.now}`) return userData }) diff --git a/src/content/docs/workflows/build/sleeping-and-retrying.mdx b/src/content/docs/workflows/build/sleeping-and-retrying.mdx index a8a0f5c351318c3..13f9a90f29ae7b7 100644 --- a/src/content/docs/workflows/build/sleeping-and-retrying.mdx +++ b/src/content/docs/workflows/build/sleeping-and-retrying.mdx @@ -102,8 +102,8 @@ import { NonRetryableError } from 'cloudflare:workflows'; export class MyWorkflow extends WorkflowEntrypoint { async run(event: WorkflowEvent, step: WorkflowStep) { await step.do("some step", async () => { - if !(event.data) { - throw new NonRetryableError("event.data did not contain the expected payload") + if !(event.payload.data) { + throw new NonRetryableError("event.payload.data did not contain the expected payload") } }) } diff --git a/src/content/docs/workflows/get-started/cli-quick-start.mdx b/src/content/docs/workflows/get-started/cli-quick-start.mdx index 1b85f9a464261e6..162a76f3feccce0 100644 --- a/src/content/docs/workflows/get-started/cli-quick-start.mdx +++ b/src/content/docs/workflows/get-started/cli-quick-start.mdx @@ -66,12 +66,11 @@ type Params = { export class MyWorkflow extends WorkflowEntrypoint { async run(event: WorkflowEvent, step: WorkflowStep) { // Can access bindings on `this.env` - // Can access params on `event.params` + // Can access params on `event.payload` const files = await step.do('my first step', async () => { // Fetch a list of files from $SOME_SERVICE return { - inputParams: event, files: [ 'doc_7392_rev3.pdf', 'report_x29_final.pdf', diff --git a/src/content/docs/workflows/get-started/guide.mdx b/src/content/docs/workflows/get-started/guide.mdx index 081e8c660fd959f..d4add4740f0ff43 100644 --- a/src/content/docs/workflows/get-started/guide.mdx +++ b/src/content/docs/workflows/get-started/guide.mdx @@ -67,7 +67,6 @@ export class MyWorkflow extends WorkflowEntrypoint { const files = await step.do('my first step', async () => { // Fetch a list of files from $SOME_SERVICE return { - inputParams: event, files: [ 'doc_7392_rev3.pdf', 'report_x29_final.pdf', @@ -290,12 +289,11 @@ type Params = { export class MyWorkflow extends WorkflowEntrypoint { async run(event: WorkflowEvent, step: WorkflowStep) { // Can access bindings on `this.env` - // Can access params on `event.params` + // Can access params on `event.payload` const files = await step.do('my first step', async () => { // Fetch a list of files from $SOME_SERVICE return { - inputParams: event, files: [ 'doc_7392_rev3.pdf', 'report_x29_final.pdf',