iPixel Events Reference¶

Required Events¶

page_view¶

Trigger when a user navigates to a new page. Fire on every page.

Name	Type	Required	Description
`user_id`	string	false	Unique identifier for the customer (min 6 characters)

view_item¶

Trigger when a user lands on a specific product page.

Name	Type	Required	Description
`items`	array	true	The items for the event
`currency`	string	recommended	Currency in ISO 4217 format
`user_id`	string	false	Unique identifier for the customer
`value`	number	false	Sum of (price * quantity) for all items, excluding shipping/tax

add_to_cart¶

Trigger when an item is added to cart.

Name	Type	Required	Description
`items`	array	true	The items for the event
`currency`	string	recommended	Currency in ISO 4217 format
`user_id`	string	false	Unique identifier for the customer
`value`	number	false	Sum of (price * quantity) for all items

begin_checkout¶

Trigger when a user begins checkout.

Name	Type	Required	Description
`items`	array	true	The items for the event
`currency`	string	true	Currency in ISO 4217 format
`value`	number	true	Sum of (price * quantity) for all items
`user_id`	string	false	Unique identifier for the customer

purchase¶

Trigger when items are purchased.

Name	Type	Required	Description
`currency`	string	true	Currency in ISO 4217 format
`items`	array	true	The items for the event
`transaction_id`	string	true	Unique transaction identifier (prevents duplicates)
`value`	number	true	Sum of (price * quantity) for all items
`shipping`	number	recommended	Shipping cost
`tax`	number	recommended	Tax cost
`user_id`	string	recommended	Unique identifier for the customer

Recommended Events¶

add_payment_info¶

Trigger when payment information is submitted.

Name	Type	Required	Description
`currency`	string	recommended	Currency in ISO 4217 format
`items`	array	recommended	The items for the event
`payment_type`	string	recommended	The payment type used
`value`	number	recommended	Sum of (price * quantity) for all items
`user_id`	string	false	Unique identifier for the customer
`coupon`	string	false	Coupon name/code

generate_lead¶

Trigger when a lead is generated (e.g., through a form).

Name	Type	Required	Description
`currency`	string	false	Three-letter ISO 4217 currency code
`user_id`	string	false	Unique identifier for the customer
`value`	number	false	Monetary value of the event
`lead_source`	string	false	The source of the lead

sign_up¶

Trigger when a user registers for an account.

Name	Type	Required	Description
`method`	string	recommended	The registration method used
`user_id`	string	recommended	Unique identifier for the customer

Trigger when a user logs into an account.

Name	Type	Required	Description
`user_id`	string	recommended	Unique identifier for the customer

view_cart¶

Trigger when a user views their cart.

Name	Type	Required	Description
`items`	array	true	The items for the event
`currency`	string	recommended	Currency in ISO 4217 format
`value`	number	recommended	Sum of (price * quantity) for all items
`user_id`	string	false	Unique identifier for the customer

remove_from_cart¶

Trigger when a user removes an item from their cart.

Name	Type	Required	Description
`items`	array	true	The items for the event
`currency`	string	recommended	Currency in ISO 4217 format
`user_id`	string	false	Unique identifier for the customer
`value`	number	false	Sum of (price * quantity) for all items

Trigger when a user subscribes to a service.

Name	Type	Required	Description
`currency`	string	false	Currency in ISO 4217 format
`user_id`	string	false	Unique identifier for the customer
`value`	number	false	Monetary value of the event

search¶

Trigger when a user searches for content.

Name	Type	Required	Description
`search_term`	string	true	The term the user searched for
`results`	array	recommended	The search result items
`user_id`	string	false	Unique identifier for the customer