workflowEntrypoint

Creates the HTTP route handler that executes workflow runs. The handler receives queue messages, replays the workflow from its event log, executes steps inline where possible, and suspends when the workflow waits on sleeps or hooks.

Framework adapters (Next.js, Nitro, SvelteKit, etc.) call this for you and mount the result at /.well-known/workflow/v1/flow. You only need it when wiring workflow support into a custom server environment.

import { workflowEntrypoint } from "workflow/runtime";
declare const workflowBundleCode: string; // @setup

const handler = workflowEntrypoint(workflowBundleCode);

// Mount on your server, e.g. a fetch-style route:
export const POST = (req: Request) => handler(req);

API signature

Parameters

ParameterTypeDescription
workflowCodestringThe compiled workflow bundle code containing all workflow functions
options{ namespace?: string }Optional. namespace scopes the queue topics this handler consumes.

Returns

Returns a fetch-style request handler: (req: Request) => Promise<Response>.

  • getWorld(): Resolve the runtime World instance this handler shares with workflow execution.
  • getWorldHandlers(): Access build-time-safe World handlers for framework tooling.
  • healthCheck(): Verify the entrypoint processes queue messages end-to-end.