Skip to main content

Order

  • Alert key: squarespace-order
  • Source: Squarespace
  • Event list label: 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
{{displayname}}data.extraSettings.displaynameThe display name of the sender
{{items}}data.extraSettings.itemsThe items of the alert comma separated, such as shirt, keyblade, chaos emerald, etc.
{{itemsCount}}data.extraSettings.itemsCountNo description available yet.
{{item}}data.extraSettings.itemNo description available yet.
{{amount}}data.extraSettings.amountThe amount sent
{{currency}}data.extraSettings.currencyThe currency used
{{currencySymbol}}data.extraSettings.currencySymbolThe currency symbol used
{{orderNumber}}data.extraSettings.orderNumberNo description available yet.
{{orderId}}data.extraSettings.orderIdNo description available yet.
{{fulfillmentStatus}}data.extraSettings.fulfillmentStatusNo description available yet.
{{channel}}data.extraSettings.channelNo description available yet.
{{contentImage}}data.extraSettings.contentImageNo description available yet.
{{orderItems}}data.extraSettings.orderItemsNo 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) => …).

$25​

{
  "alert": "squarespace-order",
  "dynamic": {
    "value": 25,
    "currency": "USD"
  },
  "extraSettings": {
    "username": "lumiastream",
    "displayname": "lumiastream",
    "items": "Lumia Stream Tee",
    "item": "Lumia Stream Tee",
    "itemsCount": 1,
    "amount": 25,
    "currency": "USD",
    "orderNumber": "1001",
    "currencySymbol": "",
    "orderId": "",
    "fulfillmentStatus": "",
    "channel": "",
    "contentImage": "",
    "orderItems": "",
    "raw": ""
  }
}

$100​

{
  "alert": "squarespace-order",
  "dynamic": {
    "value": 100,
    "currency": "USD"
  },
  "extraSettings": {
    "username": "lumiastream",
    "displayname": "lumiastream",
    "items": "Lumia Stream Tee, Hoodie, Sticker Pack",
    "item": "Lumia Stream Tee",
    "itemsCount": 3,
    "amount": 100,
    "currency": "USD",
    "orderNumber": "1002",
    "currencySymbol": "",
    "orderId": "",
    "fulfillmentStatus": "",
    "channel": "",
    "contentImage": "",
    "orderItems": "",
    "raw": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

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