For the complete documentation index, see llms-docs.txt or the site index llms.txt. Full docs corpus: llms-full-docs.txt. Prefer the markdown version of this page at /docs/setup/backend/workflow.md. Product capabilities: skill.md. Docs MCP: /docs/mcp. Site MCP: /mcp.

Workflow

Set up, configure, and run the Reloop workflow microservice locally.

Marketing automation — drip campaigns, delays, and multi-step journeys via BullMQ.

Run bun setup once from the monorepo root. Env files come from bun setup / bun env:setup.

Overview

PropertyValue
Directoryapps/backend/workflow
Port8017
Local URLhttps://local.reloop.sh/api/workflow
Swagger UIhttps://local.reloop.sh/api/workflow/openapi
Workbenchhttps://local.reloop.sh/api/workflow/jobs
StackElysiaJS · PostgreSQL · Redis · NATS · BullMQ

Quick start

bun be:workflow:dev

Or bun backend:dev / bun dev.

Environment

apps/backend/workflow/.env — from bun setup / bun env:setup.

PG_URL=postgresql://reloop:reloop123@localhost:5432/reloop
REDIS_URL=redis://:reloop123@localhost:6379
PORT=8017
BASE_URL="https://local.reloop.sh"
NATS_URL=nats://localhost:4222
NODE_ENV=development
# Optional basic-auth for Workbench (/api/workflow/jobs)
# WORKBENCH_USER=admin
# WORKBENCH_PASS=secret
VariableRequiredDefault
PG_URLYESpostgresql://...
REDIS_URLYESredis://...
PORTYES8017
BASE_URLYEShttps://local.reloop.sh
NATS_URLYESnats://localhost:4222
WORKBENCH_USERNoempty (open in dev)
WORKBENCH_PASSNoempty (open in dev)

Commands

CommandDescription
bun be:workflow:devStart dev server with hot reloading
bun run --filter=be-workflow buildCompile production bundle
bun run --filter=be-workflow startRun compiled production build
bun run --filter=be-workflow check-typesTypeScript type-check

Architecture

LayerDetail
TriggersNATS events (e.g. contacts.created) start automation journeys
ExecutionBullMQ workflow-queue handles delayed steps and transitions
IntegrationsReads contacts/templates and triggers sends via mail
MonitoringWorkbench UI at /api/workflow/jobs

Next

Was this page helpful?

Edit this page