Push APIs - Installation and Conversion Notification APIs

The Push API is an AppsFlyer premium feature, which enables Advertisers to receive raw data messages via an HTTP request. A push API message can be sent upon every successful installation, in-app event or re-targeting conversion, whether organic or not. Messages are sent in near real-time, meaning that usually they are sent within a few seconds of the performed action, but may take up to two minutes.

The data is sent, by default, via an http POST method and is JSON formatted.  In addition, you can select the data to be sent via http GET.

For the complete list of fields and message examples click here for iOS or here for Android.

For field descriptions please read this.

 

Push API Configuration:

To configure your push API preferences follow the following steps:

1. On the dashboard, from the left hand menu under Integration select API Access

2. Scroll down to the Push API section, click Add Postback.

3. Choose the data you are interested to receive and enter your push API postback URL.

NOTE:  Push API only supports the use of port 80 and 443.

4.  Click Save.

After you save the changes, upon every conversion the data is sent to your push API URL in the format provided in this document.

NOTES:

  • Additional fields may be added to the JSON structure from time to time without prior notice. Please visit the following links for up-to-date available data fields: iOS, Android.
  • You can configure 4 different postbacks for organic and non-organic installs and in-app events.  If you have re-targeting traffic, you can configure up to 6 different postbacks.
  • If the receiving client fails to collect the push message correctly it can't be resent. In case your client has some down time and loses push messages, you can always fill out the gaps using pull API.
  • Currently API key parameters are not supported as part of the push API.

IP Whitelisting:

We recommend to whitelist AppsFlyer's IPs in your internal networks / platforms in order to successfully receive the Push API calls from AppsFlyer.

Visit the following link for the updated list of AppsFlyer's IPs.

TLS Support: 

AppsFlyer's Push API supports the following TLS versions
  • 1.0
  • 1.1
  • TLS v1.0 
Handshake fails if the target endpoint supports only TLS v1.2.  (Ensure your endpoints supports the earlier versions also).
 
 
 
 
Was this article helpful?
4 out of 5 found this helpful
Have more questions? Submit a request
Powered by Zendesk