workflow/docs/api-reference/workflow-nest/index.mdx

Workflow SDK - Build durable, resilient, and observable workflows

---
title: "workflow/nest"
description: NestJS integration for workflow bundling and HTTP routing.
type: overview
summary: Explore the NestJS integration for workflow bundle building and runtime routing.
related:
  - /docs/getting-started/nestjs
---

NestJS integration for Workflow SDK. The `WorkflowModule` builds the workflow bundles on application startup and registers the controller that serves the workflow runtime routes.

<Callout>
NestJS integration is in beta. Both `@nestjs/platform-express` and `@nestjs/platform-fastify` are supported, and deploying to Vercel goes through [`workflow-nest build --vercel`](/docs/getting-started/nestjs#deploy-to-vercel). The same exports are also available from the `@workflow/nest` package.
</Callout>

## Exports

<Cards>
    <Card title="WorkflowModule" href="/docs/api-reference/workflow-nest/workflow-module">
        NestJS module that builds workflow bundles on startup and registers the workflow controller
    </Card>
    <Card title="NestLocalBuilder" href="/docs/api-reference/workflow-nest/nest-local-builder">
        Builder that compiles workflow files into step, workflow, and webhook bundles
    </Card>
    <Card title="WorkflowController" href="/docs/api-reference/workflow-nest/workflow-controller">
        Controller that serves the workflow runtime routes under `.well-known/workflow/v1`
    </Card>
    <Card title="isWorkflowRequest()" href="/docs/api-reference/workflow-nest/is-workflow-request">
        Recognises a workflow request in a guard, so queue deliveries and webhooks are not rejected by your own auth
    </Card>
    <Card title="configureWorkflowController()" href="/docs/api-reference/workflow-nest/configure-workflow-controller">
        Points `WorkflowController` at the directory containing the generated workflow bundles
    </Card>
</Cards>