API Oura

Learn the endpoints for the Oura integration.

Authenticate

To authenticate your users with Oura you can use this endpoint:

GET https://${env}.sdk.areyoupoint.com/organizations/integrations/oura/:appClientId/auth

This endpoint requires a user accessToken using Bearer authentication.

You can pass a query param scope to choose the scopes that will be asked for the user in the authorization flow, if you don't pass any, all scopes are requested. You can find out more about the scopes in the Oura documentation.

💡 Currently the supported scopes are: personal, daily, heartrate, workout and session. We recommend selecting only the scopes you need. No data will be provided or generated from unsupported scopes.

You can pass the scopes with space between them: (e.g. personal workout heartrate)

GET https://${env}.sdk.areyoupoint.com/organizations/integrations/oura/:appClientId/auth?scope=personal workout heartrate

If the user denies all the requested scopes they will be redirected to the callback URL that you set in the creation of the integration with the parameters error and error_description.

https://thisisyoucallback.com?error=access_denied&error_description=The%20user%20denied%20the%20request.

If the user accepts any of the scopes they will be redirected to the callback URL that you set in the creation of the integration with no parameters.

Based on the scopes that the user accepted we retrieve the historical Oura data (1 year) and create all the subscriptions necessary. These subscriptions enable us to get the notification from Oura with new data from the user!

Revoke

Revoking the subscriptions for the user:

POST https://${env}.sdk.areyoupoint.com/organizations/integrations/oura/:appClientId/revoke

This endpoint doesn't delete the user data only the subscription created in Oura for the user.