Skip to content

[world-vercel] Switch event endpoints to v4 wire format #2055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
VaguelySerious wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

[world-vercel] Switch event endpoints to v4 wire format #2055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3041ff1
[world-vercel] Add v4 event API client
VaguelySerious May 21, 2026
a0d2ee8
[v4 branch] Point SDK at workflow-server PR #439 preview deployment
VaguelySerious May 21, 2026
963d632
[world-vercel] Switch event endpoints to the v4 wire format
VaguelySerious May 21, 2026
f41239f
Merge remote-tracking branch 'origin/main' into peter/v4
VaguelySerious May 25, 2026
ae8f469
[world-vercel] Consume new v4 GET/LIST event-entity shape; symmetric …
VaguelySerious May 25, 2026
6b731bf
[world-vercel] Consume the v4 GET single-event frame stream
VaguelySerious May 25, 2026
fd68f1b
[world-vercel] Wire listEventsByCorrelationId through to v4 endpoint
VaguelySerious May 25, 2026
681a965
[world-vercel] Send v4 POST body as a single frame, drop x-wf-* reque…
VaguelySerious May 25, 2026
aaa436f
[world-vercel] Stop wrapping already-serialized payload bytes in CBOR
VaguelySerious May 25, 2026
a163a5e
[world-vercel] Read hook token from eventData.token (matches runtime …
VaguelySerious May 25, 2026
a2dac63
[world-vercel] Send resumeAt as a Date in the v4 frame meta
VaguelySerious May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/v4-events-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@workflow/world-vercel": major
Copy link
Copy Markdown
Member Author

@VaguelySerious VaguelySerious May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"@workflow/world-vercel": major
"@workflow/world-vercel": minor

---

Switch the world-vercel adapter's event endpoints from the v2/v3 wire format to v4. Event metadata now rides in `x-wf-*` HTTP headers and payloads stream end-to-end as opaque bytes — no server-side CBOR parse on writes, and no per-event `/refs` round-trip on list responses. POST event response carries the materialized EventResult as a CBOR body. GET single event and LIST events use the same `application/vnd.workflow.v4-frames` binary frame stream; `listEventsByCorrelationId` is wired through too. Public `createWorkflowRunEvent` / `getEvent` / `getWorkflowRunEvents` signatures are unchanged. Requires workflow-server with v4 routes mounted.
Copy link
Copy Markdown
Member Author

@VaguelySerious VaguelySerious May 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Switch the world-vercel adapter's event endpoints from the v2/v3 wire format to v4. Event metadata now rides in `x-wf-*` HTTP headers and payloads stream end-to-end as opaque bytes — no server-side CBOR parse on writes, and no per-event `/refs` round-trip on list responses. POST event response carries the materialized EventResult as a CBOR body. GET single event and LIST events use the same `application/vnd.workflow.v4-frames` binary frame stream; `listEventsByCorrelationId` is wired through too. Public `createWorkflowRunEvent` / `getEvent` / `getWorkflowRunEvents` signatures are unchanged. Requires workflow-server with v4 routes mounted.
New internal API format: separately encode event metadata from user payloads. Eliminates the need for calling separate endpoints for ref resolution, which improves performance especially on longer runs.

Loading
Loading