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, you can set your boost postback URL in the App title boosts tab under Settings in the Supplier Dashboard. Your URL must begin with https:// and a successful test is required before saving.

Overview

A background job runs every 10 minutes and sends a POST request to your configured URL for each app title that has unnotified active boosts. A boost is included when:

  • Its start_date has passed
  • Its end_date is at least 1 hour in the future
  • It has not yet been notified

If a player has multiple active boosts, only the highest-multiplier boost is sent. On a successful response, those boosts are marked as notified and will not be resent. If the request fails or returns a non-2xx status, the boosts remain unnotified and will be retried on the next run.

HTTP Request

POST <your configured URL>

PropertyValue
Content-Typeapplication/json
Timeout10s

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:00Z",
"end_date": "2026-03-17T13:00:00Z",
"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
end_dateISO 8601When the boost expires
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

Your endpoint should return a 2xx status code to confirm receipt. Any other status — or a failed connection — will cause the boosts to be retried on the next job run.