​
Event overview

Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object. For example, when a payment succeeds, we create a payment_succees event, and when an order is refunded, we create a payment_refund event.

​
Event types

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

  • payment_success - A payment has been successfully processed.
  • payment_refund - A payment has been refunded.

​
Example object

{
  "id": "6f97c060-570d-46e8-81af-033539210df3",
  "data": {
    "items": [
      {
        "id": "a0bf335d-25b9-4eda-bf92-f45f7bd2ed18",
        "name": "Legendary Sword",
        "quantity": "1",
        "internalId": null
      }
    ],
    "order": {
      "id": "a41dc391-8475-48ea-916a-e730c7a9708d",
      "fee": 96,
      "tax": 276,
      "value": 1200,
      "country": "US",
      "currency": "USD",
      "totalItems": 1,
      "orderNumber": "113",
      "currencyDecimals": 2
    },
    "customer": {
      "email": "player123@customer.com"
    }
  },
  "type": "payment_success",
  "idempotencyKey": "6f97c060-570d-46e8-81af-033539210df3"
}
Custom Domain