Ring Partner API Documentation

Overview

Ring provides device capabilities to partners while ensuring a high bar for security, transparency, and control for users. This API enables partners to:

Authenticate users through OAuth 2.0 with one-way account linking
Discover and access Ring devices with proper permissions
Receive real-time notifications for device events
Stream live video content using WebRTC/WHEP protocol
Download historical video clips in MP4 format

Key Features

🔐 Secure Authentication

OAuth 2.0 with account linking ensures user consent and secure token management

📱 Device Discovery

Comprehensive device discovery and configuration through JSON:API specification

🔔 Real-time Notifications

Webhook-based event system for motion detection and device lifecycle events

📹 Video Streaming

WebRTC-based live video with WHEP protocol for low-latency streaming

API Standards

The Ring Partner API follows these standards:

JSON:API Specification for most endpoints
OAuth 2.0 for authentication
WebRTC/WHEP for live video streaming
Standard HTTP for media downloads

Getting Started Steps

Review the Architecture - Understand the end-to-end deployment flow before building.
Authentication Setup - Implement OAuth 2.0 token exchange and one-way account linking with HMAC nonce verification.
Retrieve User Profile - Call the Users API to get the Ring Account ID for nonce matching and event correlation.
Confirm Account Link - Complete the two-step POST + PATCH flow to finalize the integration.
Device Discovery - Discover Ring devices, capabilities, and status through JSON:API.
Webhook Notifications - Set up webhook endpoints to receive real-time device events with HMAC signature verification.
Live Video Streaming - Stream live video from Ring devices using WebRTC/WHEP.
Media Clips - Download historical video clips in MP4 format.