AutoGineer
Generated banner for Upstash Workflow JS
Generated logo for Upstash Workflow JS

Upstash Workflow JS

UpstashOfficialCreated by Upstash

  • Skill
  • Tool integration
  • Cloud and DevOps
  • MIT
  • Medium risk
Download ZIP

From the author

Work with the @upstash/workflow TypeScript/JavaScript SDK for durable, long-running workflows in serverless functions, multi-step processes that survive timeouts, retries, and restarts (built on QStash). Use when defining a workflow endpoint with serve(), running steps with context.run, sleeping for minutes to days without holding a function open, calling external APIs with context.call, waiting for an external event or webhook, invoking other workflows, configuring retries, failure callbacks, and a DLQ, controlling concurrency, rate, and parallelism, triggering, cancelling, or inspecting runs with the Workflow client, building AI agents and orchestrators, human-in-the-loop approvals, realtime updates, local development with the QStash dev server, adding middleware, or migrating workflows safely. Also use when the user asks for durable execution, step functions, saga or orchestration patterns, background jobs with checkpoints, or long-running tasks on Vercel, Next.js, Cloudflare Workers, or other serverless
— the description by Upstash

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Upstash Workflow SDK enables developers to create reliable, multi-step workflows within serverless environments. By leveraging QStash, it allows functions to survive timeouts, retries, and restarts, effectively managing long-running processes that span minutes or days without keeping the underlying function execution active. It supports complex orchestration patterns, including step-by-step execution, external API calls, event waiting, human-in-the-loop approvals, and sophisticated flow control.

What it does

  • Exposes serverless endpoints for durable workflow execution.
  • Manages multi-step processes that persist across function restarts and timeouts.
  • Provides tools for flow control, including concurrency, rate limiting, and parallelism.
  • Supports advanced patterns like cross-workflow invocation and waiting for external events.
  • Enables local development and testing via the QStash dev server.
  • Facilitates human-in-the-loop workflows and real-time updates.

When to use it

  • When building long-running tasks that exceed standard serverless function execution limits.
  • When implementing saga or orchestration patterns in a distributed system.
  • When you need reliable background jobs with built-in checkpointing and retries.
  • When building AI agents or orchestrators that require stateful, multi-step execution.
  • When integrating human approval steps into automated backend processes.

Advantages

  • Eliminates the need to hold serverless functions open for long durations.
  • Built-in support for retries, failure callbacks, and dead-letter queues.
  • Seamless integration with popular serverless platforms like Vercel and Cloudflare Workers.
  • Simplifies complex state management for asynchronous operations.

Usage examples

“How do I define a basic two-step workflow using the Upstash SDK?”
The agent provides a code snippet using the serve() function and context.run() to define sequential steps that persist across execution.
“How can I trigger a workflow from my existing backend code?”
The agent demonstrates initializing the Workflow Client with a QStash token and using the trigger() method to initiate the workflow URL.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/upstash/upstash-workflow-js/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip upstash-workflow-js.zip -d .agents/skills

Documentation by Upstash

Upstash Workflow SDK

Bundled docs and source

Before writing or debugging SDK code, check node_modules/@upstash/workflow/docs/ for bundled docs and node_modules/@upstash/workflow/src/ for readable TypeScript source. Read and search the relevant files when present; otherwise use the references in this skill.

Quick Start

The Upstash Workflow SDK lets you expose serverless workflow endpoints and run them reliably using QStash under the hood.

Install:

npm install @upstash/workflow

Define a simple workflow endpoint:

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

export const { POST } = serve(async (context) => {
  await context.run("step-1", () => console.log("step 1"));
  await context.run("step-2", () => console.log("step 2"));
});

Trigger it from your backend:

import { Client } from "@upstash/workflow";

const client = new Client({ token: process.env.QSTASH_TOKEN! });
await client.trigger({ url: "https://your-app.com/api/workflow" });

Other Skill Files

These files contain the full documentation. Use them for details, patterns, and advanced behavior.

  • basics:

    • basics/serve – How to expose workflow endpoints.

    • basics/context – Full API for workflow context (steps, waits, webhooks, events, invoke, etc.).

    • basics/client – Using the Workflow client to trigger, cancel, inspect, and notify runs.

  • features:

    • features/invoke – Cross‑workflow invocation.

    • features/reliability – Retries, failure callbacks, and DLQ.

    • features/flow-control – Rate limits, concurrency, and parallelism.

    • features/wait-for-event – Notify and wait-for-event patterns.

    • features/webhooks – Webhook creation and consumption.

  • how to:

    • how-to/local-dev – Local QStash dev server (auto via QSTASH_DEV=true) and tunneling.

    • how-to/realtime – Realtime and human‑in‑the‑loop workflows.

    • how-to/migrations – Migrating workflows safely.

    • how-to/middleware – Adding middleware to workflows.

  • other files:

    • rest-api – Low-level REST endpoints for interacting with QStash/Workflow.

    • troubleshooting – Common debugging and environment issues.

    • agents – Using Workflow with agents, orchestrators, and automation patterns.

Files

basics/client.md

Workflow Client Basics

This skill provides guidance for using the Workflow Client to trigger, cancel, inspect, resume, and manage workflow runs. It focuses on TypeScript usage patterns, argument structures, and common pitfalls.

Core Operations

Triggering Workflow Runs (client.trigger)

Starts one or multiple workflow runs with optional payload, metadata, retry logic, and flow control.

// Single and multiple triggers
const single = await client.trigger({
  url: "https://your-endpoint/workflow", // required
  body: { msg: "hello" }, // optional payload
  headers: { "x-user": "123" }, // optional headers
  workflowRunId: "custom-id", // custom unique identifier
  retries: 3, // retry count for steps
  retryDelay: "1000 * (1 + retried)", // expression-based retry delay
  delay: "10s", // start later
  notBefore: Math.floor(Date.now() / 1000) + 60, // absolute schedule
  label: "my-run", // dashboard filtering
  disableTelemetry: true, // opt‑out telemetry
  flowControl: {
    // concurrency & rate limiting
    key: "user-key",
    rate: 10,
    parallelism: 5,
    period: "10m",
  },
});

const multiple = await client.trigger([
  { url: "https://api/runA", body: { a: 1 } },
  { url: "https://api/runB", retries: 5 },
]);

Pitfalls:

  • workflowRunId must be unique; collisions cause errors.

  • delay is ignored if notBefore is provided.

  • Using url incorrectly (missing protocol or dynamic segments) leads to invalid workflow endpoints.

Canceling Workflow Runs (client.cancel)

Cancel runs by ID, by URL prefix, or all active/pending runs.

await client.cancel({ ids: ["wfr_123", "wfr_456"] });
await client.cancel({ urlStartingWith: "https://your-endpoint.com" });
await client.cancel({ all: true });

  • ids accepts both string and array, but mixing with other filters is not supported.

  • urlStartingWith cancels all descendant paths—use carefully.

Retrieving Logs (client.logs)

Fetch workflow execution logs with filtering and cursor-based pagination.

const { runs, cursor } = await client.logs({
  workflowRunId: "wfr_123", // filter a specific run
  workflowUrl: "https://endpoint", // fetch logs for an endpoint
  state: "RUN_FAILED", // filter by execution state
  count: 50, // limit return size
  workflowCreatedAt: 1700000000, // Unix timestamp
  cursor: undefined, // pagination
});
Notifying Events (client.notify)

Notify workflows paused at context.waitForEvent.

await client.notify({
  eventId: "order-paid",
  eventData: { orderId: 1 }, // delivered to waiting workflow
});

Pitfall: If no workflow is waiting, no error is thrown.

Fetching Waiting Workflows (client.getWaiters)

Retrieve active waiters waiting for a specific event.

const waiters = await client.getWaiters({ eventId: "order-paid" });

This is useful for debugging or coordinating external signals.

Dead Letter Queue (DLQ) Operations

Listing DLQ Messages (client.dlq.list)
const { messages, cursor } = await client.dlq.list({
  cursor,
  count: 20,
  filter: {
    fromDate: Date.now() - 86400000,
    toDate: Date.now(),
    url: "https://your-endpoint.com",
    responseStatus: 500,
  },
});

  • Date fields use Unix ms, not seconds.

Retry Failure Callback (client.dlq.retryFailureFunction)

If a workflow's failureFunction/failureUrl call failed:

await client.dlq.retryFailureFunction({ dlqId: "dlq-123" });
Restarting DLQ Runs (client.dlq.restart)

Restart from the beginning of the workflow.

await client.dlq.restart({
  dlqId: ["dlq-1", "dlq-2"],
  retries: 5,
  flowControl: {
    key: "restart-group",
    parallelism: 10,
  },
});
Resuming DLQ Runs (client.dlq.resume)

Continue from the failed step.

await client.dlq.resume({
  dlqId: "dlq-123",
  retries: 3,
  flowControl: {
    key: "resume-group",
    rate: 5,
  },
});

Common confusion:

  • restart = new run from step 0.

  • resume = same run continues at the failed step.

General Tips for TS Consumers

  • Use flow control when bulk‑triggering or restarting large batches to avoid rate limits.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Node.js

Security

What our scanner noticed· Medium risk

  • Possible data-exfiltration endpoints

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Upstash
Publisher
Upstash (Official)
Source
upstash/skills · skills/upstash-workflow-js · commit 9f9e3e5
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Upstash or Upstash.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download upstash-workflow-js.zip