@workflow-studio/worker

Overview

@workflow-studio/worker is the deployable Node HTTP runtime for Workflow Studio.

It handles:

• API key authentication and scope checks
• deployment uploads and activation
• run triggering and run control
• observability endpoints
• loading the active deployment handlers for flow, step, and webhook

Public routes

Health

• GET /v1/health

Deployments

• POST /v1/deployments
• POST /v1/deployments/:id/activate
• GET /v1/deployments/:id
• GET /v1/deployments/active

Runs

• POST /v1/runs
• GET /v1/runs/:id
• POST /v1/runs/:id/cancel
• POST /v1/runs/resume
• POST /v1/runs/:id/rerun
• POST /v1/runs/:id/wake

Observability

• GET /v1/runs/:id/steps
• GET /v1/runs/:id/hooks
• GET /v1/steps/:id
• GET /v1/hooks/:id
• GET /v1/events
• GET /v1/events/correlation/:id

Webhooks

• POST /v1/webhooks/:provider

Internal routes

These routes are for internal runtime transport.

They require both:

• world:proxy scope
• x-workflow-lane: world-proxy

Routes:

• /v1/world/*
• POST /v1/queue/publish

Runtime helpers

The package exports:

• createWorkflowStudioWorker
• createNodeWorkflowStudioWorkerServer
• startNodeWorkflowStudioWorkerServer

See Deploy Worker for hosting, health checks, diagnostics, and failure handling.