Skip to main content

Documentation Index

Fetch the complete documentation index at: https://upstash.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

GitHub Repository

You can find the project source code on GitHub.

Deploy With Cloudflare Workers

Deploy the project to Cloudflare Workers with a single click.
This guide provides detailed, step-by-step instructions on how to use and deploy Upstash Workflow with Cloudflare Workers. You can also explore our Cloudflare Workers example or Hono.js Cloudflare Workers example for detailed, end-to-end examples and best practices.

​
Prerequisites

  1. An Upstash QStash API key.
  2. Node.js and npm (another package manager) installed.
If you haven’t obtained your QStash API key yet, you can do so by signing up for an Upstash account and navigating to your QStash dashboard.

​
Step 1: Installation

First, install the Workflow SDK in your worker project: 
npm install @upstash/workflow

​
Step 2: Configure Environment Variables

Create a .dev.vars file in your project root and add your QStash token. This key is used to authenticate your application with the QStash service.
Terminal
touch .dev.vars
Upstash Workflow is powered by QStash, which requires access to your endpoint to execute workflows. When your app is deployed, QStash will use the app’s URL. However, for local development, you have two main options: use a local QStash server or set up a local tunnel.

​
Option 1: Local QStash Server

To start the local QStash server, run: 
npx @upstash/qstash-cli dev
Once the command runs successfully, you’ll see QSTASH_URL and QSTASH_TOKEN values in the console. Add these values to your .dev.vars file:
.dev.vars
QSTASH_URL="http://127.0.0.1:8080"
QSTASH_TOKEN="<QSTASH_TOKEN>"
This approach allows you to test workflows locally without affecting your billing. However, runs won’t be logged in the Upstash Console.

​
Option 2: Local Tunnel

Alternatively, you can set up a local tunnel. For this option:
  1. Copy the QSTASH_TOKEN from the Upstash Console.
  2. Update your .dev.vars file with the following:
.dev.vars
QSTASH_TOKEN="***"
UPSTASH_WORKFLOW_URL="<UPSTASH_WORKFLOW_URL>"
  • Replace *** with your actual QStash token.
  • Set UPSTASH_WORKFLOW_URL to the public URL provided by your local tunnel.
Here’s where you can find your QStash token:
Using a local tunnel connects your endpoint to the production QStash, enabling you to view workflow logs in the Upstash Console.

​
Step 3: Create a Workflow Endpoint

A workflow endpoint allows you to define a set of steps that, together, make up a workflow. Each step contains a piece of business logic that is automatically retried on failure, with easy monitoring via our visual workflow dashboard. To define a workflow endpoint with Cloudflare Workers, navigate into your workers entrypoint file (usually src/index.ts) and add the following code:
src/index.ts
import { serve } from "@upstash/workflow/cloudflare"

interface Env {
  ENVIRONMENT: "development" | "production"
}

export default serve<{ text: string }>(
  async (context) => {
    const initialPayload = context.requestPayload.text

    const result = await context.run("initial-step", async () => {
        console.log(`Step 1 running with payload: ${initialPayload}`)

        return { text: "initial step ran" }
      }
    )

    await context.run("second-step", async () => {
      console.log(`Step 2 running with result from step 1: ${result.text}`)
    })
  }
)

​
Step 4: Run the Workflow Endpoint

To start your worker locally, run the following command:
Terminal
npm run wrangler dev
Executing this command prints a local URL to your workflow endpoint. By default, this URL is http://localhost:8787. You can verify your correct environment variable setup by checking the wrangler output, which should now have access to your QSTASH_TOKEN binding and log your local URL:
Then, make a POST request to your workflow endpoint. For each workflow run, a unique workflow run ID is returned:
Terminal
curl -X POST https://localhost:8787/ -D '{"text": "hello world!"}'

# result: {"workflowRunId":"wfr_xxxxxx"}
See the documentation on starting a workflow for other ways you can start your workflow. If you didn’t set up local QStash development server, you can use this ID to track the workflow run and see its status in your QStash workflow dashboard. All steps are listed with their statuses, headers, and body for a detailed overview of your workflow from start to finish. Click on a step to see its detailed logs.

​
Step 5: Deploying to Production

When deploying your Cloudflare Worker with Upstash Workflow to production, there are a few key points to keep in mind:
  1. Environment Variables: Make sure that all necessary environment variables from your .dev.vars file are set in your Cloudflare Worker project settings. For example, your QSTASH_TOKEN, ENVIRONMENT, and any other configuration variables your workflow might need.
  2. Remove Local Development Settings: In your production code, you can remove or conditionally exclude any local development settings. For example, if you used local tunnel for local development
  3. Deployment: Deploy your Cloudflare Worker to production as you normally would, for example using the Cloudflare CLI:
    Terminal
    wrangler deploy
  4. Verify Workflow Endpoint: After deployment, verify that your workflow endpoint is accessible by making a POST request to your production URL:
    Terminal
    curl -X POST https://<YOUR-PRODUCTION-URL>/ -D '{"text": "hello world!"}'
  5. Monitor in QStash Dashboard: Use the QStash dashboard to monitor your production workflows. You can track workflow runs, view step statuses, and access detailed logs.
  6. Set Up Alerts: Consider setting up alerts in Sentry or other monitoring tools to be notified of any workflow failures in production.

​
Next Steps

  1. Learn how to protect your workflow endpoint from unauthorized access by securing your workflow endpoint.
  2. Explore the source code for a detailed, end-to-end example and best practices.
  3. For setting up and testing your workflows in a local environment, check out our local development guide.