Actions40
- Personal Info Actions
- Daily Activity Actions
- Workout Actions
- Session Actions
- Sleep Actions
- Daily Sleep Actions
- Sleep Time Actions
- Rest Mode Period Actions
- Daily Readiness Actions
- Daily SpO2 Actions
- Daily Stress Actions
- Daily Resilience Actions
- Daily Cardiovascular Age Actions
- VO2 Max Actions
- Heart Rate Actions
- Ring Configuration Actions
- Tag Actions
- Enhanced Tag Actions
- Webhook Subscription Actions
Webhook Subscription → Create
AI-generatedSummary
Create a new webhook subscription in the Oura Ring API to receive notifications for specific event and data types via a specified callback URL.
Inputs
- Callback URL (required) — The URL to receive webhook notifications.
- Verification Token (required) — A token used to verify webhook callbacks.
- Event Type (required) — The type of event to subscribe to, such as create, update, or delete.
- Data Type (required) — The type of data to subscribe to, including options like daily activity, daily readiness, workout, sleep, and others.
Output shape
a single webhook subscription object
The returned data contains details of the newly created webhook subscription as confirmed by the Oura Ring API response to the POST request at /v2/webhook/subscription. The response includes subscription identifiers and settings.
Examples
Example 1: Create a webhook subscription to receive notifications when new daily sleep data is created.
Set Callback URL to your webhook endpoint, provide a Verification Token for security, select 'create' for Event Type, and 'daily_sleep' for Data Type.