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. The apps list page has two tabs: Public Apps and Private Apps. Select Public Apps or Private Apps tab according to the type of app you want to create and click Create New App.
The initial creation screen has three sections: App name, App type, and API scopes.
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.
App Type
Choose who can access your app. The app type determines the certification path and how much Appstore metadata you need to provide.
| Option | Description |
|---|---|
| Public app (default) | Build an app for the Ring Appstore available to all Ring customers. Requires full certification. |
| Private app | Create a private integration exclusively for personal use or testing. |
Both app types follow the same steps for API scopes, app credentials, and account linking. They differ in certification and in the App Information page — private apps only provide a name and an optional icon, since they aren't listed in the Appstore. See App Information for Private Apps.
API Scopes
Scopes define the data your app can access and the devices users can connect to. You must select at least one scope for your app to function.
Scopes are organized into four groups. The first three are configurable; the fourth is always granted.
Cameras and Doorbells
Requests access to Ring camera and doorbell monitoring capabilities, on all Ring camera and doorbell models. This group is toggled as a whole — individual capabilities cannot be selected separately.
| Capability | What it covers |
|---|---|
| Motion Events | Receive events when a camera or doorbell detects motion. |
| Doorbell press events | Receive events when a doorbell button is pressed. |
| Livestream | Start and view a live video stream from a device. |
| Video Download | Download recorded video from a device. |
Sensors
Requests access to Ring sensor monitoring capabilities. Each sensor type is toggled individually, so you can request only the ones your app needs.
| Sensor | What it covers |
|---|---|
| Contact Sensors (Indoor & Outdoor) | Door/window open/close and tamper alerts. |
| Flood/Freeze Sensors | Water detection and freeze alerts. |
| Temperature & Humidity Sensors | Track temperature and humidity levels and alerts. |
| Air Quality Monitors | Track temperature, CO, humidity, and particulate matter. |
Chimes
Requests access to Ring Chime monitoring and control capabilities, on Ring Chime and Ring Chime Pro.
| Capability | What it covers |
|---|---|
| Chime device state and settings | Receive events when chime device state or settings change. Granted with the group. |
| Chime Controls | Play and change chime audio, ring tones, snoozes, and audio settings. Selectable after you enable the group. |
Account and Lifecycle
These event scopes are always available to apps; no configuration is required to enable them.
| Scope | What it covers |
|---|---|
| Integration status | Receive events when a user interacts with the app integration. |
| Device addition and removal | Receive events when a device is added or removed from a user's Ring account. |
| Device statuses | Receive events when a device goes online or offline. |
| Subscription changes | Receive events when a Ring subscription changes: upgrades, downgrades, renewals, cancellations. |
When your selection is complete, click Create New App at the bottom right, or Cancel to go back.
Confirming App Creation
Clicking Create New App opens the Confirm to create new app dialog, which summarizes what you're about to create so you can review it before committing.
The dialog shows your internal app name and a Selected API scopes summary. Each enabled group is listed, and groups with individually selectable items show exactly which ones you picked — for example, Sensors — Additionally selected: Contact Sensors (Indoor & Outdoor), Flood/Freeze Sensors or Chimes — Additionally selected: Chime Controls.
Under Compliance requirements, review and accept Ring's security and privacy standards by checking:
☐ I agree to the Ring Appstore Schedule to the Amazon Developer Services Agreement
See the Ring Appstore Schedule to the Amazon Developer Services Agreement for the full terms. Click Confirm to create the app, or Go back to revise your scope selections.
App Credentials
After confirmation, the portal shows Your '{app name}' app draft is ready — you can now configure settings and test your app. The page displays your app credentials, which your app needs to access the Ring API. 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 only shown once and cannot be retrieved later. Copy them now and store them securely. If you need new credentials in the future, contact support.
Then check the box confirming you've saved your credentials:
☐ I've saved my app credentials and understand they won't be shown again.
Continue to App stays disabled until this box is checked. Once checked, 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 three sub-sections:
- Data access and API scopes — already complete, since you selected your scopes during app creation. Revisit it to review what your app requested.
- App information for Appstore listing — defines how your app appears in the Ring Appstore.
- Account linking for staging and production — sets up OAuth endpoints for both environments.
App information and Account linking show a "Pending" status until completed.
App Information
Click App information from the Configure section. What this page contains depends on your app type: public apps fill in a full Appstore listing across four tabs, while private apps provide only a name and an optional icon.
App Information for Public Apps
This information appears in the Ring Appstore. The page is organized into four tabs, and 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. | Up to 50 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/JPG, 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. | Multi-select dropdown, 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 500 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 50 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 600 characters. |
Under URLs, add the external links where users can find support and legal information about your app:
| Field | Example |
|---|---|
| Website | https://www.your-app.com/ |
| Support | https://www.your-app.com/support/ |
| Privacy policy | https://www.your-app.com/privacy/ |
| Terms of Service | https://www.your-app.com/terms/ |
Click Save additional information.
App Information for Private Apps
Private apps aren't listed in the Ring Appstore, so this page has no tabs and only two fields. The information appears in My Ring Apps, visible only to connected accounts.
| Field | Description | Constraints |
|---|---|---|
| App name | The name for your app. | Up to 40 characters. |
| Icon (optional) | A square, high-resolution image used as the app icon. | 1024×1024 px PNG/JPEG, max 2 MB. |
The icon field uses a Choose file control and, once uploaded, shows the file name, size, and upload timestamp.
Click Save to store the values, or Cancel to discard changes.
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. On the Production tab, check Copy from staging settings to reuse the values you already entered for staging. The required URLs 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.
Default Redirect URL
A single link that handles routing for all users after linking — typically your web app or a smart routing link. Ring falls back to this URL when no platform-specific app link applies.
iOS App Link (optional)
An iOS Universal Link or smart link that opens your app directly. This is the preferred way to hand users off to a native iOS experience. If you don't have one, provide your Apple App Store URL instead.
Android App Link (optional)
An Android App Link or smart link that opens your app directly. As with iOS, this is preferred over a store URL. If you don't have one, provide your Google Play Store URL instead.
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.
Related topics
- Getting Started with Ring Developer Experience — Registration, lifecycle overview, and key terminology
- Ring API Development Guide — Development lifecycle, testing process, and code snippets
- Certify Your Ring Application — Certification process and submission guide
- Ring Appstore Program Requirements — Terms and requirements for the Ring Appstore Program
