Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.subtotal.com/llms.txt

Use this file to discover all available pages before exploring further.

Subtotal delivers the following custom events to Braze via the users.track endpoint. Each event can be used to trigger campaigns, build segments, or power Canvas journeys.

​
subtotal_purchase

Triggered when a purchase is detected for a connected account. Sent for each historical purchase and for any newly detected purchases.
KeyTypeDescription
purchase_idstringIdentifier for the purchase
totalstringThe grand total paid by the customer
taxstringThe sales tax that was paid
subtotalstringThe subtotal of the purchase
item_countnumberThe number of items in the purchase
retailerstringIdentifier for the retailer where the purchase was made
upcsarrayThe UPCs associated with each item in the purchase
brandsarrayThe brands associated with each item in the purchase
sourcestringAlways "subtotal"
Example 
{
  "purchase_id": "01KEVN1ZPM9H19JSHGN5NF0M69",
  "total": "44.64",
  "tax": "1.60",
  "subtotal": "43.04",
  "item_count": 15,
  "retailer": "walmart",
  "upcs": ["040000476528", "016000124790", "041331027878", "013000001243", "049000031171"],
  "brands": ["frenchs", "heinz", "spam", "jif", "cheerios"],
  "source": "subtotal"
}

​
subtotal_account_connected

Triggered when a consumer links a retail account.
KeyTypeDescription
connection_idstringIdentifier for the connection
retailerstringIdentifier for the retailer
sourcestringAlways "subtotal"
Example 
{
  "connection_id": "01KFRSK9J11G807TAY0GCYSW67",
  "retailer": "walmart",
  "source": "subtotal"
}

​
subtotal_account_disconnected

Triggered when a consumer disconnects a retail account.
KeyTypeDescription
connection_idstringIdentifier for the connection
retailerstringIdentifier for the retailer
link_urlstringThe Link URL that can be used to reconnect the account
sourcestringAlways "subtotal"
Example 
{
  "connection_id": "01KFRSK9J11G807TAY0GCYSW67",
  "retailer": "walmart",
  "link_url": "https://link.subtotal.com/zSG5nWHy?connection_id=01KFRSK9J11G807TAY0GCYSW67",
  "source": "subtotal"
}

​
subtotal_connection_unauthenticated

Triggered when an active connection becomes unauthenticated and requires the customer to reauthenticate (e.g. after a retailer password change).
KeyTypeDescription
connection_idstringIdentifier for the connection
retailerstringIdentifier for the retailer
link_urlstringThe Link URL that can be used to reconnect the account
sourcestringAlways "subtotal"
Example 
{
  "connection_id": "01KFRSK9J11G807TAY0GCYSW67",
  "retailer": "walmart",
  "link_url": "https://link.subtotal.com/zSG5nWHy?connection_id=01KFRSK9J11G807TAY0GCYSW67",
  "source": "subtotal"
}

​
subtotal_connection_reauthenticated

Triggered when a consumer re-authenticates a previously unauthenticated connection.
KeyTypeDescription
connection_idstringIdentifier for the connection
retailerstringIdentifier for the retailer
sourcestringAlways "subtotal"
Example 
{
  "connection_id": "01KFRSK9J11G807TAY0GCYSW67",
  "retailer": "walmart",
  "source": "subtotal"
}