Webstore Interaction Events

View insights into player behavior within the store, such as viewing available offers and interacting with loaded offers.

offers_shown

timestamp Required

String

The time when the event occurred.

Example 1632345000

playerId Required

String

The unique identifier of the player involved in the event.

Example 12345

sessionId Required

String

The session ID of the player’s current session.

Example 345397c6-d963-4aa4-a0ba-2aaca6c3ee05

appVersion

String

The game version.

Example 1.0.0

sessionMetaData

Object

Relevant only to PIS users, the player session metadata object received from the Player Info Sync Webhook.

Example { "metadata": "data" }

offers Required

Array

A list of offers related to the event. Each offer includes:

Offer Details

publisherOfferId

String

Unique identifier for the offer.

Example offer123

offerType

String

Type of the offer.

Optional Values: Bundle, SpecialOffer, PopUp

Example SpecialOffer

offerIndex

Number

The index of the offer in the list. Represents the day sequence of the daily bonus.

Example 1

indexToCollect

Number

The index of the sub-offer currently available to be collected in a rolling offer.

Example 4

Example Payload

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

{
    "timestamp": 1632345000,
    "playerId": "12345",
    "sessionId": 345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
    "appVersion": "1.0.0",
    "sessionMetaData": { "metadata": "data" },
    "offers": [
        {
            "publisherOfferId": "offer123",
            "offerType": "SpecialOffer",
            "offerIndex": 1,
            "indexToCollect": 4
        }
    ]
}

offers_loaded

timestamp Required

String

The time when the event occurred.

Example 1632345000

playerId Required

String

The unique identifier of the player involved in the event.

Example 12345

sessionId Required

String

The session ID of the player’s current session.

Example 345397c6-d963-4aa4-a0ba-2aaca6c3ee05

appVersion

String

The game version.

Example 1.0.0

sessionMetaData

Object

Relevant only to PIS users, the player session metadata object received from the Player Info Sync Webhook.

Example { "metadata": "data" }

offers Required

Array

A list of offers related to the event. Each offer includes:

Offer Details

publisherOfferId

String

Unique identifier for the offer.

Example offer123

offerType

String

Type of the offer.

Optional Values: Bundle, SpecialOffer, PopUp

Example SpecialOffer

offerIndex

Number

The index of the offer in the list. Represents the day sequence of the daily bonus.

Example 1

Example Payload

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

{
    "timestamp": 1632345000,
    "playerId": "12345",
    "sessionId": 345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
    "appVersion": "1.0.0",
    "sessionMetaData": { "metadata": "data" },
    "offers": [
        {
            "publisherOfferId": "offer123",
            "offerType": "SpecialOffer",
            "offerIndex": 1
        }
    ]
}

approval_request_displayed

timestamp Required

String

The time when the event occurred.

Example 1632345000

playerId Required

String

The unique identifier of the player involved in the event.

Example 12345

sessionId Required

String

The session ID of the player’s current session.

Example 345397c6-d963-4aa4-a0ba-2aaca6c3ee05

appVersion

String

The game version.

Example 1.0.0

sessionMetadata

Object

Relevant only to PIS users, the player session metadata object received from the Player Info Sync Webhook.

Example { "metadata": "data" }

offers Required

Array

A list of offers related to the event. Each offer includes:

Offer Details

publisherOfferId

String

Unique identifier for the offer.

Example offer123

offerType

String

Type of the offer.

Example deep_link

offerSubType

String

The subtype of the offer.

Example checkout_link

offerName

String

The name of the offer.

Example offer_name

offerId

String

A unique offer ID, automatically generated by Appcharge.

Example 67d6b74285b58f462adbebcb

offerIndex

Number

The index of the offer in the list. Represents the day sequence of the daily bonus.

Example 1

Example Payload

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

{
    "timestamp": 1632345000,
    "playerId": "12345",
    "sessionId": 345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
    "appVersion": "1.0.0",
    "sessionMetadata": { "metadata": "data" },
    "offers": [
        {
            "publisherOfferId": "offer123",
            "offerType": "deep_link",
            "offerSubType": "checkout_link",
            "offerName": "offer_name",
            "offerId": "67d6b74285b58f462adbebcb",
            "offerIndex": 1
        }
    ]
}

approval_request_closed

timestamp Required

String

The time when the event occurred.

Example 1632345000

playerId Required

String

The unique identifier of the player involved in the event.

Example 12345

sessionId Required

String

The session ID of the player’s current session.

Example 345397c6-d963-4aa4-a0ba-2aaca6c3ee05

appVersion

String

The game version.

Example 1.0.0

sessionMetadata

Object

Relevant only to PIS users, the player session metadata object received from the Player Info Sync Webhook.

Example { "metadata": "data" }

reason Required

String

Indicates why the popup was closed.

Optional Values: approve, not_me

Example approve

offers Required

Array

A list of offers related to the event. Each offer includes:

Offer Details

publisherOfferId

String

Unique identifier for the offer.

Example offer123

offerType

String

Type of the offer.

Example deep_link

offerSubType

String

The subtype of the offer.

Example checkout_link

offerName

String

The name of the offer.

Example offer_name

offerId

String

A unique offer ID, automatically generated by Appcharge.

Example 67d6b74285b58f462adbebcb

offerIndex

Number

The index of the offer in the list. Represents the day sequence of the daily bonus.

Example 1

Example Payload

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

{
    "timestamp": 1632345000,
    "playerId": "12345",
    "sessionId": 345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
    "appVersion": "1.0.0",
    "sessionMetadata": { "metadata": "data" },
    "reason": "approve",
    "offers": [
        {
            "publisherOfferId": "offer123",
            "offerType": "deep_link",
            "offerSubType": "checkout_link",
            "offerName": "offer_name",
            "offerId": "67d6b74285b58f462adbebcb",
            "offerIndex": 1
        }
    ]
}