Overview

The Offers Loaded event occurs one time when the store is first opened. It tells the publisher which offers will be available to the player during their session, even if they’re not all shown at once. This provides a complete list of what the player can potentially see in the store.

Webhook Endpoint

• URL: https://{publisher-server}/events
• Method: POST

Event Data Structure

The following data will be included in the report:

• event (string): The type of event related to the offer. Possible values are:
  • offers_shown: Indicates an offer was shown to a player.
  • offers_loaded: Indicates that offers were loaded.
• timestamp (string): The time when the event occurred.
• playerId (string): The unique identifier of the player involved in the event.
• offers (array): A list of offers related to the event. Each offer includes:
  • publisherOfferId (string): Unique identifier for the offer.
  • offerType (string): Type of the offer. Possible values are Bundle, SpecialOffer, or PopUp.
  • offerSubType (string, optional): Subtype of the offer. Will only be sent if offerType is PopUp. Possible values are DailyBonus or PostPurchase.
  • pricePoint (number, optional): The base price of the offer.
  • offerIndex (number, optional): The index of the offer in the list.
  • products (array, optional): Publisher products. If sent, it will include:
    • publisherProductId (string): The publisher's product ID.
    • amount (string): The quantity of the product. Must be between 0 and 24 digits long.

Example Payload

Here is an example of what the payload might look like:

{
   "timestamp":1726130178951,
   "event":"offers_loaded",
   "playerId":"player ID",
   "offers":[
      {
         "publisherOfferId":"time1",
         "offerType":"Bundle",
         "pricePoint":20.99,
         "products":[
            {
               "publisherProductId":"main_product_1",
               "amount":"300000000"
            },
            {
               "publisherProductId":"time_product_1",
               "amount":"122"
            }
         ]
      }
   ]
}