Reference

Reference for the Facebook pixel's fbq('track') function.

Standard Events

You can use the fbq('track') function to track the following standard events. Standard events also support parameter objects with specific object properties, which allow you to include detailed information about an event.

Event NameEvent DescriptionObject Properties

AddPaymentInfo

When payment information is added in the checkout flow.

A person clicks on a save billing information button.

content_category, content_ids, contents, currency, value

None required.

AddToCart

When a product is added to the shopping cart.

A person clicks on an add to cart button.

content_ids, content_name, content_type, contents, currency, value

None required.

Required for Dynamic Ads: content_ids, content_type, and contents

AddToWishlist

When a product is added to a wishlist.

A person clicks on an add to wishlist button.

content_name, content_category, content_ids, contents, currency, value

None required.

CompleteRegistration

When a registration form is completed.

A person submits a completed subscription or signup form.

content_name, currency, status, value

None required.

Contact

When a person initiates contact with your business via telephone, SMS, email, chat, etc.

A person submits a question about a product.
None required.

CustomizeProduct

When a person customizes a product.

A person selects the color of a t-shirt.
None required.

Donate

When a person donates funds to your organization or cause.

A person adds a donation to the Humane Society to their cart.
None required.

FindLocation

When a person searches for a location of your store via a website or app, with an intention to visit the physical location.

A person wants to find a specific product in a local store.
None required.

InitiateCheckout

When a person enters the checkout flow prior to completing the checkout flow.

A person clicks on a checkout button.

content_category, content_ids, contents, currency, num_items, value

None required.

Lead

When a sign up is completed.

A person clicks on pricing.

content_category, content_name, currency, value

None required.

PageView

This is the default pixel tracking page visits.

A person lands on your website pages.
None required.

Purchase

When a purchase is made or checkout flow is completed.

A person has finished the purchase or checkout flow and lands on thank you or confirmation page.

content_ids, content_name, content_type, contents, currency, num_items, value

Required: currency and value

Required for Dynamic Ads: content_ids, content_type, and contents

Schedule

When a person books an appointment to visit one of your locations.

A person selects a date and time for a dentist appointment.
None required.

Search

When a search is made.

A person searches for a product on your website.

content_category, content_ids, contents, currency, search_string, value

None required.

StartTrial

When a person starts a free trial of a product or service you offer.

A person selects a free week of your game.

currency, predicted_ltv, value

None required.

SubmitApplication

When a person applies for a product, service, or program you offer.

A person applies for a credit card, educational program, or job.
None required.

Subscribe

When a person applies to a start a paid subscription for a product or service you offer.

A person subscribes to your streaming service.

currency, predicted_ltv, value

None required.

ViewContent

When a key page is viewed such as a product page.

A person lands on a product details page.

content_ids, content_name, content_type, contents, currency, value

None required.

Required for Dynamic Ads: content_ids, content_type, and contents

Object Properties

You can include the following predefined object properties with any custom events, and any standard events that support them. Format your parameter object data using JSON.

Property KeyValue TypeParameter Description

content_category

String

Category of the page/product.

content_ids

Array of integers or strings

Product IDs associated with the event, such as SKUs (e.g. ['ABC123', 'XYZ789']).

content_name

String

Name of the page/product.

content_type

String

Either product or product_group based on the content_ids or contents being passed. If the IDs being passed in content_ids or contents parameter are IDs of products then the value should be product. If product group IDs are being passed, then the value should be product_group.

contents

Array of objects

An array of JSON objects that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) associated with the event as well as quantities and prices of the products. id, quantity, and item_price are the required fields. e.g. [{'id': 'ABC123', 'quantity': 2, 'item_price': 5.99}, {'id': 'XYZ789', 'quantity': 2, 'item_price': 9.99}]. Note that item_price is the price of a single item, not cumulative price.

currency

String

The currency for the value specified.

num_items

Integer

Used with InitiateCheckout event. The number of items when checkout was initiated.

predicted_ltv

Integer, float

Predicted lifetime value of a subscriber as defined by the advertiser and expressed as an exact value.

search_string

String

Used with the Search event. The string entered by the user for the search.

status

Boolean

Used with the CompleteRegistration event, to show the status of the registration.

value

Integer or float

The value of a user performing this event to the business.