Webhook List

This page contains a comprehensive list of all webhook events that Stash can send to your backend. Each webhook is triggered by specific user actions or system events.

Required Events

These events are essential for purchase processing and should always be subscribed to:

PURCHASE_SUCCEEDED

Products: Stash Pay, Stash Webshop

Sent when a purchase is successfully completed. This is the primary event for granting items to players.

When to use: Always subscribe to this event to grant items to players after successful payment.

Key Fields:

• orderId: Order identifier
• userId: External user ID
• items: Array of purchased items with quantities and prices
• total: Total amount paid
• currency: Currency code (e.g., "USD", "EUR")
• source: Indicates the source product ("StashPay" or "Cart" for Webshop)

Optional Events

These events are optional and primarily used for analytics, user behavior tracking, and marketing purposes:

Stash Webshop Events

The following events are specific to Stash Webshop:

MUTATE_CART

Product: Stash Webshop only

Sent when a user adds, removes, or modifies items in their cart.

Use Case: Track cart abandonment, analyze shopping behavior, trigger marketing campaigns.

VIEW_ITEM

Product: Stash Webshop only

Sent when a user views an item (debounced to once per 100 seconds per item).

Use Case: Product interest tracking, recommendation algorithms.

VIEW_CHECKOUT_PAGE

Product: Stash Webshop only

Sent when a user views the checkout page.

Use Case: Track checkout page visits, identify drop-off points.

VIEW_PRODUCT_DETAIL_PAGE

Product: Stash Webshop only

Sent when a user views a product detail page.

Use Case: Product interest tracking, content engagement metrics.

CART_BUTTON_CLICK

Product: Stash Webshop only

Sent when a user clicks the cart button/icon.

Use Case: Track cart interactions, shopping behavior analysis.

Shared Events

The following events can be sent by both Stash Pay and Stash Webshop:

CREATE_PAYMENT_INTENT

Products: Stash Pay, Stash Webshop

Sent when a payment intent is created (user initiates checkout).

Use Case: Track checkout initiation, payment method selection analytics.

FREE_ITEM_REDEEMED

Products: Stash Pay, Stash Webshop

Sent when a user redeems a free item (promotional items, rewards, etc.).

Use Case: Track promotional campaign effectiveness, user engagement.

Available webhooks

Payload structure

All webhooks follow a consistent structure with a base webhook object:

{
  "type": "EVENT_TYPE",
  "eventData": {
    // Event-specific payload data
  }
}

Detailed payload examples

PURCHASE_SUCCEEDED

Triggered when a purchase is successfully completed.

Note: The source field will be "StashPay" for purchases made through Stash Pay, or "Cart" for purchases made through Stash Webshop.

{
  "type": "PURCHASE_SUCCEEDED",
  "purchaseSucceeded": {
    "timeMillis": 1640995200000,
    "orderId": "order_abc123",
    "checkoutLinkId": "checkout_xyz789",
    "currency": "USD",
    "userId": "user_123",
    "items": [
      {
        "id": "item_456",
        "quantity": 2,
        "price": "9.99",
        "metadata": {
          "category": "weapons",
          "rarity": "legendary"
        }
      }
    ],
    "tax": "1.50",
    "total": "21.48",
    "taxDetails": {
      "items": [
        {
          "label": "Sales Tax",
          "isInclusive": false,
          "amount": "1.50",
          "percentage": "7.5",
          "country": "US",
          "state": "CA"
        }
      ]
    },
    "emailMarketingOptIn": true,
    "regionCode": "US",
    "source": "StashPay",
    "ipAddress": "192.168.1.1"
  }
}

MUTATE_CART

Triggered when cart contents are modified.

{
  "type": "MUTATE_CART",
  "mutateCart": {
    "cartId": "cart_789",
    "timeMillis": 1640995200000,
    "userId": "user_123",
    "items": [
      {
        "id": "item_456",
        "quantity": 3
      },
      {
        "id": "item_789",
        "quantity": -1
      }
    ],
    "regionCode": "US",
    "source": "Cart",
    "ipAddress": "192.168.1.1"
  }
}

VIEW_ITEM

Triggered when a user views an item.

{
  "type": "VIEW_ITEM",
  "viewItem": {
    "userId": "user_123",
    "itemId": "item_456",
    "regionCode": "US"
  }
}

CREATE_PAYMENT_INTENT

Triggered when payment process is initiated.

Note: The source field will be "StashPay" for Stash Pay or "Cart" for Stash Webshop.

{
  "type": "CREATE_PAYMENT_INTENT",
  "openPayment": {
    "cartId": "cart_789",
    "userId": "user_123",
    "items": [
      {
        "id": "item_456",
        "quantity": 2
      }
    ],
    "source": "StashPay"
  }
}

FREE_ITEM_REDEEMED

Triggered when a free item is redeemed.

{
  "type": "FREE_ITEM_REDEEMED",
  "freeItemRedeemed": {
    "userId": "user_123",
    "itemId": "item_free_001",
    "ipAddress": "192.168.1.1",
    "metadata": {
      "promotionId": "summer_promo",
      "redeemCode": "SUMMER2024"
    }
  }
}

VIEW_CHECKOUT_PAGE

Triggered when checkout page is viewed.

{
  "type": "VIEW_CHECKOUT_PAGE",
  "viewCheckoutPage": {
    "userId": "user_123",
    "regionCode": "US"
  }
}

VIEW_PRODUCT_DETAIL_PAGE

Triggered when product details are viewed.

{
  "type": "VIEW_PRODUCT_DETAIL_PAGE",
  "viewProductDetailsPage": {
    "userId": "user_123",
    "itemId": "item_456",
    "regionCode": "US"
  }
}

CART_BUTTON_CLICK

Triggered when cart buttons are clicked.

{
  "type": "CART_BUTTON_CLICK",
  "sendCartButtonClick": {
    "userId": "user_123",
    "regionCode": "US"
  }
}

Common fields

Several fields appear across multiple webhook types:

• userId: The external user identifier from your system
• regionCode: Unicode CLDR region code (e.g., "US", "FR") based on user location
• ipAddress: User's IP address when the event occurred
• timeMillis: Timestamp in milliseconds since Unix epoch