API reference

Send Event

post
https://webs2s.appsflyer.com/v1//event

Sets a custom user ID or an AppsFlyer user ID for the specified bundle, at least one identifier is required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The bundle ID for which the user ID(s) is to be set.

Body Params
string
required

Customer user ID (CUID) is a unique identifier set by you.

  • Use the identical identifier for events reported by any means to AppsFlyer. Meaning the same identifier is used in the Web SDK, mobile SDK, and S2S APIs.
  • Web SDK customer user ID
  • Populates raw data field: customer_user_id
string
required

Populate using the web dev key available on the Dashboard.

To get the Web Dev Key:

  1. In AppsFlyer, go to the My Apps tab
  2. Click View brand bundles
  3. Copy the required Web Dev Key
string
enum
required

Event attribute identifier for internal use by AppsFlyer. Always set to EVENT.

Allowed:
string
required
  • We use this parameter to differentiate conversion and non-conversion events using the event conversion list set by the marketer in PBA settings.
  • Ensure that you populate it with values consistent to the marketer's conversion logic.
  • Populates raw data field: event_name
int64
  • If no timestamp is sent, the time is set using the server time.
  • Events arriving late are timestamped using the current server time. Late means arrival after midnight UTC on the day following the event. For example, an event occurring on Monday must be processed before midnight UTC Tuesday.
  • Events having a timestamp in the future (relative to the current server time) are timestamped with the server time.
  • Populates raw data field: event_time
eventValue
object

Map of event parameters describing the event. Use this parameter to send rich in-app events like product SKU, line item price.

  • Note about revenue! You can populate this parameter with revenue details. In addition, you must populate eventRevenue, and eventRevenueCurrency.
  • Limitation: 1000 characters. Do not exceed this; it will be truncated.
  • Populates raw data field: event_value
string
enum

Populates raw data field: event_revenue_currency

double

Revenue (monetary value) assigned to an event.
Note! If revenue is reported in eventValue, report it also in eventRevenue and populate eventRevenueCurrency.

  • Negative values permitted. For example, a refund.
  • Populates raw data field: event_revenue
string

HTTP referrer

  • Populates raw data field: http_referrer
string

Populates raw data field: user_agent

string

User IP address
Where possible send the value of this field. It assists in determining the geo-location of the user.
Populates raw data field: ip

Responses

Updated 29 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 29 days ago