Agent skill
Oura Webhooks Skill
Receive and verify Oura webhooks. Use when setting up Oura Ring webhook handlers, completing the subscription verification handshake, debugging x-oura-signature verification, or handling data events like sleep, daily_readiness, daily_activity, and workout.
Install this skill
npx skills add hookdeck/webhook-skills --skill oura-webhooks
When to Use This Skill
- How do I receive Oura webhooks?
- How do I complete the Oura subscription verification handshake (GET challenge)?
- How do I verify the
x-oura-signatureheader? - Why is my Oura webhook signature verification failing?
- How do I handle Oura
sleep,daily_readiness, orworkoutevents?
How Oura Webhooks Work
Oura webhooks have two distinct request types on the same callback URL:
- Subscription handshake (GET): When you create a subscription, Oura sends a
GETto yourcallback_urlwith query paramsverification_tokenandchallenge. Check the token matches yours, then respond200with JSON{"challenge": "<value>"}. - Event delivery (POST): Each event is a
POSTcarrying headersx-oura-signatureandx-oura-timestamp. Verify the HMAC, then process.
Event payloads are thin — { event_type, data_type, object_id, event_time, user_id }. Use object_id to fetch the full record from the Oura API.
Verification (core)
HMAC-SHA256 over timestamp + rawBody, keyed with your client secret, hex digest, UPPERCASE. Compare (timing-safe) to the x-oura-signature header. Use the raw request body — see references/verification.md for why raw body is used instead of re-serializing (JSON.stringify) the parsed payload.
Node:
const crypto = require('crypto');
function verifyOuraSignature(rawBody, signature, timestamp, clientSecret) {
if (!signature || !timestamp) return false;
const expected = crypto
.createHmac('sha256', clientSecret)
.update(timestamp + rawBody) // x-oura-timestamp + raw request body
.digest('hex')
.toUpperCase(); // Oura sends an uppercase hex digest
try {
return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
} catch {
return false; // length mismatch = invalid
}
}
Python:
import hmac, hashlib
def verify_oura_signature(raw_body: bytes, signature: str, timestamp: str, client_secret: str) -> bool:
if not signature or not timestamp:
return False
expected = hmac.new(
client_secret.encode("utf-8"),
timestamp.encode("utf-8") + raw_body, # x-oura-timestamp + raw request body
hashlib.sha256,
).hexdigest().upper()
return hmac.compare_digest(expected, signature)
For complete handlers (GET handshake + POST event dispatch + tests), see:
Common Data Types
Each subscription is one data_type + event_type combination. event_type is create, update, or delete.
data_type | Fires when |
|---|---|
sleep | A sleep period is recorded |
daily_sleep | Daily sleep summary/score is available |
daily_readiness | Daily readiness score is available |
daily_activity | Daily activity summary is available |
workout | A workout is recorded |
session | A moment/session (e.g. breathing) is recorded |
daily_stress | Daily stress summary is available |
Full data_type enum (17): tag, enhanced_tag, workout, session, sleep, daily_sleep, daily_readiness, daily_activity, daily_spo2, sleep_time, rest_mode_period, ring_configuration, daily_stress, daily_cardiovascular_age, daily_resilience, vo2_max, meal.
For the full reference, see references/overview.md and the Oura Webhook docs.
Environment Variables
OURA_CLIENT_SECRET=your_client_secret # HMAC key for x-oura-signature
OURA_VERIFICATION_TOKEN=your_verification_token # Token you set when subscribing
OURA_CLIENT_ID=your_client_id # Only needed to manage subscriptions
OURA_CLIENT_ID / OURA_CLIENT_SECRET come from your app at the Oura Developer portal. OURA_VERIFICATION_TOKEN is a secret string you choose and pass as verification_token when creating the subscription.
Local Development
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 oura --path /webhooks/oura
Reference Materials
- references/overview.md - Oura webhook concepts, data types, payloads
- references/setup.md - Create and renew subscriptions via the API
- references/verification.md - Signature + handshake details and gotchas