pixellint

AppsFlyer S2S in-app events

Posted to api3.appsflyer.com/inappevent. The JSON body is the contract. eventValue is required even when it is empty. att is 0 through 3. advertising_id and idfa are UUIDs. OneLink impression URLs on impressions.onelink.me are vendor/appsflyer-onelink-impression.

What this pack matches

Hosts
api3.appsflyer.com
Paths
…/inappevent/…
Vendor docs
dev.appsflyer.com/hc/reference/s2s-events-api3-overview

Rules

Codes are stable. A finding in CI, MCP, or the playground lands on the same id.

Field Required What it checks Rule ids Source
app_id required It is the app identifier from the AppsFlyer dashboard, and it travels in the path. iOS apps must be prefixed with `id`. Fix: Put the dashboard app ID in the path after `/inappevent/`. Prefix iOS IDs with `id`. vendor.appsflyer.param.app_id.missing
vendor.appsflyer.param.app_id.empty
docs
ios_app_id_unprefixed recommended This app ID is digits only. AppsFlyer documents that iOS IDs must be prefixed with `id`; without it the call still returns 200 and the event is not recorded. Fix: Prefix the iOS app ID with `id`, such as `id123456789`. vendor.appsflyer.ios_app_id_unprefixed docs
appsflyer_id required It is the AppsFlyer device identifier generated on first launch, and the endpoint requires it. Native JSON type: string. Fix: Send the `appsflyer_id` the SDK generated for this install. vendor.appsflyer.body.appsflyer_id.missing
vendor.appsflyer.body.appsflyer_id.empty
vendor.appsflyer.body.appsflyer_id.invalid
docs
eventName required Event names cannot start with quote, equals, plus or minus and cannot contain spaces. Custom names remain allowed. Native JSON type: string. Fix: Set `eventName` to the event the marketer expects, such as `af_purchase`. vendor.appsflyer.body.eventName.missing
vendor.appsflyer.body.eventName.empty
vendor.appsflyer.body.eventName.invalid
docs
eventValue required AppsFlyer documents eventValue as a JSON object, and also accepts a stringified JSON string. Send an empty string when the event has no value. Native JSON type: string or object. Fix: Send a JSON object, a JSON object string, or "" when there is no value. vendor.appsflyer.body.eventValue.missing
vendor.appsflyer.body.eventValue.invalid
docs
att optional It is the iOS ATTrackingManager status. AppsFlyer documents 0 not determined, 1 restricted, 2 denied, 3 authorized. Native JSON type: integer. Fix: Send `0`, `1`, `2`, or `3`. vendor.appsflyer.body.att.empty
vendor.appsflyer.body.att.invalid
docs
advertising_id optional It is the Android GAID. AppsFlyer documents a UUID. Native JSON type: string. Fix: Send the GAID as a UUID. vendor.appsflyer.body.advertising_id.empty
vendor.appsflyer.body.advertising_id.invalid
docs
idfa optional It is the iOS IDFA. AppsFlyer documents a UUID. Native JSON type: string. Fix: Send the IDFA as a UUID. vendor.appsflyer.body.idfa.empty
vendor.appsflyer.body.idfa.invalid
docs
idfv optional It is the iOS IDFV. AppsFlyer documents a UUID. Native JSON type: string. Fix: Send the IDFV as a UUID. vendor.appsflyer.body.idfv.empty
vendor.appsflyer.body.idfv.invalid
docs
oaid optional It is the Android OAID, used when GAID is not available. AppsFlyer's sample is a UUID. Native JSON type: string. Fix: Send the OAID as a UUID. vendor.appsflyer.body.oaid.empty
vendor.appsflyer.body.oaid.invalid
docs
customer_user_id optional It is the advertiser's user id. AppsFlyer documents `customer_user_id` as a unique user identifier set by the app owner. Native JSON type: string. Fix: Send `customer_user_id`, or drop the empty pair. vendor.appsflyer.body.customer_user_id.empty
vendor.appsflyer.body.customer_user_id.invalid
docs
fb_login_id optional It is the Facebook Login ID. AppsFlyer documents a numeric string. Native JSON type: string. Fix: Send `fb_login_id` as digits only, such as `10293847561029384`. vendor.appsflyer.body.fb_login_id.empty
vendor.appsflyer.body.fb_login_id.invalid
docs
bundleIdentifier optional It is the app bundle id. AppsFlyer documents it as best practice for campaign optimization. Native JSON type: string. Fix: Send the bundle id, such as `com.example.myapp`, or drop the empty pair. vendor.appsflyer.body.bundleIdentifier.empty
vendor.appsflyer.body.bundleIdentifier.invalid
docs
app_version_name optional It is the public app version name. AppsFlyer documents `app_version_name` on both Android and iOS payloads. Native JSON type: string. Fix: Send `app_version_name`, or drop the empty pair. vendor.appsflyer.body.app_version_name.empty
vendor.appsflyer.body.app_version_name.invalid
docs
consent_data.manual.gdpr_applies optional It is whether GDPR applies. AppsFlyer documents a boolean on the manual consent object. Native JSON type: boolean. Fix: Send `true` or `false` in `consent_data.manual.gdpr_applies`. vendor.appsflyer.body.consent_data.manual.gdpr_applies.empty
vendor.appsflyer.body.consent_data.manual.gdpr_applies.invalid
docs
consent_data.manual.ad_user_data_enabled optional It is the ad-user-data consent flag. AppsFlyer documents a boolean on the manual consent object. Native JSON type: boolean. Fix: Send `true` or `false` in `consent_data.manual.ad_user_data_enabled`. vendor.appsflyer.body.consent_data.manual.ad_user_data_enabled.empty
vendor.appsflyer.body.consent_data.manual.ad_user_data_enabled.invalid
docs
consent_data.manual.ad_personalization_enabled optional It is the ad-personalization consent flag. AppsFlyer documents a boolean on the manual consent object. Native JSON type: boolean. Fix: Send `true` or `false` in `consent_data.manual.ad_personalization_enabled`. vendor.appsflyer.body.consent_data.manual.ad_personalization_enabled.empty
vendor.appsflyer.body.consent_data.manual.ad_personalization_enabled.invalid
docs
aie optional AppsFlyer documents `aie` as a boolean. `true` means the user agreed to share the advertiser ID. Native JSON type: boolean. vendor.appsflyer.body.aie.empty
vendor.appsflyer.body.aie.invalid
docs
app_type optional AppsFlyer documents `app_clip` when the event happened in an app clip. Omit the field otherwise. Native JSON type: string. vendor.appsflyer.body.app_type.empty
vendor.appsflyer.body.app_type.invalid
docs
os optional It is the device OS version. AppsFlyer documents it as required for correct processing, and assumes iOS 14.5 when it is omitted on iOS. Native JSON type: string. vendor.appsflyer.body.os.empty
vendor.appsflyer.body.os.invalid
docs
eventTime optional AppsFlyer documents UTC as `yyyy-mm-dd hh:mm:ss.sss`. An epoch number is stamped as the arrival time instead. Native JSON type: string. Fix: Send UTC as `2019-05-15 12:17:01.123`, with a space, not `T`. vendor.appsflyer.body.eventTime.empty
vendor.appsflyer.body.eventTime.invalid
docs
eventCurrency optional It is an ISO 4217 currency code. Native JSON type: string. Fix: Use the three-letter code, such as `USD`. vendor.appsflyer.body.eventCurrency.empty
vendor.appsflyer.body.eventCurrency.invalid
docs
email_hashed optional Email must be trimmed, lowercased, and SHA-256 hashed before it is sent. Native JSON type: string. Fix: Trim and lowercase the address, hash it with SHA-256, and send the hex digest. vendor.appsflyer.body.email_hashed.empty
vendor.appsflyer.body.email_hashed.invalid
docs
phone_number_hashed optional Phone must be normalized and SHA-256 hashed before it is sent. Native JSON type: string. Fix: Strip symbols and leading zeros, keep the country code, hash with SHA-256, and send the hex digest. vendor.appsflyer.body.phone_number_hashed.empty
vendor.appsflyer.body.phone_number_hashed.invalid
docs
phone_number_e164_hashed optional An E.164 phone number must be SHA-256 hashed before it is sent. Native JSON type: string. Fix: Normalize to E.164, hash with SHA-256, and send the hex digest. vendor.appsflyer.body.phone_number_e164_hashed.empty
vendor.appsflyer.body.phone_number_e164_hashed.invalid
docs
first_name_hashed optional First name must be lowercased and SHA-256 hashed before it is sent. Native JSON type: string. Fix: Lowercase the name, hash it with SHA-256, and send the hex digest. vendor.appsflyer.body.first_name_hashed.empty
vendor.appsflyer.body.first_name_hashed.invalid
docs
last_name_hashed optional Last name must be lowercased and SHA-256 hashed before it is sent. Native JSON type: string. Fix: Lowercase the name, hash it with SHA-256, and send the hex digest. vendor.appsflyer.body.last_name_hashed.empty
vendor.appsflyer.body.last_name_hashed.invalid
docs
ip optional It is the device IP address during the event, sent unhashed. Native JSON type: string. Fix: Send the device IP, not a SHA-256 digest. vendor.appsflyer.body.ip.empty
vendor.appsflyer.body.ip.invalid
docs
root optional Each event is a JSON object, rather than a scalar or list. Native JSON type: object. vendor.appsflyer.body.root.invalid docs
amazon_aid optional The vendor documents the JSON shape or value type of this field. Native JSON type: string. vendor.appsflyer.body.amazon_aid.invalid docs
imei optional The vendor documents the JSON shape or value type of this field. Native JSON type: string. vendor.appsflyer.body.imei.invalid docs
app_store optional The vendor documents the JSON shape or value type of this field. Native JSON type: string. vendor.appsflyer.body.app_store.invalid docs
custom_dimension optional The vendor documents the JSON shape or value type of this field. Native JSON type: string. vendor.appsflyer.body.custom_dimension.invalid docs
custom_data optional The vendor documents the JSON shape or value type of this field. Native JSON type: string. vendor.appsflyer.body.custom_data.invalid docs
sharing_filter optional Send the scalar all to block every partner, or an array of partner identifiers. Native JSON type: string or array. vendor.appsflyer.body.sharing_filter.empty
vendor.appsflyer.body.sharing_filter.invalid
docs
sharing_filter[] optional Every blocked partner is sent as a partner identifier string. Native JSON type: string. vendor.appsflyer.body.sharing_filter[].empty
vendor.appsflyer.body.sharing_filter[].invalid
docs
consent_data optional The vendor documents the JSON shape or value type of this field. Native JSON type: object. vendor.appsflyer.body.consent_data.invalid docs
consent_data.manual optional The vendor documents the JSON shape or value type of this field. Native JSON type: object. vendor.appsflyer.body.consent_data.manual.invalid docs
consent_data.tcf optional The vendor documents the JSON shape or value type of this field. Native JSON type: object. vendor.appsflyer.body.consent_data.tcf.invalid docs
consent_data.tcf.tc_string optional TCF consent is a structurally decodable TCFv2 string; original jurisdiction and permissions require external context. Native JSON type: string. vendor.appsflyer.body.consent_data.tcf.tc_string.empty
vendor.appsflyer.body.consent_data.tcf.tc_string.invalid
docs
ua optional The device user agent is a string. Native JSON type: string. vendor.appsflyer.body.ua.invalid docs
app_set_id optional The app-set identifier is documented as an object; unspecified member keys remain open. Native JSON type: object. vendor.appsflyer.body.app_set_id.invalid docs
body.unhashed_email required A field carries what looks like a raw email address. AppsFlyer documents email as `email_hashed`, SHA-256 hashed on the client side. Fix: Trim the address, lowercase it, hash it with SHA-256, and send it as `email_hashed`. vendor.appsflyer.body.unhashed_email docs
body.hashed_plaintext_field required `ip` looks like a SHA-256 digest, but AppsFlyer documents it as the device IP address, unhashed. Fix: Send the raw IP address. Hashing it makes geo matching fail. vendor.appsflyer.body.hashed_plaintext_field docs
body.android_os_required recommended Send the Android OS version for correct processing. The endpoint accepts omission for backward compatibility. vendor.appsflyer.body.android_os_required docs
body.ios14_att_recommended recommended Populate ATTrackingManager status for iOS14 and later. When os is omitted, AppsFlyer assumes iOS14.5. vendor.appsflyer.body.ios14_att_recommended docs
root optional The API documents a JSON-encoded object inside this string-valued field. Decoded body source: eventValue. Encoding: json. Native JSON type: object. vendor.appsflyer.body.root.invalid docs
af_revenue optional Revenue may use a decimal point and a leading minus sign. Additional currency symbols and formatting are unsupported. Decoded body source: eventValue. Encoding: json. Native JSON type: string or number. vendor.appsflyer.body.af_revenue.empty
vendor.appsflyer.body.af_revenue.invalid
docs
af_net_revenue optional Net revenue uses the same decimal syntax as gross revenue. Revenue after fees and tax requires original business data. Decoded body source: eventValue. Encoding: json. Native JSON type: string or number. vendor.appsflyer.body.af_net_revenue.empty
vendor.appsflyer.body.af_net_revenue.invalid
docs
af_order_info optional Item-level order data accepts an object of per-field arrays or an array of per-item objects. Every one of the seven fields is optional. Decoded body source: eventValue. Encoding: json. Native JSON type: object or array. vendor.appsflyer.body.af_order_info.invalid docs
af_order_info.sku optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.sku.invalid docs
af_order_info.revenue optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.revenue.invalid docs
af_order_info.qty optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.qty.invalid docs
af_order_info.content_name optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.content_name.invalid docs
af_order_info.content_type optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.content_type.invalid docs
af_order_info.content_category optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.content_category.invalid docs
af_order_info.brand optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.brand.invalid docs
af_order_info.content_type[] optional The only supported content types are product and product_group. Decoded body source: eventValue. Encoding: json. vendor.appsflyer.body.af_order_info.content_type[].empty
vendor.appsflyer.body.af_order_info.content_type[].invalid
docs
af_content optional Preserve normal content titles and SDK string arrays. Legacy complex-item JSON strings above1000 characters may be omitted from Meta postbacks. Decoded body source: eventValue. Encoding: json. Value diagnostic severity: warning. Native JSON type: string or array. Maximum decoded characters: 1000. vendor.appsflyer.body.af_content.invalid docs
af_content_id optional Decoded body source: eventValue. Encoding: json. Native JSON type: string or number or array. vendor.appsflyer.body.af_content_id.invalid docs
af_quantity optional Decoded body source: eventValue. Encoding: json. Native JSON type: string or number or array. vendor.appsflyer.body.af_quantity.invalid docs
af_price optional Decoded body source: eventValue. Encoding: json. Native JSON type: string or number or array. vendor.appsflyer.body.af_price.invalid docs
body.order_array_lengths required Each populated order field array must cover the same items in the same order. Item identity/order requires original basket context. Decoded body source: eventValue. Encoding: json. vendor.appsflyer.body.order_array_lengths docs
body.legacy_array_lengths required Parallel content ID, quantity and price arrays must cover the same ordered items. Decoded body source: eventValue. Encoding: json. vendor.appsflyer.body.legacy_array_lengths docs
body.revenue_precision recommended AppsFlyer reports revenue with up to five decimal places; additional precision may be lost. Decoded body source: eventValue. Encoding: json. vendor.appsflyer.body.revenue_precision docs
root optional The API documents a JSON-encoded object inside this string-valued field. Decoded body source: custom_data. Encoding: json. Native JSON type: object. vendor.appsflyer.body.root.invalid docs
af_order_info optional Item-level order data accepts an object of per-field arrays or an array of per-item objects. Every one of the seven fields is optional. Decoded body source: custom_data. Encoding: json. Native JSON type: object or array. vendor.appsflyer.body.af_order_info.invalid docs
af_order_info.sku optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.sku.invalid docs
af_order_info.revenue optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.revenue.invalid docs
af_order_info.qty optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.qty.invalid docs
af_order_info.content_name optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.content_name.invalid docs
af_order_info.content_type optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.content_type.invalid docs
af_order_info.content_category optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.content_category.invalid docs
af_order_info.brand optional In the compact field-per-array representation, each populated item field is an array. Decoded body source: custom_data. Encoding: json. Native JSON type: array. vendor.appsflyer.body.af_order_info.brand.invalid docs
af_order_info.content_type[] optional The only supported content types are product and product_group. Decoded body source: custom_data. Encoding: json. vendor.appsflyer.body.af_order_info.content_type[].empty
vendor.appsflyer.body.af_order_info.content_type[].invalid
docs
body.order_array_lengths required Each populated order field array must cover the same items in the same order. Item identity/order requires original basket context. Decoded body source: custom_data. Encoding: json. vendor.appsflyer.body.order_array_lengths docs
root optional Body scope: sharing_filter[]. Native JSON type: string. vendor.appsflyer.body.root.invalid docs
body.sharing_filter_legacy_alias required Use twitter and Apple Search Ads for these two sharing-filter exceptions. Body scope: sharing_filter[]. vendor.appsflyer.body.sharing_filter_legacy_alias docs
root optional Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. Native JSON type: object. vendor.appsflyer.body.root.invalid docs
sku optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. docs
revenue optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. docs
qty optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. docs
content_name optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. docs
content_type optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. vendor.appsflyer.body.content_type.empty
vendor.appsflyer.body.content_type.invalid
docs
content_category optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. docs
brand optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: eventValue. Encoding: json. docs
root optional Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. Native JSON type: object. vendor.appsflyer.body.root.invalid docs
sku optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. docs
revenue optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. docs
qty optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. docs
content_name optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. docs
content_type optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. vendor.appsflyer.body.content_type.empty
vendor.appsflyer.body.content_type.invalid
docs
content_category optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. docs
brand optional Optional item field. The source does not define an exclusive scalar native type. Body scope: af_order_info[]. Decoded body source: custom_data. Encoding: json. docs
root optional The legacy complex-item representation is a JSON array encoded within af_content. Decoded body source: eventValue. Encoding: json. Native JSON type: array. vendor.appsflyer.body.root.invalid docs
root optional Body scope: []. Decoded body source: eventValue. Encoding: json. Native JSON type: object. vendor.appsflyer.body.root.invalid docs
id required Body scope: []. Decoded body source: eventValue. Encoding: json. Native JSON type: string or number. vendor.appsflyer.body.id.missing
vendor.appsflyer.body.id.empty
vendor.appsflyer.body.id.invalid
docs
quantity required Body scope: []. Decoded body source: eventValue. Encoding: json. Native JSON type: string or number. vendor.appsflyer.body.quantity.missing
vendor.appsflyer.body.quantity.empty
vendor.appsflyer.body.quantity.invalid
docs
method required This endpoint documents POST requests. Complete HTTP capture contract. Native JSON type: string. vendor.appsflyer.http.method.missing
vendor.appsflyer.http.method.empty
vendor.appsflyer.http.method.invalid
docs
path required Use the documented event endpoint route. Complete HTTP capture contract. Native JSON type: string. vendor.appsflyer.http.path.missing
vendor.appsflyer.http.path.empty
vendor.appsflyer.http.path.invalid
docs
content_type required The request carries an application/json body. Complete HTTP capture contract. Native JSON type: string. vendor.appsflyer.http.content_type.missing
vendor.appsflyer.http.content_type.empty
vendor.appsflyer.http.content_type.invalid
docs
body_encoding required The event request is encoded as JSON. Complete HTTP capture contract. Native JSON type: string. vendor.appsflyer.http.body_encoding.missing
vendor.appsflyer.http.body_encoding.empty
vendor.appsflyer.http.body_encoding.invalid
docs
headers.authentication required Use the S2S key in the authentication header, not an Authorization Bearer header. Complete HTTP capture contract. Native JSON type: string. vendor.appsflyer.http.headers.authentication.missing
vendor.appsflyer.http.headers.authentication.empty
vendor.appsflyer.http.headers.authentication.invalid
docs
url required The published request endpoint uses HTTPS. Complete HTTP capture contract. Native JSON type: string. vendor.appsflyer.http.url.missing
vendor.appsflyer.http.url.empty
vendor.appsflyer.http.url.invalid
docs

Validate a payload

pixellint validate json @payload.json --rulepack vendor/appsflyer

Try this failing payload in the playground. AppsFlyer event without eventValue.

{"appsflyer_id":"1234567890123-1234567","eventName":"af_purchase","eventTime":"2019-05-15 12:17:01.123"}

cargo install pixellint · npm install pixellint