Build on BeverageOS.

Concepts, references, and recipes for integrating NEXUM into your stack — from REST endpoints to the on-device Edge SDK.

Getting Started

Provision a workspace, invite teammates, register your first site and dispenser in under 10 minutes.

Create your workspace
Add a site
Register a dispenser
Connect telemetry

Authentication

All requests use bearer API keys scoped to a tenant. Manage keys from Dashboard → API Keys.

Create an API key
Send Authorization: Bearer <key>
Rotate on a 90-day schedule

REST API

Public endpoints for telemetry ingestion and alert retrieval.

GET /api/public/v1/dispensers
GET /api/public/v1/alerts
POST telemetry via the Edge SDK

Webhooks

Subscribe to alert and workflow events. Configure endpoints in Dashboard → Webhooks.

alert.created
alert.resolved
workorder.completed

Workflow Engine

Author no-code rules that turn alerts into work orders, tickets, and downstream actions.

Trigger
Conditions
Action: create_work_order | create_support_ticket

Edge SDK

Runs locally on dispenser gateways for sub-second inference, with eventual sync to cloud.

nexum-edge install
Pair with workspace
Stream metrics to cloud

Quickstart

curl https://api.nexum.dev/api/public/v1/dispensers \
  -H "Authorization: Bearer $NEXUM_API_KEY"

# → 200 OK
# {
#   "dispensers": [
#     { "id": "...", "name": "Tap 4", "status": "online", "last_seen_at": "..." }
#   ]
# }