Documentation

Build, operate, and extend Blessed OS.

A release-ready guide for product operators and engineers: setup, core concepts, API surfaces, and workflow examples.

Authentication

Use organization slug, email, password, refresh-token rotation, and HTTP-only cookies for browser sessions.

Telegram

Connect Bot API or userbot accounts, receive webhook updates, create contacts, and reply from Blessed Inbox.

Blessed Flow

Build trigger, condition, and action graphs powered by BullMQ, Outbox events, and realtime notifications.

Governance

Use RBAC, ABAC, module visibility, audit logs, billing limits, and platform-admin controls.

Getting started

Sign in with an organization slug, confirm module visibility, connect Telegram, and create your first pipeline.

  1. Invite users and assign default roles: Owner, Admin, Sales Manager, Operator, or Viewer.
  2. Enable the modules each role should see from Organization Settings.
  3. Connect Telegram Bot API or userbot accounts for inbound and outbound chat workflows.
  4. Use onboarding to choose industry, goals, import sources, and a first Blessed Flow template.

User guide

Blessed OS is organized around live customer work: Dashboard, Contacts, Pipeline, Telegram Inbox, Tasks, Projects, Documents, Analytics, Marketing, Billing, and Blessed Flow.

Telegram message to task
Deal stage to document
Form submission to workflow
Dashboard export to Excel

API reference

POST
/api/v1/auth/login
Create an access session and refresh-token cookie.
GET
/api/v1/contacts
List organization contacts with tenant isolation.
POST
/api/v1/sales/deals
Create a pipeline deal and emit realtime events.
POST
/api/v1/telegram/send
Send outbound Telegram messages through Bot API or userbot.
POST
/api/v1/automation/workflows
Create a Blessed Flow workflow definition.
GET
/api/v1/analytics/dashboards
Load saved dashboards and widgets.
POST
/api/v1/marketing/forms/:id/submit
Accept embedded form submissions and trigger Flow.

OpenAPI

The backend is designed for Swagger/OpenAPI generation from NestJS decorators. The production API root is /api/v1.

Download OpenAPI seed
{
  "openapi": "3.1.0",
  "info": { "title": "Blessed OS API", "version": "1.0.0" },
  "servers": [{ "url": "https://api.blessed.app/api/v1" }]
}

Deployment

Production runs as Docker Compose services: web, api, worker, postgres, mongo, redis, and telegram webhook proxy. Health checks and structured logs are included.