Use camelCase when sending properties — the platform automatically converts to the format each destination requires.
Full Event Structure
A complete tracking event contains the event name, timestamp, user data, custom data, and automatically captured context.Core Properties
These properties work with most events.value
Monetary value of the event. Required for purchase, lead, subscribe.
currency
ISO 4217 currency code. Required with value.
transactionId
Unique order identifier. Required for purchase/refund.
orderName
Human-readable order number shown to customers.
Quick Reference
| Property | Type | Required | Events |
|---|---|---|---|
value | number | Yes for purchase, lead, subscribe | purchase, add_to_cart, view_content, initiate_checkout, lead, subscribe, trial_started |
currency | string | Yes (when value is set) | Any event with value |
transactionId | string | Yes for purchase/refund | purchase, refund |
orderId | string | No | purchase, refund |
orderName | string | No | purchase |
orderId and transactionId are interchangeable — use whichever fits your system. If both are provided, transactionId takes precedence.Customer Properties
Properties for identifying customers. Used for identity resolution and destination matching.Primary identifier for cross-device tracking.
phone
E.164 format for improved matching.
firstName / lastName
Customer name for identity resolution.
Address Fields
Shipping and billing address properties.
Quick Reference
Checkout & Pricing Properties
Additional properties for checkout and purchase events.subtotalPrice
Subtotal before tax/shipping.
tax
Tax amount applied.
shipping
Shipping cost.
discount
Total discount amount.
coupon
Promo code used.
paymentType
Payment method used.
shippingTier
Shipping speed selected.
Quick Reference
| Property | Type | Description |
|---|---|---|
subtotalPrice | number | Subtotal before tax and shipping |
price | number | Base price (distinct from value which is the total) |
tax | number | Tax amount |
shipping | number | Shipping cost |
discount | number | Total discount amount applied |
coupon | string | Coupon or promo code used |
paymentType | string | Payment method ("credit_card", "paypal", "shop_pay") |
shippingTier | string | Shipping tier ("standard", "express", "overnight") |
cartId | string | Shopping cart identifier |
affiliation | string | Store or affiliate name |
orderSourceName | string | Order source channel |
tags | string[] | Array of order or event tags |
totalUnitCost | number | Total cost of goods sold (COGS) for profitability tracking |
totalUnitMargin | number | Total margin (value - totalUnitCost) |
Content Properties
Properties for content-related events like search and page views.searchTerm
Search query entered by the user.
content_ids
Array of product IDs from search results.
Quick Reference
| Property | Type | Description | Events |
|---|---|---|---|
searchTerm | string | Search query entered | search |
content_ids | string[] | Array of product IDs | view_content, search, add_to_cart |
content_type | string | "product" or "product_group" | view_content, add_to_cart, purchase |
content_name | string | Name of content, product, or form | view_content, lead, complete_registration |
num_items | number | Total item count | add_to_cart, initiate_checkout, purchase |
page_title | string | Page title | page_view |
referrer | string | Referring URL | page_view |
Promotional Properties
Properties for tracking promotions, campaigns, and affiliate activity.promotionId
Promotion/campaign identifier.
promotionName
Promotion display name.
creativeName
Creative/ad variant name.
creativeSlot
Placement position on page.
locationId
Store/affiliate/location ID.
Quick Reference
| Property | Type | Description | Events |
|---|---|---|---|
promotionId | string | Promotion or campaign identifier | view_content, add_to_cart, purchase |
promotionName | string | Promotion display name | view_content, add_to_cart, purchase |
creativeName | string | Creative or ad variant name | view_content, add_to_cart, purchase |
creativeSlot | string | Creative placement position | view_content, add_to_cart, purchase |
locationId | string | Store, affiliate, or location identifier | All events |
Detailed Property References
Items Array
Product details for e-commerce events — id, name, price, quantity, brand, category, variant.
Address Properties
Shipping and billing address fields — address1, city, province, country, zip.
SaaS Properties
B2B/SaaS properties — account, subscription, trial, payment, and churn tracking.
Auto-Captured Fields
Click IDs, UTMs, and context fields captured automatically by the pixel.
Naming Conventions
Input vs Output Format
Send properties in camelCase — the platform converts to each destination’s required format automatically.| Your Input | Meta CAPI Output | GA4 Output |
|---|---|---|
transactionId | transaction_id | transaction_id |
firstName | fn (hashed) | first_name |
email | em (hashed) | user_id (if configured) |
Legacy Snake Case Properties
Some properties use snake_case for compatibility with Meta and GA4 conventions:| Property | Format | Notes |
|---|---|---|
content_ids | snake_case | Array of product IDs (Meta convention) |
content_type | snake_case | "product" or "product_group" (Meta convention) |
content_name | snake_case | Content or product name |
num_items | snake_case | Total item count |
The platform accepts both formats and normalizes automatically. You can use either
contentIds or content_ids — both work.Event Names
Event names use snake_case (e.g.,add_to_cart, initiate_checkout, view_content).