Overview

A workflow’s context is an object provided by the route function. The context object provides:

Workflow APIs – functions for defining workflow steps.
Workflow Run Properties – request payload, request headers, and other metadata.

import { serve } from "@upstash/workflow/nextjs";

export const { POST } = serve(
  // 👇 the workflow context
  async (context) => {
    // ...
  }
);

from fastapi import FastAPI
from upstash_workflow.fastapi import Serve
from upstash_workflow import AsyncWorkflowContext

app = FastAPI()
serve = Serve(app)


@serve.post("/api/example")
async def example(context: AsyncWorkflowContext[str]) -> None: ...

Context Object Properties

object

The request payload passed to the workflow run via trigger() call.

object

The request headers passed to the workflow run via trigger() call.

string

The unique identifier of the current workflow run.

string

The public URL of the workflow endpoint.

string

The URL used for workflow failure callback.If a failure function is defined, this is the same as the workflow’s url.

object

The environment variables available to the workflow.

object

The QStash client instance used by the workflow endpoint.

string[]

The labels attached to the current workflow run, if set in client.trigger. Defaults to an empty array when no label was set.

string | undefined

deprecated

Deprecated. Use labels instead. When a run has multiple labels, this only returns the first one.

Context Object Functions

You can use the functions exposed by context object to define workflow steps.

Getting Started

Core Concepts

Features

Agents

API Reference

Resources

Context Object Properties

Context Object Functions

​Context Object Properties

​Context Object Functions

Context Object Properties

Context Object Functions