Webhooks

Webhooks

Webhooks notify your system when relevant order or product events occur in TPP. Each webhook is sent as a JSON payload with an event name and a payload object.

Webhook consumers should handle repeated deliveries idempotently.

Event Format

{
  "event": "order.created",
  "data": {
    "transactionId": "txn_123",
    "productId": "product_123",
    "playerId": "player_123",
    "externalPlayerId": "external_player_123"
  }
}

externalPlayerId is included when it is available for the player.

Orders

Order webhooks are sent when the lifecycle of an order changes.

Events

EventDescription
order.createdAn order has been created.
order.sentThe order has been sent.
order.delayedThe order has been delayed.
order.cancelledThe order has been cancelled.
order.acquiredThe order has been acquired by the player.

Payload

All order events include these fields:

AttributeTypeRequiredDescription
transactionIdstringYesOrder transaction identifier.
productIdstringYesProduct identifier associated with the order.
playerIdstringYesTPP player identifier.
externalPlayerIdstringNoExternal player identifier, when available.
reasonstringFor order.delayed and order.cancelledPredefined reason code.

Reason Codes

CodeDescription
CUSTOMSThe order is blocked or delayed by customs.
PACKAGE_LOSTThe package has been lost.
PRODUCT_UNAVAILABLEThe product is no longer available.

Additional reason codes may be added in the future. Integrations should store unknown codes as received.

Created Example

{
  "event": "order.created",
  "data": {
    "transactionId": "txn_123",
    "productId": "05a3647a-18ed-4e62-bd4a-299ad4cd7f8e",
    "playerId": "player_123",
    "externalPlayerId": "external_player_123"
  }
}

Delayed Example

{
  "event": "order.delayed",
  "data": {
    "transactionId": "txn_123",
    "productId": "05a3647a-18ed-4e62-bd4a-299ad4cd7f8e",
    "playerId": "player_123",
    "externalPlayerId": "external_player_123",
    "reason": "CUSTOMS"
  }
}

Cancelled Example

{
  "event": "order.cancelled",
  "data": {
    "transactionId": "txn_123",
    "productId": "05a3647a-18ed-4e62-bd4a-299ad4cd7f8e",
    "playerId": "player_123",
    "reason": "PRODUCT_UNAVAILABLE"
  }
}

Products

Product webhooks are sent when product data changes. Every product event includes the full product object.

Events

EventDescription
product.createdA product has been created.
product.stockProduct stock has changed.
product.statusProduct status has changed.

Payload

AttributeTypeRequiredDescription
productobjectYesFull product object after the event has been applied.

Product Example

{
  "event": "product.status",
  "data": {
    "product": {
      "certificate": false,
      "status": "available",
      "stock": -1,
      "order": "",
      "weight": "0",
      "probability": "0",
      "price": 800,
      "establishmentValueInEuros": null,
      "height": 0,
      "verifiedBy": "",
      "imageUrl": "https://tpp-media-bucket.s3.eu-north-1.amazonaws.com/uploads/product-images/2026/04/02/row-26-fde08fb1-7ee3-4511-b4c7-5d0045d97e20.jpg",
      "year": 0,
      "verificationDate": "2026-04-02T15:48:56.000Z",
      "createdAt": "2026-04-02 15:48:56",
      "productId": "05a3647a-18ed-4e62-bd4a-299ad4cd7f8e",
      "type": "consumer",
      "owner": "",
      "isOwned": false,
      "digital": false,
      "featured": false,
      "catalogs": [
        {
          "establishmentId": "33450a3a-7053-4450-958d-889cb45332bc",
          "catalogId": "eec0cd74-57f2-456a-9113-7eae78c247ca",
          "name": "888Hold"
        }
      ],
      "providers": [],
      "medias": [],
      "translations": {
        "en-EN": {
          "name": "APPLE CARGADOR 5W - USB-A 5W POWER ADAPTER AA - WHITE",
          "description": "Power and connectivity at your fingertips. Designed to provide fast charging, durability, and compatibility with multiple devices.",
          "extendedDescription": "Certified and safe product. Fast shipping and official manufacturer warranty. Compatible with multiple models.",
          "additionalDetails": "Power and connectivity always within your reach."
        },
        "es-ES": {
          "name": "APPLE CARGADOR 5W - USB-A 5W POWER ADAPTER AA - WHITE",
          "description": "Energía y conectividad al alcance de tu mano. Diseñados para ofrecer carga rápida, durabilidad y compatibilidad con múltiples dispositivos.",
          "extendedDescription": "Producto certificado y seguro. Envío rápido y garantía oficial del fabricante. Compatible con múltiples modelos.",
          "additionalDetails": "Energía y conectividad siempre a tu alcance."
        },
        "de-DE": {
          "name": "APPLE CARGADOR 5W - USB-A 5W POWER ADAPTER AA - WHITE",
          "description": "",
          "extendedDescription": "",
          "additionalDetails": ""
        },
        "fr-FR": {
          "name": "APPLE CARGADOR 5W - USB-A 5W POWER ADAPTER AA - WHITE",
          "description": "Energia e connettività a portata di mano. Progettati per offrire ricarica rapida, durata e compatibilità con più dispositivi.",
          "extendedDescription": "Produit certifié et sûr. Expédition rapide et garantie officielle du fabricant. Compatible avec plusieurs modèles.",
          "additionalDetails": "Énergie et connectivité toujours à portée de main."
        },
        "it-IT": {
          "name": "",
          "description": "Energia e conectividade ao seu alcance. Projetados para oferecer carregamento rápido, durabilidade e compatibilidade com múltiplos dispositivos.",
          "extendedDescription": "Prodotto certificato e sicuro. Spedizione rapida e garanzia ufficiale del produttore. Compatibile con più modelli.",
          "additionalDetails": "Energia e connettività sempre a portata di mano."
        },
        "pt-BR": {
          "name": "APPLE CARGADOR 5W - USB-A 5W POWER ADAPTER AA - WHITE",
          "description": "Énergie et connectivité à portée de main. Conçus pour offrir une charge rapide, durabilité et compatibilité avec plusieurs appareils.",
          "extendedDescription": "Produto certificado e seguro. Envio rápido e garantia oficial do fabricante. Compatível com múltiplos modelos.",
          "additionalDetails": "Energia e conectividade sempre ao seu alcance."
        }
      },
      "category": {
        "categoryId": "a9ca822c-974f-4632-bd8f-97ed589229ac",
        "name": "Technology & Electronics",
        "translations": {
          "en-EN": {
            "name": "Technology & Electronics",
            "description": ""
          },
          "es-ES": {
            "name": "Tecnología y Electrónica",
            "description": ""
          },
          "de-DE": {
            "name": "",
            "description": ""
          },
          "fr-FR": {
            "name": "Technologie et Électronique",
            "description": ""
          },
          "it-IT": {
            "name": "Tecnologia ed Elettronica",
            "description": ""
          },
          "pt-BR": {
            "name": "Tecnologia e Eletrônicos",
            "description": ""
          }
        },
        "status": ""
      }
    }
  }
}