Skip to main content

Shop Order

  • Alert key: fourthwall-shopOrder
  • Source: Fourthwall
  • Event list label: Shop Order
  • Carries alert image: yes (extraSettings.contentImage)

Default message template​

{{username}} purchased {{items}}

Template variables​

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variableOverlay payload fieldDescription
{{username}}data.extraSettings.usernameThe username of the sender
{{email}}data.extraSettings.emailEmail of user
{{message}}data.extraSettings.messageThe message text sent by the user
{{items}}data.extraSettings.itemsThe items of the alert comma separated, such as shirt, keyblade, chaos emerald, etc.
{{itemsCount}}data.extraSettings.itemsCountNo description available yet.
{{itemsDetailed}}data.extraSettings.itemsDetailedNo description available yet.
{{orderItems}}data.extraSettings.orderItemsNo description available yet.
{{itemImages}}data.extraSettings.itemImagesNo description available yet.
{{friendlyId}}data.extraSettings.friendlyIdNo description available yet.
{{currency}}data.extraSettings.currencyThe currency used
{{amount}}data.extraSettings.amountThe amount sent
{{firstItem}}data.extraSettings.firstItemNo description available yet.
{{raw}}data.extraSettings.rawThe raw data that comes in through the platform for the alert. This is useful for custom code when data is needed that we don't provide by default.

Example payloads​

Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).

$100​

{
  "alert": "fourthwall-shopOrder",
  "dynamic": {
    "value": 100,
    "currency": "USD"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "amount": 100,
    "currency": "USD",
    "items": "Shirt, Keyblade, Chaos Emerald",
    "contentImage": "https://cdn.fourthwall.com/storefront-en/_next/image?url=https%3A%2F%2Fcdn.fourthwall.com%2Fpublic%2Flogos%2Ffw-logo-stacked-purple.png",
    "email": "",
    "message": "",
    "itemsCount": "",
    "itemsDetailed": "",
    "orderItems": "",
    "itemImages": "",
    "friendlyId": "",
    "firstItem": "",
    "raw": ""
  }
}

$200​

{
  "alert": "fourthwall-shopOrder",
  "dynamic": {
    "value": 200,
    "currency": "USD"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "amount": 200,
    "currency": "USD",
    "items": "Shirt, Keyblade, Chaos Emerald",
    "contentImage": "https://cdn.fourthwall.com/storefront-en/_next/image?url=https%3A%2F%2Fcdn.fourthwall.com%2Fpublic%2Flogos%2Ffw-logo-stacked-purple.png",
    "email": "",
    "message": "",
    "itemsCount": "",
    "itemsDetailed": "",
    "orderItems": "",
    "itemImages": "",
    "friendlyId": "",
    "firstItem": "",
    "raw": ""
  }
}

$300​

{
  "alert": "fourthwall-shopOrder",
  "dynamic": {
    "value": 300,
    "currency": "USD"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "amount": 300,
    "currency": "USD",
    "items": "Shirt, Keyblade, Chaos Emerald",
    "contentImage": "https://cdn.fourthwall.com/storefront-en/_next/image?url=https%3A%2F%2Fcdn.fourthwall.com%2Fpublic%2Flogos%2Ffw-logo-stacked-purple.png",
    "email": "",
    "message": "",
    "itemsCount": "",
    "itemsDetailed": "",
    "orderItems": "",
    "itemImages": "",
    "friendlyId": "",
    "firstItem": "",
    "raw": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_CURRENCY_NUMBER - Donation Amount is equal to
  • GREATER_CURRENCY_NUMBER - Donation Amount is greater than or equal to
  • EQUAL_VARIABLE