upstash-workflow-js

✓ Official★ 12

by upstash · part of upstash/skills

Skills for the Upstash Workflow TypeScript/JavaScript SDK to define, trigger, and manage workflows. Use this Skill whenever a user wants to create workflow…

🔥🔥🔥✓ VerifiedFreeQuick setup

#automation #git

🧩 One of 7 skills in the upstash/skills package — works on its own, and pairs well with its siblings.

Skills for the Upstash Workflow TypeScript/JavaScript SDK to define, trigger, and manage workflows. Use this Skill whenever a user wants to create workflow…

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.

by upstash

Skills for the Upstash Workflow TypeScript/JavaScript SDK to define, trigger, and manage workflows. Use this Skill whenever a user wants to create workflow… npx skills add https://github.com/upstash/skills --skill upstash-workflow-js Download ZIP GitHub12

Upstash Workflow SDK

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.

Copy & paste — that's it

npm install @upstash/workflow

Run this in your project — your agent picks the skill up automatically.

Quick Start

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

Install:

Copy & paste — that's it

npm install @upstash/workflow

Define a simple workflow endpoint:

Copy & paste — that's it

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:

Copy & paste — that's it

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

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