Send Event

post

https://api3.appsflyer.com/inappevent/{app_id}

Use this API to send mobile events that occur outside the app from your servers to AppsFlyer.

⚠️
JSON payload limitation JSON payload size: up to 1KB

⚠️
This API requires TLS v1.2 or higher

📘
Encode URLs - Encode (percent) code reserved characters before forming the method URL.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app_id

string

required

The app identifier used in the AppsFlyer dashboard.
Insert it excatly as it appears on the dashboard.
iOS apps: Ensure to prefix with id, for example id123456789. If you don't, the request returns a 200 OK status but doesn't record the event.
Android apps: Use the app package name as it appears in the Google Play Store. For example: com.example.myapp.
Windows: Get the app ID from the Microsoft App Store.

Body Params

What if I can't send a device identifier?
You may be unable to send the device identifier with the S2S event. In such cases, AppsFlyer will attempt to enrich the event postback with the device ID from the user's install (Note: Identifier enrichment doesn't apply for IDFV).
However, when the SDK sends install events without device identifiers, for example, when ATT (App Tracking Transparency) has not been implemented, the postback will not include the device ID.
Not sending an advertising ID/device identifier can result in:

Postback issues: The media source will receive the postback but without a device identifier. As a result the media source can't associate the postback with a specific user.
Audiences segmentation and rule failure. Audiences rulesets require identifiers. It's always best practice to send a device ID or customer user ID according to the ID type your ruleset uses, for every S2S event.
Incrementaliy: In order to be measured in Incrementality, S2S events must include the advertising ID in their payload (IDFA for iOS, GAID for Android).

advertising_id

string

Where available populate with the device GAID (advertising ID).
Required to send postbacks to self-reporting networks (SRNs). If not provided and Advanced Privacy is not enabled, postbacks may be skipped.

oaid

string

amazon_aid

string

imei

string

appsflyer_id

string

required

A unique identifier, generated by AppsFlyer, when the app launches for the first time.
Learn here how to obtain it

customer_user_id

string

Customer user ID, a unique user identifier set by the app owner.

email_hashed

string

The user's email address, hashed using SHA-256.
Before hashing: trim leading and trailing spaces, and convert all characters to lowercase.

phone_number_hashed

string

The user's phone number, hashed using SHA-256.
Before hashing: remove all symbols, letters, and leading zeros. The phone number must include the country code (for example, the US number (650)555-1212 becomes 16505551212).

phone_number_e164_hashed

string

The user's phone number in E.164 format, hashed using SHA-256.
Before hashing: normalize to E.164 format (for example, +12133734253). Include the country code prefixed with +, with no parentheses, leading zeros, spaces, letters, or symbols other than the leading +.
We recommend using libphonenumber-js for E.164 parsing.

first_name_hashed

string

The user's first name, hashed using SHA-256.
Before hashing: convert to lowercase.

last_name_hashed

string

The user's last name, hashed using SHA-256.
Before hashing: convert to lowercase.

fb_login_id

string

The user's Facebook Login ID. Send as a numeric string.

string

length ≤ 16

The mobile device's IP address during the event occurrence.
If sent, the IP address is used to populate geo fields.
If not sent, AppsFlyer populates the geo fields using the values from the install attribution event. The IP address isn't populated.

eventName

string

required

Specify the event name. Ensure that the event names are aligned with the marketer's requirements.

eventValue

json

required

⚠️
If you send an event without a value then send: "eventValue":""

Event values must be sent without additional symbols or formatting.
For af_revenue a decimal point can be used. Negative values should be preceded by a -

app_version_name

string

app_store

string

Equivalent to AF_STORE in Android apps. The store from which the app was downloaded.

eventTime

date-time

The time the event occurred using UTC timezone.

Default: If no eventTime is sent, the time is set to the HTTP message arrival time.
Format: string yyyy-mm-dd hh:mm:ss.sss the time needs to be in UTC timezone.

To learn how events are timestamped after arriving to AppsFlyer based on the eventTime value refer to this KB section.

eventCurrency

string

enum

bundleIdentifier

string

A unique app identifier. In raw-data, the parameter populates Bundle ID.
Best practice - Always populate this parameter. Many ad networks require it for campaign optimization.

sharing_filter

length ≥ 1

The sharing filter blocks the sharing of S2S events via postbacks/API with integrated partners and other third-party integrations.

Use the filter to fulfill regulatory requirements like GDPR and CCPA, to comply with user opt-out mechanisms, and for other business logic reasons.

The sharing_filter has the following options:

all: All partners are blocked. Don't share the event with anyone. Example: "sharing_filter": "all"
List of partner ids in an array.

Note:
To find out the required partner IDs:

Run the Get active integrations API for a list of all active integrations
Use the media_source_name values from the API response as input values to the method partners array.

Exceptions:

For Apple Search Ads use "Apple Search Ads" (and not "iossearchads_int").
For Twitter, use "twitter" (and not "twitter_int")

custom_dimension

string

Reserved for AppsFlyer future use

app_type

string

enum

If the user event takes place in an app_clip, send the parameter. In all other cases don't send the parameter.

Allowed:

custom_data

json

Send custom data to the AppsFlyer platform. Similar to sending data from the SDK using setAdditionalData
In raw data: populates custom_data field.

string

The device operating system version.

⚠️
To enable correct data processing you must send this parameter.
For backward compatibility reasons, we don't enforce this, so it isn't marked as obligatory.

📘
Note 🍏
Starting July 1, 2021, for iOS apps, if you don't send this parameter we regard the data as having come from a device running iOS 14.5.

string

The device user-agent

aie

boolean

Use this flag to indicate if the user opted out of sharing their advertiser ID.

Use this field for devices running Android (all versions), or iOS versions before 14.

📘
Note
For iOS 14.5+, use the att parameter.

Populate this field as follows:

true: if the user agreed to share the advertiser ID.
false: if the user enabled Limited Ad Tracking (LAT).

consent_data

app_set_id

object

The vendor ID shared by all apps from same vendor. For more information, see Add the app set ID SDK to your app.

Responses

Note 🍏

Note

200On receipt of a message, minimum data validation is performed. As such, you can get an OK response even though the event may not completely record in AppsFlyer

401|Message|How to handle| |--- |--- |--- | |Unauthorized|When the key provided in the authentication header is not the <S2S_key> for this app|

403|Message|How to handle| |--- |--- |--- | |Forbidden|"Zero Package" does not accept attribution events|

500|Message|How to handle| |--- |--- |--- | |Internal Server Error|Verify that the JSON is stringified() and formatted correctly|