Push APIs - Real-Time Installation and Conversion Notification APIs

The Push API enables Advertisers to receive a real-time HTTP request upon every successful organic or non-organic, installation or in-app event conversion.

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.

iOS Data Structure:

For the complete list of iOS fields click here

Example:

iOS.png

Android Data Structure:

For the complete list of Android fields click here.

Example:

Android.png

Push API Configuration:

This is an AppsFlyer premium feature.

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.

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 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