Skip to main content
Version: 3.x

Boost postbacks

When a player receives an active boost, TapResearch can notify your server via an HTTP postback.

Setup​

Boosts need to be enabled for your app title by the TapResearch team, please reach out to your account manager when you are ready to get started.

Once enabled, set your Boost postback URL under Settings → App title boosts in the Publisher Dashboard. Use an HTTPS URL and test it before saving.

Overview​

TapResearch sends active boosts to your endpoint as POST requests. Return a 2xx response to acknowledge receipt; failed requests are retried.

HTTP request​

POST <your configured URL>

PropertyValue
Content-Typeapplication/json

Payload​

The body is a JSON array. Each element represents one app and contains the list of boosted players for that app.

[
{
"api_token": "YOUR_API_TOKEN",
"players": [
{
"uid": "player-uid-123",
"boost": {
"start_date": "2026-03-17T12:00:00.000Z",
"end_date": "2026-03-17T13:00:00.000Z",
"boost_tag": "birthday_boost",
"boost_display_name": "Birthday Bonus",
"boost_multiplier": 2.0,
"boost_expiration_date": null
}
}
]
}
]

Payload fields​

FieldTypeDescription
api_tokenStringThe API token for the app the player belongs to
playersArrayList of boosted player objects for this app

Player object​

FieldTypeDescription
uidStringThe player's unique identifier
boostObjectThe active boost details

Boost object​

FieldTypeDescription
start_dateISO 8601When the boost became active (UTC)
end_dateISO 8601When the boost expires (UTC)
boost_tagStringInternal tag identifying the boost type (e.g., "birthday_boost")
boost_display_nameStringUser-facing name for the boost
boost_multiplierFloatThe multiplier applied to the player's rewards (e.g. 2.0 = 2x)
boost_expiration_dateISO 8601Expiration date for the boost record. Will be null if not applicable.

Response​

Return a 2xx status code to confirm receipt.