Documentation
Documentation
Guides and references for building with ARKH Ring
Overview
Turn gestures into magic. With the ARKH Ring, a swipe can skip a track, a tap can trigger a scene, a double-tap can swing an axe. Your server receives these gestures via webhooks—and can respond with haptic feedback.
This documentation covers everything you need to integrate with the ARKH Ring.
Core Concepts
Apps
Your integration with the ring. Users discover and add apps through the widget manager in their companion app. Apps come in three types: Controls, Devices, and Preferred Notifications.
Controls
Apps that live alongside other widgets on the ring. Perfect for media players, smart home remotes, gaming, presentations, or professional tools.
Devices
Apps that bypass RingUI and take full control of the ring. The ring becomes a dedicated input device for your hardware—ideal for VR headsets, AR glasses, desktop computers, or drones.
Preferred Notifications
Apps that buzz the user's ring and request a response — yes/no, an emoji, or dismiss. The user's answer is delivered back to you via webhook, poll, or inline HTTP.
Gestures
7 touch interactions on the ring: 3 taps and 4 swipes. You define what each one does.
Vibes
Haptic feedback you send to the ring. Optionally display a Ring UI notification alongside the haptic for visual confirmation.
How It Works
Ring
Gesture
→
Webhook
Sent
→
Your App
Action
→
Ring
Vibe
- User performs a gesture on their ring
- We send a webhook to your app with gesture details
- Your app processes the event and takes action
- (Optional) Your app sends a vibe back to the ring
Quick Start
Get your first ARKH app running in under 5 minutes. You'll create an app, add it to your ring, and verify gestures are flowing through.
Create App
2 min
Add to Ring
1 min
Test Gestures
1 min
Send Vibe
30 sec
1. Create Your App
Go to the Apps page and click Create App.
App Fields
App Name
Display name shown to users (e.g., "Music Control").
App Icon
120×120px PNG or JPG. Uses a default if not set.
App Color
Brand color used in the UI when your app is active.
Webhook URL
Where we send gesture events. Add this when you're ready to receive them.
Click Create. Your app starts as a draft. Click Publish to make it available on your ring (still private to you). Click Public to submit your app for review and make it discoverable to all users.
2. Add to Your Ring
Now let's get your app onto your ring.
Open Control View
In the ARKH companion app, go to the Controls tab.
Explore Widgets
Tap Explore Widgets to browse available apps.
Add Your App
Find your app and add it.
Configure Hotbar
Return to Control View and tap any hotbar slot.
Assign Your App
Select your app to assign it to that slot.
Activate on Ring
Long-press your ring and choose that hotbar option.
3. Test Gestures
Open the Console page in this developer portal. Perform any gesture on your ring (tap, swipe, etc.) and watch events stream in live. The console shows all gesture events, webhook calls, and responses in real-time.
If you have a webhook URL configured, these events are also being sent to your server. Don't have an app yet? Create one first.
4. Send a Vibe
Let's complete the loop by sending haptic feedback back to your ring.
Go to the Console and use the "Send Test Vibe" feature to feel a double tap on your ring.
You can also send vibes programmatically from your server—see the /vibes API.