[GH-ISSUE #23] Workflows reference: event.params should be event.payload #7

New issue

Open

opened 2026-03-02 03:21:11 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 03:21:11 +03:00

Owner

Originally created by @FredKSchott on GitHub (Feb 18, 2026).
Original GitHub issue: https://github.com/cloudflare/skills/issues/23

Multiple files in the workflows reference use event.params to access workflow event data, but the actual WorkflowEvent<T> type from cloudflare:workers uses event.payload.

From the runtime type definition:

export type WorkflowEvent<T> = {
    payload: Readonly<T>;
    timestamp: Date;
    instanceId: string;
};

Affected files (non-exhaustive):

references/workflows/api.md — e.g. event.params.paymentMethod, event.params.userId
references/workflows/patterns.md — e.g. event.params.imageKey, event.params.email, event.params.sourceUrl
references/workflows/gotchas.md — best practices mention event.payload in one place but the rest of the docs consistently use event.params

All instances of event.params in workflow code examples should be event.payload.

Source: cloudflare:workers type definitions and https://developers.cloudflare.com/workflows/build/events-and-parameters/

Originally created by @FredKSchott on GitHub (Feb 18, 2026). Original GitHub issue: https://github.com/cloudflare/skills/issues/23 Multiple files in the workflows reference use `event.params` to access workflow event data, but the actual `WorkflowEvent<T>` type from `cloudflare:workers` uses `event.payload`. From the runtime type definition: ```typescript export type WorkflowEvent<T> = { payload: Readonly<T>; timestamp: Date; instanceId: string; }; ``` Affected files (non-exhaustive): - `references/workflows/api.md` — e.g. `event.params.paymentMethod`, `event.params.userId` - `references/workflows/patterns.md` — e.g. `event.params.imageKey`, `event.params.email`, `event.params.sourceUrl` - `references/workflows/gotchas.md` — best practices mention `event.payload` in one place but the rest of the docs consistently use `event.params` All instances of `event.params` in workflow code examples should be `event.payload`. **Source:** `cloudflare:workers` type definitions and https://developers.cloudflare.com/workflows/build/events-and-parameters/

No labels

pull-request

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/skills#7

No description provided.

Rows
Columns