Apple Integration
With Terra's Apple Health SDK integration, you can use the Terra iOS SDK to gain access to all data users see in their app, including user-tracked workouts & activity summaries
apple integration
What you need to integrate with Apple
apple integration steps, step 1
Terra API Key
Once you sign up, we will provide you with an API key used to access our API
apple integration steps, step 2
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.
apple integration steps, step 3
Webhook URL
You will need to set up a server (or use a testing environment like https:// that accepts POST requests from Terra
Data Format

All data is sent to your webhook in JSON format in the form of 5 different types of payloads: Activity, Body, Daily, Menstruation, Nutrition, Sleep. 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.

Receiving data for your Apple integration - WEBHOOKS

Whenever data become available from a Apple device, they will be streamed to you, via our webhooks. When setting up your Terra account, you will be prompted to provide a callback URL, to which Terra may send PUSH data using POST requests.

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

receiving data from apple integration via webhooks to your app or website
Historical data from HTTP requests

You may also use HTTP requests with your Apple 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 data over a specific period for the given user.

The type of data that Apple has
You can access the following data through your Apple integration with the Terra API
apple integration ACTIVITY dataapple integration BODY dataapple integration DAILY dataapple integration MENSTRUATION dataapple integration NUTRITION dataapple integration SLEEP data
apple integration data types
Activity .JSON
Body .JSON
Daily .JSON
Menstruation .JSON
Nutrition .JSON
Sleep .JSON