DeepWork is a web application that demonstrates the power of combining OpenAI's Deep Research API with the Hookdeck Event Gateway to support highly reliable and scalable asynchronous workflows and background jobs.

The application enables users to submit complex research questions to OpenAI's Deep Research service, which runs asynchronously in the background. Hookdeck manages both the outbound API requests (via queue) and inbound webhook responses, providing complete visibility into the entire research workflow.

• Asynchronous Research: Submit long-running research tasks to OpenAI without blocking the UI.
• Request Queuing: Outbound requests to OpenAI are queued through Hookdeck for resilience and visibility.
• Reliable Webhooks: Hookdeck ensures reliable delivery of OpenAI's webhook responses.
• Event Timeline: View a detailed timeline of both outbound requests and inbound webhooks for each research task.
• Simple Authentication: A straightforward demo authentication system using NextAuth.js.
• Serverless-first: Built with Next.js and designed for deployment on Vercel.

graph TB
    subgraph "DeepWork Application"
        UI[Next.js Web UI]
        API[Next.js API Routes]
        KV[Vercel KV Store]
    end

    subgraph "Hookdeck Infrastructure"
        subgraph "Connection: openai-queue"
            SourceA[Source A<br/>Queue Endpoint]
            DestA[Destination<br/>OpenAI API]
        end

        subgraph "Connection: openai-webhook"
            SourceB[Source B<br/>Webhook Endpoint]
            DestB[Destination<br/>/api/webhooks/openai]
        end
    end

    subgraph "OpenAI"
        DeepResearch[Deep Research API<br/>Background Mode]
    end

    UI --> API
    API --> KV
    API --> SourceA
    SourceA --> DestA
    DestA --> DeepResearch
    DeepResearch --> SourceB
    SourceB --> DestB
    DestB --> API
    API --> KV

• Node.js (v18 or newer)
• A Hookdeck account and API Key.
• An OpenAI account and API Key.

Clone the repository and install the dependencies:

git clone https://github.com/hookdeck/deepwork.git
cd deepwork
npm install

This project uses a setup script to configure your local environment.

npm run setup:dev

The script will prompt you for your Hookdeck and OpenAI API keys and create a .env.local file with the necessary environment variables.

Once the setup is complete, start the development server:

npm run dev

Open http://localhost:3000 in your browser to see the application.

To receive webhooks from OpenAI locally, you need to use the Hookdeck CLI.

First, log in to your Hookdeck account:

npm run hookdeck:login

Then, start listening for webhooks:

npm run hookdeck:listen

This command forwards webhooks for the openai-webhook source to your local development server. The setup:dev script will have already configured the necessary Hookdeck connections for you.

• npm run dev: Starts the Next.js development server.
• npm run build: Builds the application for production.
• npm run start: Starts a production server.
• npm run lint: Lints the codebase.
• npm run setup:dev: Guides you through setting up your .env.local file.
• npm run hookdeck: Access the Hookdeck CLI.
• npm run hookdeck:login: Log in to your Hookdeck account.
• npm run hookdeck:listen: Start forwarding webhooks to your local server.

This application is designed for deployment on Vercel.

• Configure production environment variables in Vercel.
• Set up a production Vercel KV store.
• Update NEXTAUTH_URL to the production URL.
• Ensure the OpenAI webhook is configured with the production Hookdeck source URL.

To learn more about the technologies used in this project, see the following resources:

• Hookdeck Documentation - learn about Hookdeck's features.
• OpenAI API Documentation - learn about the OpenAI API.
• Next.js Documentation - learn about Next.js features and API.