Create and Configure Your App
Configure Phase
The Configure phase is where you create your app, receive your API credentials, and fill in all the metadata that defines how your app appears and behaves in the Ring Appstore.
Creating a New App
Navigate to the Ring developer console and click Create New App.
The creation screen has three sections:
App Name
Enter an internal app name (e.g., Home Guardian). This is not the public-facing name — the name displayed in the Appstore is set separately in App Information.
API Access
A read-only summary of the Ring APIs your app credentials will grant access to. All apps receive the same standard set:
| Live Video & Media | Device Management | Configuration & Settings |
|---|---|---|
| Live video streaming from Ring devices | Metadata and information | Device location information |
| MP4 video downloads and clips | Capabilities and features | Device configuration settings |
| Image Download | Status (online/offline) |
Custom API scopes are not yet available. All apps receive access to the standard APIs listed above.
Compliance Requirements
Check the box to agree to the Ring Appstore Schedule to the Amazon Developer Services Agreement. This is required before you can proceed.
Click Create New App to finalize, or Cancel to go back.
App Credentials
Immediately after creation, the portal displays your app credentials. This is the only time these values are shown in plain text.
Three credentials are provided:
- Client ID — A unique identifier for your app, used in OAuth 2.0 token requests to the Ring API. You'll include this in authorization and token exchange calls.
- Client Secret — A confidential key paired with your Client ID to authenticate token requests. Treat this like a password — it should only live on your backend, never in client-side code.
- HMAC Signature Key — A secret key used for nonce validation during one-way-account linking and to verify webhook signatures from Ring. When Ring sends webhook events to your endpoint, the payload includes an HMAC signature you can validate against this key to confirm authenticity.
Each credential has a Copy button. You can also click Download CSV to export all three at once.
These credentials are shown once and cannot be retrieved later. Copy or download them now and store them securely. If you lose them, contact support for reissuance.
Check the box confirming you've saved your credentials. Then choose:
- Open App list — return to the apps list.
- Continue to App — go directly to the app overview page.
App Overview
The overview page shows the five lifecycle steps for your app: Configure, Build, Test, Certify, and Publish. Steps 3–5 are locked until earlier steps are complete.
A three-dot menu in the upper-right corner provides two options: Rename to change the internal app name, and Delete to permanently remove the app. You can rename or delete an app only if it has not been published yet.
Under Configure, there are two sub-sections to complete:
- App information — defines how your app appears in the Ring Appstore.
- Account linking — sets up OAuth endpoints for staging and production environments.
Both show a "Pending" status until completed.
App Information
Click App information from the Configure section. The App Information page is organized into four tabs. Each tab has its own save button — fill in the fields and save each tab independently.
For full guidelines, the page links to the App Information Guidelines.
General Tab
This tab controls the core listing details that users see in the Appstore.
| Field | Description | Constraints |
|---|---|---|
| Public name | The name users see in the Appstore. Keep it clear and consistent with your brand. | 7–30 characters, must be unique, standard characters only. |
| Icon | A square, high-resolution image used as the app's main visual identifier. Should look good on both light and dark backgrounds. | 1024×1024 px PNG/JPEG, max 2 MB. |
| Short description | A one-sentence summary for search results and app listings. | Up to 125 characters. |
| Detailed description | Highlight key features, ideal use cases, and setup requirements for new users. | Up to 500 characters. |
| App category | The category that best describes your app. Helps users discover it in the Appstore. | Dropdown, select one or more categories. |
| Latest release | What's new in this version — features, enhancements, bug fixes. Appears in the "Latest release" section on the app details page. | Up to 300 characters. |
Click Save general information.
Media Assets Tab
Upload the visual and video assets for your Appstore listing.
| Asset | Description | Specs |
|---|---|---|
| Appstore main image | Hero image shown in app listings, the app details page, and across Ring. | PNG/JPEG, recommended 1024×1024 px, max 2 MB. |
| Additional images | Screenshots or images highlighting key functionality. | 1–5 images, PNG/JPEG, recommended 1024×1024 px, max 2 MB each. |
| Video (optional) | A short clip highlighting the user experience or setup guide. | MP4, up to 30 seconds, minimum 720p, max 5 MB. |
| Video thumbnail (optional) | Preview image for the video on the app details page. | PNG/JPEG, recommended 1024×1024 px, max 2 MB. |
Click Save media assets.
Compatibility Tab
Defines the technical scope and device compatibility of your app. These values are used for Appstore filtering.
| Field | Description | Format |
|---|---|---|
| Features | Key features and capabilities in bullet-point form. Appears in the "What's new" section on the app details page. | Free text, up to 400 characters. |
| Requirements | Technical requirements such as device dependencies, platforms supported, subscriptions needed, or connectivity requirements. | Free text, up to 500 characters. |
| Customer types | Target Ring customer segments. Used for Appstore filtering. | Multi-select dropdown. |
| Supported devices | Specific Ring devices, cameras, or hardware generations your app is fully compatible with. | Multi-select dropdown. |
| Camera types | Specific Ring camera types your app targets. Used for Appstore filtering. | Multi-select dropdown. |
Click Save compatibility information.
Additional Tab
Developer and legal information displayed on the app details page.
| Field | Description |
|---|---|
| Developer info | Public name of your company or organization. Appears in the "Developer info" section on the app details page. Up to 400 characters. |
| Website | Your company or app website URL. |
| Support | URL where users can find support for your app. |
| Privacy policy | URL to your privacy policy. |
| Terms of Service | URL to your terms of service. |
Click Save additional information.
Account Linking
Click Account linking from the Configure section. This is where you provide the URLs that Ring uses to authenticate users and communicate with your backend.
The page has two tabs — Staging settings and Production settings — so you can configure each environment independently. All four URLs are required in both environments and must use HTTPS.
Under the Authorization heading, you'll configure:
Account Link URL
The page Ring redirects users to when they initiate account linking from the Ring app. This is your login/authorization page. When a user chooses to connect your app, Ring redirects to this URL in a browser so the user can sign in to your platform and authorize the integration. Your page should authenticate the user and then initiate account linking.
App Homepage URL
The URL Ring redirects users to after the integration is complete. This is your app's landing page where users can manage settings, view status, or interact with your service. It should support both mobile and web if both are available, since users may arrive from either context.
Token Exchange URL
The backend endpoint where Ring sends the OAuth authorization code prior to account linking. This is a server-to-server call — Ring POSTs the authorization code to this URL, and your backend exchanges it for an access token. This endpoint is never seen by the end user; it handles the secure token handshake between Ring and your service.
Webhook URL
Your endpoint for receiving real-time event notifications from Ring. Ring sends POST requests to this URL for events like motion detection, device additions, and device removals. Your endpoint should accept JSON payloads, return an HTTP 200 response promptly, and validate the HMAC signature (using the HMAC Signature Key from your app credentials) to confirm the request originated from Ring.
Click Save staging settings or Save production settings depending on which tab you're configuring. Click Cancel to discard changes.
Once both App Information and Account Linking are complete, the Configure phase is done and you can move on to Build and Test.
