Every interaction a customer has with your Shopify store generates an event. Upstack Data captures these events server-side, enriches them with identity and product data, and forwards them to your configured destinations.Documentation Index
Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt
Use this file to discover all available pages before exploring further.
How Events Are Captured
The Upstack Pixel is a lightweight script injected into your Shopify storefront via the theme app extension. When a visitor performs an action — viewing a page, adding a product to cart, completing a purchase — the pixel fires an event to the Upstack edge API. From there, events flow through a four-stage pipeline:- Capture — Upstack Pixel detects the interaction and sends a structured event payload to the Cloudflare edge API.
- Resolve — Upstack ID attaches identity data (email, phone, cookie, device) to the event, linking anonymous sessions to known customers.
- Enrich — Product catalog data, UTM parameters, and click IDs are merged into the event.
- Activate — The enriched event is forwarded to each configured destination (Meta CAPI, TikTok, Klaviyo, GA4, etc.) in the format each platform expects.
Standard Event Taxonomy
Standard events have well-defined names, properties, and semantics that all destinations understand. Using standard events ensures compatibility across your entire marketing stack.| Event Name | When It Fires | Key Properties |
|---|---|---|
| PageView | Every page load | page_url, page_title, referrer |
| ViewContent | Product or collection page viewed | content_ids, content_type, content_name, value, currency |
| AddToCart | Item added to cart | content_ids, content_type, value, currency, num_items |
| InitiateCheckout | Checkout flow started | content_ids, value, currency, num_items |
| Purchase | Order completed | content_ids, value, currency, order_id, num_items |
| Search | Site search performed | search_string, content_ids, content_type |
| Lead | Lead form submitted | value, currency, content_name |
| CompleteRegistration | Account created | content_name, value, currency |
| AddPaymentInfo | Payment method entered | content_ids, value, currency |
| AddShippingInfo | Shipping details entered | content_ids, value, currency |
| Subscribe | Email or SMS subscription | value, currency |
| StartTrial | Free trial initiated | value, currency, content_name |
| CustomEvent | Any merchant-defined event | Varies — see Custom Events |
All standard events include automatic context fields —
page_url, user_agent, ip_address, event_time, and identity signals — regardless of the event type. See Properties & Context for the full reference.How Destinations Receive Events
Each destination maps standard events to its own naming convention. For example, an UpstackPurchase event becomes:
- A Meta CAPI
Purchaseevent with hashedem,ph, andfbclidmatch keys - A TikTok Events API
CompletePaymentevent withttclidattached - A Klaviyo
Placed Orderevent with full product details - A GA4
purchaseevent withtransaction_idand line items
What’s Next
Standard Events Reference
Full specification for every standard event — required properties, optional fields, and example payloads.
Custom Events
Define your own events to capture interactions beyond the standard taxonomy.
Properties & Context
Complete reference for all user data, custom data, and context fields attached to events.
Identity & Stitching
How Upstack ID enriches events with resolved identity data.