HomeStatus Page
API Reference

PIS Error Events

This webhook is a crucial component of Player Info Sync. It ensures that the offers configured by publishers are properly formatted before being presented to players. This webhook provides an error handling mechanism that notifies publishers of any issues with the data they submit, specifically related to offer configurations.

Webhook Endpoint

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

Event Data Structure

The following data will be included in the report:

  • timestamp (number): Timestamp of the event.
  • event (string): Type of event related to validation failure. Possible values are:
    • invalid_property_error: Player Info Sync has validation issues or did not pass the validation.
  • data (object): Information regarding the event failure, including:
    • requestId (string): A unique identifier (UUID v4) generated per request. Publishers can receive multiple validation events for the same requestId because we have different types of validation, such as schema validation and business logic validation.
    • playerId (string): The player ID returned during the player authentication phase.
    • offerExternalId (string, optional): The publisherOfferId. This will be included when the offer passes Player Info Sync schema validation but fails the business logic validation. It helps the publisher identify which offer is failing.
    • reason (string): The reason for the error, provided as a JSON stringified string. Publishers need to parse this string to retrieve the error details.

    Example Payload

    Here is an example of what the payload might look like: 
    {
   "timestamp":1726130178951,
   "event":"invalid_property_error",
   "data":{
      "requestId":"request-12345",
      "playerId":"player-67890",
      "offerExternalId":"offer-001",
      "reason":"
     [{\"property\":\"balances.1.quantity\",\"validationError\":\"quantity must have up to 24 digits, quantity must be greater than 0\"},{\"property\":\"balances.2.quantity\",\"validationError\":\"quantity must have up to 24 digits, quantity must be greater than 0\"},{\"property\":\"balances.2.publisherProductId\",\"validationError\":\"publisherProductId should not be empty, publisherProductId must be a string\"}]"
   }
}