Skip to content

docs(webhooks): document device_data.platform (LIN-3990) #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sakkshm26 merged 2 commits into from
Oct 22, 2026
Merged

docs(webhooks): document device_data.platform (LIN-3990) #308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48e1354
docs(webhooks): document device_data.platform (LIN-3990)
sakkshm26 Oct 22, 2026
2606f51
docs(webhooks): device_data.platform is always set (LIN-3990)
sakkshm26 Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion features/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ For supported non-Meta and non-Google ad networks, `campaign_details` contains:

| Field | Type | Description |
|-------|------|-------------|
| `platform` | `"IOS"` \| `"ANDROID"` | Operating system of the install. React Native, Flutter, Expo, and Capacitor apps report the underlying OS |
| `ip_address` | `string` \| `null` | IP address the install request came from, as seen by Linkrunner's servers |
| `user_agent` | `string` \| `null` | `User-Agent` header of the install request. This is usually your app's HTTP client, such as `okhttp/4.12.0`, not a browser |
| `manufacturer` | `string` \| `null` | Device manufacturer, such as `samsung` |
Expand All @@ -241,7 +242,7 @@ For supported non-Meta and non-Google ad networks, `campaign_details` contains:
| `city` | `string` \| `null` | City name |

<Note>
Both objects always contain every key. A key is `null` when Linkrunner did not receive that value or could not resolve the IP address. The values match the device and location columns in the user files from [Data Export](/features/data-export).
Both objects always contain every key. Apart from `device_data.platform`, which is always set, a key is `null` when Linkrunner did not receive that value or could not resolve the IP address. The values match the device and location columns in the user files from [Data Export](/features/data-export).
</Note>

### Additional Data
Expand Down Expand Up @@ -299,6 +300,7 @@ Example:
"gaid": "bk9384xs-p449-96ds-r132",
"idfa": null,
"device_data": {
"platform": "ANDROID",
"ip_address": "203.0.113.24",
"user_agent": "okhttp/4.12.0",
"manufacturer": "samsung",
Expand Down Expand Up @@ -339,6 +341,7 @@ Sent only when **Send webhooks for organic users** is enabled:
"gaid": "bk9384xs-p449-96ds-r132",
"idfa": null,
"device_data": {
"platform": "ANDROID",
"ip_address": "198.51.100.7",
"user_agent": "okhttp/4.12.0",
"manufacturer": "Xiaomi",
Expand Down Expand Up @@ -390,6 +393,7 @@ Sent only when **Send webhooks for organic users** is enabled:
"custom_param_name": "custom_value"
},
"device_data": {
"platform": "ANDROID",
"ip_address": "203.0.113.58",
"user_agent": "Dart/3.4 (dart:io)",
"manufacturer": "Google",
Expand Down
Loading