S2S Rewarded Callback API

AppLovin’s servers can make server-to-server rewarded callbacks to an external server that you define. These callbacks notify you that a user of your app completed a rewarded ad and so that user qualifies for a reward. This protects against malicious users who attempt to gain rewards without finishing rewarded ads.

Introduction

AppLovin’s servers can send callbacks to an external endpoint after the user completes a rewarded ad that MAX mediation serves. You define which endpoint receives these requests. The callbacks are in the form of HTTP or HTTPS GET requests. AppLovin makes these callbacks soon after the ad completion, but they may be delayed by a few minutes. You can use an impression timestamp macro to reconcile any delay between the impression and the callback times.

The callback request times-out if five seconds pass without a response from your endpoint. If the callback request times out, AppLovin will retry the callback up to two times.

You can configure these callbacks by setting the value of Server Side Callback URL in the Edit Ad Unit page for any of your rewarded Ad Units.

Example

Available macros

You can incorporate any of the macros in the following table into your callback URL. The example URL above incorporates the {IDFA}, {USER_ID}, {EVENT_ID}, and {EVENT_TOKEN} macros. AppLovin’s servers replace these macro names with accurate values when the servers make the callback to your endpoint.

¹ Note: if EVENT_TOKEN is one of your macros, it is omitted from the “All macros alphabetically” string

Setting an ad placement name

import AccordionItem from "/src/components/AccordionItem.astro";

The following code snippets show you how you can add a placement name to an ad unit. The value of the placement name replaces the {PLACEMENT} macro in postback requests:

Setting an internal user ID

The following code snippets show how to tag users with your own internal User ID. The maximum size of the User ID string is 8192 characters.

Accessing the amount and currency for a rewarded ad

To access the reward amount and currency, override the reward callback:

Custom data

import AccordionItem from "/src/components/AccordionItem.astro";

The following code snippets show you how to add custom String data to postbacks. This String data replaces the {CUSTOM_DATA} macro in these postbacks. AppLovin recommends that your string contain fewer than 8192 characters.

[COMPONENT: AdView]

[COMPONENT: AdView]

[COMPONENT: NativeAdView]

You must set custom data before you load a banner ad or MREC ad. Otherwise that data will not appear in the postbacks associated with the ad.