# Rhombus Developer Documentation

> Official documentation for building on the Rhombus platform: the REST API, real-time webhooks and WebSocket events, and implementation guides for cameras, access control, sensors and alarms.

Every page is also available as Markdown: append `.md` to its URL (the home page is https://developer.rhombus.com/index.md). Spanish guides are under https://developer.rhombus.com/es.

- [Complete documentation in one file](https://developer.rhombus.com/llms-full.txt): every English guide in full, plus one entry per API operation.
- [API reference index](https://developer.rhombus.com/_llms/en/api-reference.md): all 1029 operations, grouped by service.
- [Documentation MCP server](https://developer.rhombus.com/mcp): search and read these docs from any MCP client (Streamable HTTP, no authentication).

## Docs

### Getting Started

- [Introduction](https://developer.rhombus.com/index.md): Integrate Rhombus cameras, access control, sensors, and alarm monitoring with your systems through the Rhombus REST API, webhooks, and real-time WebSocket events.
- [API Regions (US & EU)](https://developer.rhombus.com/api-regions.md): Connect to the right Rhombus API region — US and EU endpoint URLs, region-bound API keys, CLI region configuration, and cross-region troubleshooting.
- [Errors and Status Codes](https://developer.rhombus.com/errors.md): How the Rhombus REST API reports errors: HTTP status codes, the error body and its errorCode, authentication and permission errors, the error field on 200 responses, validation and JSON errors, server errors, and which failures to retry.
- [Pagination and Time Ranges](https://developer.rhombus.com/pagination.md): How Rhombus list operations return results in pages: lastEvaluatedKey cursors, page tokens, timestamp cursors and time windows, with loops in Python and JavaScript and the pitfalls that cause missed or duplicated results.
- [Rate Limits](https://developer.rhombus.com/rate-limits.md): Understand Rhombus API rate limits and build resilient integrations that handle 429 throttled responses with exponential backoff and retry logic.
- [Versioning and Deprecation](https://developer.rhombus.com/versioning.md): How the Rhombus REST API changes over time: new operation versions such as spliceV3, deprecated operations and their replacements, Deprecation and Sunset headers, changes made without a new version, and how to write clients that keep working.
- [Security and Trust](https://developer.rhombus.com/security.md): How Rhombus secures its developer platform and what your integration is responsible for: reporting vulnerabilities, compliance, data residency, transport security, network endpoints and ports, and a security checklist for integrations.

### Authentication

- [Authentication](https://developer.rhombus.com/authentication.md): How to authenticate every kind of Rhombus request: which credential to use for REST, media and video, the event WebSocket and cameras on your network, where each one goes, partner credentials, and how to read 401, 403 and 429 responses.
- [API Keys and Certificates](https://developer.rhombus.com/authentication/api-keys.md): Create a Rhombus API key, choose its role, call the API with it, and use a certificate (mTLS) key: expiry, creating, rotating and renewing keys with the API, the CSR, and revocation.
- [Sign in with Rhombus](https://developer.rhombus.com/oauth-authentication.md): Add Sign in with Rhombus to your application using OAuth 2.0 with PKCE — register a client, request scopes, handle authorization codes, access tokens and refresh tokens, and call the API with a Bearer token.
- [Partner API Calls](https://developer.rhombus.com/partner-api-calls.md): Make Rhombus API calls as a partner — authenticate with a partner API key, manage your client organizations with partner endpoints, and scope client-level calls to a managed org using the x-auth-org header.
- [Federated Tokens](https://developer.rhombus.com/authentication/federated-tokens.md): Mint short-lived Rhombus federated tokens on your server for browsers, mobile apps, video players and cameras on your LAN: fields, scoping with deviceUUid and domain, where to send them, lifetime, refresh and revocation.
- [Authenticate Media and Streams](https://developer.rhombus.com/authentication/media.md): How to authenticate Rhombus snapshots, exact frames, clip downloads, live and recorded HLS, DASH and WebSocket streams, shared stream links and LAN streams, from servers, native apps and browsers.
- [WebSocket Authentication](https://developer.rhombus.com/websocket/authentication.md): Authenticate the Rhombus event WebSocket: which credentials it accepts, where they go on the handshake, what a connection can see, partner connections, revocation, and how to read 401, 403 and 429 responses.
- [Permissions and Key Rotation](https://developer.rhombus.com/authentication/permissions.md): Give each Rhombus integration the least access it needs: what each credential inherits, how OAuth scopes limit a user's role, rotating API keys, certificates and OAuth tokens without downtime, and finding your integration's actions in the audit log.

### Solution Guides

- [Show Cameras in Your App](https://developer.rhombus.com/solutions/embed-cameras.md): Put Rhombus camera thumbnails and live video in your own web or mobile app: list cameras on your server, mint short-lived federated tokens for each viewer, load snapshots, and play live video with the React SDK or an HLS player.
- [Build an Event Pipeline](https://developer.rhombus.com/solutions/event-pipeline.md): Get every Rhombus alert into your own systems without gaps: webhooks or the event WebSocket for speed, a reconciliation job over the REST API for completeness, and de-duplication between them.
- [Export Footage for an Investigation](https://developer.rhombus.com/solutions/export-footage.md): End to end: find the alert or moment, request a clip with spliceV3, wait for it to render, download the MP4 from the media host, or share it with a password-protected link. Python and cURL.
- [Monitor Device Health](https://developer.rhombus.com/solutions/device-health.md): Know when Rhombus cameras and sensors go offline or degrade: poll device state lists, receive Diagnostic webhooks, open tickets in your service desk, and report uptime over a period.

### Implementation Guides

#### Cameras

- [Stream Live and Recorded Video from Cameras](https://developer.rhombus.com/implementations/streaming-video.md): Embed live and recorded video from Rhombus cameras in your applications using HLS streams, thumbnails, and shared playback URLs delivered through the API.
- [Video Player Integration](https://developer.rhombus.com/implementations/video-player.md): Build a custom web video player for Rhombus camera streams with HLS live playback, recorded video VOD, scrubbing, and timeline controls using the API.
- [Streaming over LAN](https://developer.rhombus.com/implementations/lan-streaming.md): Authenticate directly to Rhombus cameras and audio gateways on your local network for live video, recorded footage, and two-way audio.
- [LAN Realtime Detection Overlay](https://developer.rhombus.com/implementations/lan-realtime-detection-overlay.md): Parse AI bounding boxes embedded in the LAN H.264 WebSocket stream and render them on top of live video using the Rhombus React SDK or your own client.
- [Multi-Camera Video Synchronization with ISOBMFF](https://developer.rhombus.com/implementations/advanced-implementation.md): Extract Rhombus millisecond timestamps embedded in ISOBMFF video containers to align frames precisely across multiple cameras for forensic analysis.
- [Retrieving Audio from A100 Audio Gateway](https://developer.rhombus.com/implementations/retrieving-audio.md): Download recorded audio from a Rhombus A100 Audio Gateway using the API — fetch DASH MPD manifests, retrieve segments, and play back audio over WAN VOD.
- [EdgeCaster RTSP Gateway](https://developer.rhombus.com/implementations/edgecaster-rtsp.md): Run EdgeCaster on a Raspberry Pi 5 or any Ubuntu/Debian machine to re-broadcast Rhombus camera streams as sub-second-latency RTSP for legacy VMS, NVR, and third-party video systems.

#### Access Control

- [Access Control](https://developer.rhombus.com/implementations/access-control.md): Manage Rhombus access control through the API — list access-controlled doors, remotely unlock, issue and assign credentials, build access groups and grants, and activate lockdown plans.
- [QR Code Access Control](https://developer.rhombus.com/implementations/qr-code-access-control.md): Implement QR code door unlock with Rhombus access control — generate visitor credentials, validate codes, and trigger touchless door entry via the API.

#### Alarm Monitoring

- [Alarm Monitoring](https://developer.rhombus.com/implementations/alarm-monitoring.md): Build alarm monitoring integrations with the Rhombus API — track locations, dispatch responders, and manage threat cases and security alerts in real time.

#### IoT Sensors

- [IoT Sensors](https://developer.rhombus.com/implementations/iot-sensors.md): Read climate data from Rhombus IoT sensors via the API to monitor temperature, humidity, air quality, and environmental conditions across your facilities.

#### Recon

- [Recon Robots](https://developer.rhombus.com/robots/overview.md): What you can build with Recon, the Rhombus security robot, through the API: how maps, waypoints, routes and patrols fit together, the conventions every robot operation shares, and the permissions they need.
- [Monitor Recon Robots](https://developer.rhombus.com/robots/monitor.md): Watch a Recon fleet from your own tools: connection and battery, what each robot is doing and how far along it is, and the history of every activity it ran, from the robot state and event operations.
- [Recon Maps and Waypoints](https://developer.rhombus.com/robots/maps-and-waypoints.md): Work with a Recon robot's map through the API: find the assigned map, draw it with the robot's position and keep-out zones, convert between image pixels and map coordinates, and save waypoints for routes.
- [Recon Routes and Patrols](https://developer.rhombus.com/robots/routes-and-patrols.md): Author the rounds a Recon robot makes: routes as ordered stops with dwell times and arrival actions, and patrols that put a route on a robot and run it on a schedule. Covers creating, changing and deleting both.
- [Dispatch and Track Recon Robots](https://developer.rhombus.com/robots/dispatch.md): Send a Recon robot on a patrol, to a point on its map, or back to its charging pad with the deploy and sendHome operations, then follow the run to its outcome through the robot's state and events.
- [Recon Video and Audio](https://developer.rhombus.com/robots/video-and-audio.md): Stream live and recorded video from each of a Recon robot's cameras, and its live audio: get the stream URLs for every camera with getAllMediaUris, pick the camera you want, and play it like any Rhombus camera.
- [Robot Live Socket](https://developer.rhombus.com/robots/live-socket.md): Drive a Rhombus robot and read its telemetry over a WebSocket: getting the socket URL, frame formats, the commands you send and the telemetry you receive, generated from the robot's AsyncAPI specification.

#### Storage & Backup

- [Backup Footage to Local Storage](https://developer.rhombus.com/implementations/backup-footage-local-storage.md): Download and archive Rhombus camera footage to local storage like NAS or external drives using the API for compliance, retention, and offline access.

#### Identity & Access

- [SAML SSO & SCIM Provisioning](https://developer.rhombus.com/implementations/saml-sso-provisioning.md): Configure SAML single sign-on and SCIM user provisioning for Rhombus via the API — integrate Okta, Azure AD, Google Workspace, OneLogin, and other IdPs.

#### Analytics & AI

- [License Plate Recognition & Vehicles](https://developer.rhombus.com/implementations/lpr-vehicle.md): Query license plate detection events, search plates with fuzzy matching, build a watchlist of saved vehicles, run per-device reports, and export vehicle data as CSV with the Rhombus API.
- [Face Recognition & People Counting](https://developer.rhombus.com/implementations/faces-people-counting.md): Enroll and manage known people, query face-match events, tune the matching threshold, and pull camera people-counting analytics through the Rhombus API.
- [Reports & Analytics](https://developer.rhombus.com/implementations/reports-analytics.md): Pull count and time-series analytics from the Rhombus API — people and vehicle counts, occupancy trends, line-crossing (threshold) counts, and CSV export.

### Real-time Events

#### Webhooks

- [Rhombus Webhooks](https://developer.rhombus.com/webhooks.md): Configure Rhombus webhooks to receive real-time HTTP POST notifications for camera alerts, door events, sensor thresholds, and button presses without polling.
- [Webhook Receivers](https://developer.rhombus.com/implementations/webhook-listener.md): Build an endpoint that receives Rhombus webhooks safely: verify signatures on the raw body, answer quickly and queue the work, reach systems on a private network without opening it to the internet, and test locally.

#### WebSocket

- [WebSocket Overview](https://developer.rhombus.com/websocket/overview.md): Stream real-time security events from Rhombus over WebSocket and STOMP — receive policy alerts, device updates, and activity instantly without polling the API.
- [WebSocket Event Monitoring and Filtering](https://developer.rhombus.com/websocket/event-monitoring.md): Subscribe to real-time WebSocket events from Rhombus — filter and process policy alerts, device state changes, motion detection, and access control events.
- [WebSocket Event Reference](https://developer.rhombus.com/websocket/event-reference.md): Every message on the Rhombus event WebSocket's change destination: the envelope, policy alert changes, other entity changes, STOMP headers, change types and delivery guarantees, generated from the AsyncAPI specification.
- [WebSocket Connection Lifecycle](https://developer.rhombus.com/websocket/connection-lifecycle.md): Manage the full lifecycle of a Rhombus WebSocket connection — perform STOMP handshakes, send heartbeats, handle reconnections, and close gracefully.
- [STOMP Protocol Reference](https://developer.rhombus.com/websocket/stomp-protocol.md): Reference for the STOMP 1.2 messaging protocol used by Rhombus WebSocket — frame structure, headers, CONNECT, SUBSCRIBE, MESSAGE, and ERROR command details.
- [WebSocket Code Examples in Python, JavaScript, Go](https://developer.rhombus.com/websocket/code-examples.md): Production-ready Python, JavaScript, and Go code examples for connecting to Rhombus WebSocket — handle STOMP, authentication, heartbeats, and reconnection.
- [WebSocket Troubleshooting](https://developer.rhombus.com/websocket/troubleshooting.md): Diagnose and resolve common Rhombus WebSocket issues — connection failures, STOMP errors, missed heartbeats, authentication problems, and dropped events.

### Tools & SDKs

- [Tools and SDKs](https://developer.rhombus.com/resources.md): The Rhombus CLI, the React SDK, MCP servers for AI assistants, Claude Code plugins, no-code connectors, and the OpenAPI specification for generating clients.
- [Rhombus CLI](https://developer.rhombus.com/rhombus-cli.md): Manage cameras, doors, alerts, sensors, and your entire Rhombus deployment from the command line — stitch video, monitor alerts, and chat with AI tooling.
- [React SDK](https://developer.rhombus.com/implementations/react-sdk.md): Embed Rhombus camera streams in React applications with the official SDK, featuring DASH buffered playback and real-time H.264 WebSocket players via WebCodecs.

#### AI & LLMs

- [Documentation MCP](https://developer.rhombus.com/documentation-mcp.md): Connect Claude, Cursor, VS Code, and other AI tools directly to Rhombus API documentation using the Model Context Protocol (MCP) server.
- [Rhombus API MCP Server](https://developer.rhombus.com/rhombus-mcp.md): Give Claude and other AI assistants direct access to your Rhombus cameras, doors, sensors, and alerts through the Model Context Protocol (MCP) Node.js server.
- [Claude Code Plugins](https://developer.rhombus.com/claude-code-plugins.md): Install Rhombus skills, sub-agents, and hooks for Claude Code to build integrations, manage devices, and monitor alerts from your terminal.

#### Low Code / No Code

- [Integrate with Zapier](https://developer.rhombus.com/low-code-no-code/zapier.md): Connect Rhombus to thousands of apps with the native Zapier integration — build event-driven automations for camera alerts, doors, and sensors without code.
- [Integrate with Make.com](https://developer.rhombus.com/low-code-no-code/make.md): Automate Rhombus security workflows with Make.com's visual no-code platform — connect cameras, doors, and sensors to thousands of apps without writing code.
- [Integrate with n8n](https://developer.rhombus.com/low-code-no-code/n8n.md): Automate Rhombus security workflows in self-hosted n8n with the official community node — orchestrate cameras, access control, IoT sensors, and AI agents.

## API Reference

### Overview

- [API Reference](https://developer.rhombus.com/api-reference/overview.md): Complete REST API reference covering 1,000+ Rhombus endpoints for cameras, access control, sensors, alarms, video streaming, and analytics.

## Changelog

- [Changelog](https://developer.rhombus.com/changelog.md): Release notes for the Rhombus API — track new endpoints, breaking changes, deprecations, SDK updates, and platform improvements over time.

### API services

- [Access Control Webservice (65 operations)](https://developer.rhombus.com/_llms/en/api-reference/access-control-webservice.md)
- [Lockdown Plan Webservice (17 operations)](https://developer.rhombus.com/_llms/en/api-reference/lockdown-plan-webservice.md)
- [Alert Monitoring Webservice (11 operations)](https://developer.rhombus.com/_llms/en/api-reference/alert-monitoring-webservice.md)
- [AudioGateway Webservice (10 operations)](https://developer.rhombus.com/_llms/en/api-reference/audiogateway-webservice.md)
- [AudioPlayback Webservice (6 operations)](https://developer.rhombus.com/_llms/en/api-reference/audioplayback-webservice.md)
- [Badge Reader Webservice (2 operations)](https://developer.rhombus.com/_llms/en/api-reference/badge-reader-webservice.md)
- [BLE Webservice (1 operation)](https://developer.rhombus.com/_llms/en/api-reference/ble-webservice.md)
- [Button Webservice (8 operations)](https://developer.rhombus.com/_llms/en/api-reference/button-webservice.md)
- [Camera Webservice (61 operations)](https://developer.rhombus.com/_llms/en/api-reference/camera-webservice.md)
- [Climate Webservice (12 operations)](https://developer.rhombus.com/_llms/en/api-reference/climate-webservice.md)
- [Component Webservice (63 operations)](https://developer.rhombus.com/_llms/en/api-reference/component-webservice.md)
- [Elevator Webservice (6 operations)](https://developer.rhombus.com/_llms/en/api-reference/elevator-webservice.md)
- [Customer Webservice (5 operations)](https://developer.rhombus.com/_llms/en/api-reference/customer-webservice.md)
- [User Webservice (12 operations)](https://developer.rhombus.com/_llms/en/api-reference/user-webservice.md)
- [Developer Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/developer-webservice.md)
- [Device Config Webservice (2 operations)](https://developer.rhombus.com/_llms/en/api-reference/device-config-webservice.md)
- [Door Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/door-webservice.md)
- [Doorbell Camera Webservice (25 operations)](https://developer.rhombus.com/_llms/en/api-reference/doorbell-camera-webservice.md)
- [Doorbell Webservice (2 operations)](https://developer.rhombus.com/_llms/en/api-reference/doorbell-webservice.md)
- [Door Controller Webservice (2 operations)](https://developer.rhombus.com/_llms/en/api-reference/door-controller-webservice.md)
- [Event Webservice (42 operations)](https://developer.rhombus.com/_llms/en/api-reference/event-webservice.md)
- [Event Search Webservice (2 operations)](https://developer.rhombus.com/_llms/en/api-reference/event-search-webservice.md)
- [Export Webservice (15 operations)](https://developer.rhombus.com/_llms/en/api-reference/export-webservice.md)
- [Face Recognition Event Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/face-recognition-event-webservice.md)
- [Face Recognition Matchmaker Webservice (9 operations)](https://developer.rhombus.com/_llms/en/api-reference/face-recognition-matchmaker-webservice.md)
- [Face Recognition Person Webservice (8 operations)](https://developer.rhombus.com/_llms/en/api-reference/face-recognition-person-webservice.md)
- [Feature Webservice (5 operations)](https://developer.rhombus.com/_llms/en/api-reference/feature-webservice.md)
- [Help Webservice (7 operations)](https://developer.rhombus.com/_llms/en/api-reference/help-webservice.md)
- [IoT Integrations Webservice (12 operations)](https://developer.rhombus.com/_llms/en/api-reference/iot-integrations-webservice.md)
- [Access Control Integrations Webservice (101 operations)](https://developer.rhombus.com/_llms/en/api-reference/access-control-integrations-webservice.md)
- [Integrations Webservice (31 operations)](https://developer.rhombus.com/_llms/en/api-reference/integrations-webservice.md)
- [Incident Management Integrations Webservice (35 operations)](https://developer.rhombus.com/_llms/en/api-reference/incident-management-integrations-webservice.md)
- [Org Integrations Webservice (7 operations)](https://developer.rhombus.com/_llms/en/api-reference/org-integrations-webservice.md)
- [Service Management Integrations Webservice (14 operations)](https://developer.rhombus.com/_llms/en/api-reference/service-management-integrations-webservice.md)
- [Storage Integrations Webservice (18 operations)](https://developer.rhombus.com/_llms/en/api-reference/storage-integrations-webservice.md)
- [Webhook Integrations Webservice (7 operations)](https://developer.rhombus.com/_llms/en/api-reference/webhook-integrations-webservice.md)
- [Alarm Monitoring Keypad Webservice (5 operations)](https://developer.rhombus.com/_llms/en/api-reference/alarm-monitoring-keypad-webservice.md)
- [Guest Management Kiosk Webservice (1 operation)](https://developer.rhombus.com/_llms/en/api-reference/guest-management-kiosk-webservice.md)
- [License Webservice (21 operations)](https://developer.rhombus.com/_llms/en/api-reference/license-webservice.md)
- [ClaimKey Webservice (3 operations)](https://developer.rhombus.com/_llms/en/api-reference/claimkey-webservice.md)
- [Location Webservice (15 operations)](https://developer.rhombus.com/_llms/en/api-reference/location-webservice.md)
- [Logistics Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/logistics-webservice.md)
- [Media Device Webservice (1 operation)](https://developer.rhombus.com/_llms/en/api-reference/media-device-webservice.md)
- [OAuth Webservice (6 operations)](https://developer.rhombus.com/_llms/en/api-reference/oauth-webservice.md)
- [Occupancy Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/occupancy-webservice.md)
- [Org Webservice (49 operations)](https://developer.rhombus.com/_llms/en/api-reference/org-webservice.md)
- [Partner Webservice (35 operations)](https://developer.rhombus.com/_llms/en/api-reference/partner-webservice.md)
- [Permission Webservice (10 operations)](https://developer.rhombus.com/_llms/en/api-reference/permission-webservice.md)
- [Policy Webservice (54 operations)](https://developer.rhombus.com/_llms/en/api-reference/policy-webservice.md)
- [Proximity Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/proximity-webservice.md)
- [RapidSOS Webservice (1 operation)](https://developer.rhombus.com/_llms/en/api-reference/rapidsos-webservice.md)
- [Relay Webservice (27 operations)](https://developer.rhombus.com/_llms/en/api-reference/relay-webservice.md)
- [Report Webservice (25 operations)](https://developer.rhombus.com/_llms/en/api-reference/report-webservice.md)
- [Rules Webservice (10 operations)](https://developer.rhombus.com/_llms/en/api-reference/rules-webservice.md)
- [Rules Records Webservice (3 operations)](https://developer.rhombus.com/_llms/en/api-reference/rules-records-webservice.md)
- [Scene Query Webservice (9 operations)](https://developer.rhombus.com/_llms/en/api-reference/scene-query-webservice.md)
- [Schedule Webservice (12 operations)](https://developer.rhombus.com/_llms/en/api-reference/schedule-webservice.md)
- [Search Webservice (4 operations)](https://developer.rhombus.com/_llms/en/api-reference/search-webservice.md)
- [Sensor Webservice (3 operations)](https://developer.rhombus.com/_llms/en/api-reference/sensor-webservice.md)
- [TvOs Config Webservice (3 operations)](https://developer.rhombus.com/_llms/en/api-reference/tvos-config-webservice.md)
- [Upload Webservice (8 operations)](https://developer.rhombus.com/_llms/en/api-reference/upload-webservice.md)
- [User Metadata Webservice (8 operations)](https://developer.rhombus.com/_llms/en/api-reference/user-metadata-webservice.md)
- [Vehicle Webservice (12 operations)](https://developer.rhombus.com/_llms/en/api-reference/vehicle-webservice.md)
- [Video Webservice (22 operations)](https://developer.rhombus.com/_llms/en/api-reference/video-webservice.md)
- [Robot Webservice (35 operations)](https://developer.rhombus.com/_llms/en/api-reference/robot-webservice.md)

## Specifications

- [OpenAPI 3.0 specification](https://api2.rhombussystems.com/api/openapi/public.json): every REST operation, request and response schema.
- [AsyncAPI 3.0 specification](https://developer.rhombus.com/rhombus_asyncapi.json): WebSocket (STOMP) real-time events.

## Other languages

- [Español (61 guides)](https://developer.rhombus.com/_llms/es.md): the guides in Spanish.