# 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-signature` header?
* Why is my Oura webhook signature verification failing?
* How do I handle Oura `sleep`, `daily_readiness`, or `workout` events?

## How Oura Webhooks Work

Oura webhooks have two distinct request types on the same callback URL:

1. Subscription handshake (GET): When you create a subscription, Oura sends a `GET`
  to your `callback_url` with query params `verification_token` and `challenge`.
  Check the token matches yours, then respond `200` with JSON `{"challenge": "<value>"}`.
2. Event delivery (POST): Each event is a `POST` carrying headers `x-oura-signature`
  and `x-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](https://github.com/hookdeck/webhook-skills/blob/main/skills/oura-webhooks/references/verification.md) for why raw
body is used instead of re-serializing (`JSON.stringify`) the parsed payload.

Node:

```javascript
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:

```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:
> 
> * [examples/express/](https://github.com/hookdeck/webhook-skills/tree/main/skills/oura-webhooks/examples/express/)
> * [examples/nextjs/](https://github.com/hookdeck/webhook-skills/tree/main/skills/oura-webhooks/examples/nextjs/)
> * [examples/fastapi/](https://github.com/hookdeck/webhook-skills/tree/main/skills/oura-webhooks/examples/fastapi/)

## 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](https://github.com/hookdeck/webhook-skills/blob/main/skills/oura-webhooks/references/overview.md) and the
> [Oura Webhook docs](https://cloud.ouraring.com/v2/docs#tag/Webhook-Subscription-Routes).

## Environment Variables

```bash
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](https://cloud.ouraring.com/oauth/applications). `OURA_VERIFICATION_TOKEN`
is a secret string you choose and pass as `verification_token` when creating the subscription.

## Local Development

```bash
# Start tunnel (no account needed)
npx hookdeck-cli listen 3000 oura --path /webhooks/oura

```

## Reference Materials

* [references/overview.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/oura-webhooks/references/overview.md) - Oura webhook concepts, data types, payloads
* [references/setup.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/oura-webhooks/references/setup.md) - Create and renew subscriptions via the API
* [references/verification.md](https://github.com/hookdeck/webhook-skills/blob/main/skills/oura-webhooks/references/verification.md) - Signature + handshake details and gotchas