Deep Link Automation

Create a REST API automation by opening a URL on your iPhone or iPad. Deep links do not configure other destinations.

URL format

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fhealth&name=Daily%20Export

url is required. Provide a descriptive name; if omitted, it defaults to Automation. Parameter names are case-insensitive. URL-encode parameter values containing spaces or reserved characters.

Open the URL on your device, or use Open URLs in Shortcuts. Review the created automation in Health Auto Export before enabling it.

Parameter reference

Booleans accept true/false, 1/0, or yes/no. Set datatype before its data-specific options, and format before aggregatedata, so later selections do not replace earlier settings.

Basic settings

Parameter	Values or meaning	Default
url	Endpoint URL reachable from your device	Required
name	Nonempty automation name	Automation
enabled	Enable automatic runs	false
datatype	Data type listed below	healthMetrics
format	json, csv, markdown, or md	json
exportversion	v1, v2, 1, or 2	v2
period	none, lastsync, today, yesterday, previous7days	none
requesttimeout	Integer seconds, 60–86400	60
headers	Comma-separated key/value pairs	None
batchrequests	Boolean; JSON only	false

Valid data types are healthMetrics, workouts, symptoms, ecg, heartRateNotification, stateOfMind, cycleTracking, and medications. State of Mind requires iOS 18 or later; medication exports require iOS 26 or later.

For date-range meanings, see Date range. All deep links create REST API automations; there is no exportDestination parameter.

Health metrics

Parameter	Values or meaning	Default
metrics	Comma-separated exact metric names, such as Step Count,Heart Rate	All available metrics
aggregatedata	Boolean; use false for individual readings where supported	true
interval	none, minutes, hours, days, weeks, months, years	none
aggregatesleep	Boolean controlling sleep summarization	true

metrics, aggregatedata, and interval apply to health metrics. CSV selection turns summarization on; use JSON for individual readings. Specify the desired summarization explicitly when generating links.

Workouts

Parameter	Values or meaning	Default when datatype=workouts
includeroutes	Boolean	true
includeworkoutmetadata	Boolean	true
workoutsmetadatainterval	minutes or seconds; Version 2	minutes
workouttypes	Comma-separated unsigned Apple workout-type identifiers	All types

Do not include health-metric aggregation options in a workout link.

Cadence and notifications

Parameter	Values or meaning	Default
syncinterval	minutes, hours, days, weeks	minutes
syncquantity	Positive integer number of intervals	5
notifyonupdate	Boolean; notify after data preparation	true
notifywhenrun	Boolean; notify after a successful destination action	true

Cadence remains subject to background and health-data limits; it is not an exact schedule.

Authentication and encoding

The headers value consists of alternating keys and values:

headers=Authorization,Bearer%20YOUR_TOKEN,X-API-Key,YOUR_KEY

Each key requires a value. Commas separate pairs, so avoid header values containing commas in this link format. Encode spaces as %20, plus signs as %2B, and ampersands as %26. Encode the complete endpoint URL when it has its own query parameters.

Examples

Selected metrics, summarized hourly

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fmetrics&name=Steps%20and%20Heart%20Rate&datatype=healthMetrics&format=json&metrics=Step%20Count,Heart%20Rate&aggregatedata=true&interval=hours

Workouts with routes

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fworkouts&name=Workout%20Export&datatype=workouts&format=json&includeroutes=true&includeworkoutmetadata=true&exportversion=v2&workoutsmetadatainterval=minutes

Both examples leave automatic runs disabled until you review and enable the automation.

Troubleshooting

• URL or parameter error: Start with the minimal URL, check spelling and encoding, then add options individually.
• Invalid metric: Use the exact metric name, including spaces and capitalization.
• Aggregation error: Use health-metric options only with datatype=healthMetrics.
• Workout settings error: Use workout options with datatype=workouts; second grouping requires Version 2.
• Batching error: Set format=json or disable batchrequests.
• Invalid cadence/timeout: Use the supported intervals, a positive quantity, and a timeout from 60 to 86400 seconds.
• URL too long: Reduce the metric/header list or configure the remaining settings in the app.

After creation, use REST API — Export historical or missed data to upload a selected range or check your setup.

Related Documentation

• REST API Automation Guide
• Automations Overview