Garmin Integration

With our Garmin Integration you can access Activity , Body , Daily , Sleep and Menstruation data all within one single integration using Terra. Below are key steps to allow you to integrate your application with Garmin

1. What you need to integrate with Garmin

  • Terra API Key
    Once you sign up, we will provide you with an API key which will allow you to access our API

  • Developer ID
    We will provide you with a Developer ID, which allows Terra to identify users that belong to you, and associate API traffic to you.

  • Callback/Webhook URL
    You will need to set up a server (or use a testing environment like https://webhook.site) that accepts POST requests from Terra.

2. Data format

All data is sent to your webhook in JSON format in the form of 5 different types of payloads: Activity, Athlete, Body, Daily, Sleep, Menstruation; depending on your needs, you may select a subset of the aforementioned, and request less data from your users.

Examples of data payloads can be found here. If you would only like to receive specific fields out of the ones available, you may also select only the ones relevant to your needs and omit the rest. The following is an example of the data payload you may expect from an activity coming from Terra.

3. Receiving data for your Garmin integration - WEBHOOKS

Our infrastructure revolves around webhooks. When setting up your Terra account, you will be prompted to provide a callback URL, to which Terra may send data using POST requests.

Your Garmin integration with Terra supports instant delivery of data without needing to periodically request it yourself. Garmin notifies Terra whenever new data is available, following which we POST the normalized data to your webhook URL.

4. Requesting data for your Garmin integration - HTTP

You may also use HTTP requests with your Garmin integration in case you wish to request historical data or data over extended periods of time.

Most HTTP endpoints can take additional parameters - start_date and end_date - which allow you to request for data over a specific period for the given user.

5. Front end - end user experience

We provide a front end solution for your end users to authenticate with Terra and be linked back to your webhook URL through your Terra developer ID.

In order to use the widget integration, simply open a browser within your app pointing to https://widget.tryterra.co after creating a widget session. See the documentation for further information and instructions on how to integrate with our widget.

Any user following through with authentication using the above will be linked back to your Terra developer account.

Logo