For the complete documentation index, see llms.txt. This page is also available as Markdown.
Customising authentication redirects
Overview
After the end-user completes the authentication flow, they will be redirected to a defaultfinalurl that's either a success or failurescreen before they go back to your app.
These urls can be customized when you're calling one of the /auth endpoints.
Authentication Flow Final URL
When the user authenticates a health account (e.g. Oura), before they go back to your app, they see a final URL (screen) of the authentication flow is either a success or failure screen.
Default Success Redirect URL
Default Failure Redirect URL
The final url will append the following parameters:
user_id (not Null)
resource (not Null)
reference_id (can be Null - if you did not pass it in the auth endpoint).
How to Customize the Redirect URLs?
Terra provides these urls by default, and they can also be customized in the /auth endpoints. They can be specified in the body of the authentication request as:
auth_success_redirect_url
auth_failure_redirect_url
Different ways to Customize the Auth Result URL
You can redirect to a:
Web Page: A specific page on your web application, including any useful query parameters.
Deep Link: A deeplink into your mobile application.
Example: reallycoolapp://success
Mobile-based integrations
When using the widget, when the user selects one of the Mobile SDK-based integrations (e.g. Apple Health, Samsung Health, Health Connect), they will by default be redirected to the auth_success_redirect_url with a nulluser_id.
This Redirect URL can be used to redirect your end-user to your mobile app instead so that they complete the connection flow to the Mobile-only integrations using Deep Links.
