Facebook App Events Reference

Android

Standard Events

Event Name: AppEventsConstants Value	Parameters	Description
Achieve Level: `EVENT_NAME_ACHIEVED_LEVEL`	`LEVEL`	The achievement of specific levels you define within your application, business or organization.
Activate App: `EVENT_NAME_ACTIVATED_APP`		The launch of your app.
In-App Ad Click: `EVENT_NAME_AD_CLICK`	`AD_TYPE`	An ad from a third-party platform is clicked within your app.
In-App Ad Impression: `EVENT_NAME_AD_IMPRESSION` valueToSum: Ad impression value to be added	`AD_TYPE`	An ad from a third-party platform appears on-screen within your app. If valueToSum is provided, the event can be used for in-app ads optimization. The valueToSum value represents the in-app ads revenue generated from a user viewing an ad in your app. Refer to the documentation here to learn about maximizing the value of in-app ad impressions.
Add Payment Info: `EVENT_NAME_ADDED_PAYMENT_INFO`	`SUCCESS`	The addition of customer payment information during a checkout process.
`Schedule`	See App Events Schema
`Subscribe`	See App Events Schema
Add to Cart: `EVENT_NAME_ADDED_TO_CART` valueToSum: Price of item added	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	The addition of an item to a shopping cart or basket. For example, clicking an Add to Cart button on a website.
Add to Wishlist: `EVENT_NAME_ADDED_TO_WISHLIST` valueToSum: Price of item added	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	The addition of items to a wishlist. For example, clicking an Add to Wishlist button on a website.
Complete Registration: `EVENT_NAME_COMPLETED_REGISTRATION`	`REGISTRATION_METHOD`	A submission of information by a customer in exchange for a service provided by your business. For example, sign up for an email subscription.
Complete Tutorial: `EVENT_NAME_COMPLETED_TUTORIAL`	`SUCCESS`, and `CONTENT_ID` or `CONTENT`	A completion of a tutorial on your app.
Contact: `EVENT_NAME_CONTACT`		A telephone or SMS, email, chat or other type of contact between a customer and your business.
Customize Product: `EVENT_NAME_CUSTOMIZE_PRODUCT`		The customization of products through a configuration tool or other application your business owns.
Donate: `EVENT_NAME_DONATE`		The donation of funds to your organization or cause.
Find Location: `EVENT_NAME_FIND_LOCATION`		When a person finds one of your locations via web or app, with an intention to visit. For example, searching for a product and finding it at one of your local stores.
Initiate Checkout: `EVENT_NAME_INITIATED_CHECKOUT` valueToSum: Total price of items in cart	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`,`NUM_ITEMS`, `PAYMENT_INFO_AVAILABLE`, and `CURRENCY`	The start of a checkout process.
Purchase: `EVENT_NAME_PURCHASED` valueToSum: Price of Purchase	`NUM_ITEMS`, `CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	The completion of a purchase, usually signified by receiving order or purchase confirmation or a transaction receipt.
Rate: `EVENT_NAME_RATED` valueToSum: Rating given	`CONTENT_TYPE` , `CONTENT_ID` or `CONTENT`, and `MAX_RATING_VALUE`	A rating of something within your app, business or organization. For example, rates a restaurant within a restaurant review app.
Schedule: `EVENT_NAME_SCHEDULE`		The booking of an appointment to visit one of your locations.
Search: `EVENT_NAME_SEARCHED`	`CONTENT_TYPE`, `SEARCH_STRING` and `SUCCESS`	A search performed on your website, app or other property, such as product searches, travel searches, etc.
Spent Credits: `EVENT_NAME_SPENT_CREDITS` valueToSum: Total value of credits spent	`CONTENT_TYPE`, and `CONTENT_ID` or `CONTENT`	The completion of a transaction where people spend credits specific to your business or application, such as in-app currency.
Start Trial: `EVENT_NAME_START_TRIAL` valueToSum: Price of Subscription	`SUBSCRIPTION_ID` and `CURRENCY`	The start of a free trial of a product or service you offer, such as a trial subscription.
Submit Application: `EVENT_NAME_SUBMIT_APPLICATION`		The submission of an application for a product, service or program you offer, such as a credit card, educational program or job.
Subscribe: `EVENT_NAME_SUBSCRIBE` valueToSum: Price of Subscription	`SUBSCRIPTION_ID` and `CURRENCY`	The start of a paid subscription for a product or service you offer.
Unlock Achievement: `EVENT_NAME_UNLOCKED_ACHIEVEMENT`	`DESCRIPTION`	The completion of specific activities or actions you want to reward within your application, business or organization. For example, refer a friend, complete your profile, etc.
View Content: `EVENT_NAME_VIEWED_CONTENT` Price of item viewed (if applicable)	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	A visit to a content page you care about, such as a product page, landing page or article. Information about the page viewed can be passed to Facebook for use in dynamic ads.

Standard Event Parameters

AppEventConstants::EVENT_PARAM_*	Possible Values	Description
Ad Type: `EVENT_PARAM_AD_TYPE`	`string`	Type of ad: banner, interstitial, rewarded_video, native
Content ID: `EVENT_PARAM_CONTENT_ID`	`string`	International Article Number (EAN) when applicable, or other product or content identifier
Content: `EVENT_PARAM_CONTENT`	`string`	A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) as well as additional information about the products. `id` and `quantity` are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2}, {\"id\": \"5678\", \"quantity\": 1}]"
Content Type: `EVENT_PARAM_CONTENT_TYPE`	`string`	'product' or 'product_group'
Currency: `EVENT_PARAM_CURRENCY`	`string`	ISO 4217 code, e.g., "EUR", "USD", "JPY"
Description: `EVENT_PARAM_DESCRIPTION`	`string`	A string description
Level: `EVENT_PARAM_LEVEL`	`string`	Level of a game
Max. Rating Value: `EVENT_PARAM_MAX_RATING_VALUE`	`int`	Upper bounds of a rating scale, for example 5 on a 5 star scale
Number of Items: `EVENT_PARAM_NUM_ITEMS`	`int`	Number of items
Order ID: `EVENT_PARAM_ORDER_ID`	`string`	The unique ID for all events within a subscription
Payment Info Available: `EVENT_PARAM_PAYMENT_INFO_AVAILABLE`	`1` or `0`	`1` for yes, `0` for no
Registration Method: `EVENT_PARAM_REGISTRATION_METHOD`	`string`	Facebook, Email, Twitter, etc.
Search String: `EVENT_PARAM_SEARCH_STRING`	`string`	The text string that was searched for
Success: `EVENT_PARAM_SUCCESS`	`1` or `0`	`1` for yes, `0` for no

iOS

App Store Connect for iOS 14

Events that your app collects and sends to Facebook may require you to disclose these data types in the App Store Connect questionnaire. It is your responsibility to ensure this is reflected in your application’s privacy policy. Visit the Apple App Store Privacy Details article to learn more about the data types you will need to disclose.

Standard Events

Event Name: FBSDKAppEventName	Parameters	Description
Achieve Level: `FBSDKAppEventNameAchievedLevel`	`Level`	The achievement of specific levels you define within your application, business or organization.
Activate App: `FBSDKAppEventNameActivatedApp`		The launch of your app.
In-App Ad Click: `FBSDKAppEventNameAdClick`	`AdType`	An ad from a third-party platform is clicked within your app.
In-App Ad Impression: `FBSDKAppEventNameAdImpression`	`AdType`	An ad from a third-party platform appears on-screen within your app.
Add Payment Info: `FBSDKAppEventNameAddedPaymentInfo`	`Success`	The addition of customer payment information during a checkout process.
Add to Cart: `FBSDKAppEventNameAddedToCart` valueToSum: Price of item added	`ContentType`, `ContentID` or `Content`, and `Currency`	The addition of an item to a shopping cart or basket. For example, clicking an Add to Cart button on a website.
Add to Wishlist: `FBSDKAppEventNameAddedToWishlist` valueToSum: Price of item added	`ContentType`, `ContentID` or `Content`, and `Currency`	The addition of items to a wishlist. For example, clicking an Add to Wishlist button on a website.
Complete Registration: `FBSDKAppEventNameCompletedRegistration`	`RegistrationMethod`	A submission of information by a customer in exchange for a service provided by your business. For example, sign up for an email subscription.
Complete Tutorial: `FBSDKAppEventNameCompletedTutorial`	`Success`, and `ContentID` or `Content`	A completion of a tutorial on your app.
Contact: `FBSDKAppEventNameContact`		A telephone or SMS, email, chat or other type of contact between a customer and your business.
Customize Product: `FBSDKAppEventNameCustomizeProduct`		The customization of products through a configuration tool or other application your business owns.
Donate: `FBSDKAppEventNameDonate`		The donation of funds to your organization or cause.
Find Location: `FBSDKAppEventNameFindLocation`		When a person finds one of your locations via web or app, with an intention to visit. For example, searching for a product and finding it at one of your local stores.
Initiate Checkout: `FBSDKAppEventNameInitiatedCheckout` valueToSum: Total price of items in cart	`ContentType`, `ContentID` or `Content`, `NumItems`, `PaymentInfoAvailable`, and `Currency`	The start of a checkout process.
~~Purchase: `FBSDKAppEventNamePurchased`~~ Use the `logPurchase` method instead. valueToSum: Purchase price	`NumItems`, `ContentType`, `ContentID` or `Content`, and `Currency`	The completion of a purchase, usually signified by receiving order or purchase confirmation or a transaction receipt.
Rate: `FBSDKAppEventNameRated` valueToSum: Rating given	`ContentType`, `ContentID` or `Content`, and `MaxRatingValue`	A rating of something within your app, business or organization. For example, rates a restaurant within a restaurant review app
Schedule: `FBventNameSchedule`		The booking of an appointment to visit one of your locations.
Search: `FBSDKAppEventNameSearched`	`ContentType`, `SearchString`, and `Success`	A search performed on your website, app or other property, such as product searches, travel searches, etc.
Spent Credits: `FBSDKAppEventNameSpentCredits` valueToSum: Total value of credits spent	`ContentType`, and `ContentID` or `Content`	The completion of a transaction where people spend credits specific to your business or application, such as in-app currency.
Start Trial: `FBSDKAppEventNameStartTrial` valueToSum: Total value of credits spent	`OrderID` and `Currency`	The start of a free trial of a product or service you offer, such as a trial subscription.
`Schedule`	See App Events Schema
Submit Application: `FBSDKAppEventNameSubmitApplication`		The submission of an application for a product, service or program you offer, such as a credit card, educational program or job.
`Subscribe`	See App Events Schema
Subscription: `FBSDKAppEventNameSubscription` valueToSum: Price of Subscription	`OrderID` and `Currency`	The start of a paid subscription for a product or service you offer.
Unlock Achievement: `FBSDKAppEventNameUnlockedAchievement`	`Description`	The completion of specific activities or actions you want to reward within your application, business or organization. For example, refer a friend, complete your profile, etc.
View Content: `FBSDKAppEventNameViewedContent` valueToSum: Price of item viewed (if applicable)	`ContentType`, `ContentID` or `Content`, and `Currency`	A visit to a content page you care about, such as a product page, landing page or article. Information about the page viewed can be passed to Facebook for use in Advantage+ catalog ads.

Standard Event Parameters

Parameter: FBSDKAppEventParameterName	Possible Values	Description
Ad Type: `FBSDKAppEventParameterNameAdType`	`string`	Type of ad: banner, interstitial, reward_video, native
Content: `FBSDKAppEventParameterNameContent`	`string`	A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifiers and additional information about the products. `id` and `quantity` are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2}, {\"id\": \"5678\", \"quantity\": 1}]"
Content ID: `FBSDKAppEventParameterNameContentID`	`string`	International Article Number (EAN) when applicable, or other product or content identifier
Content Type: `FBSDKAppEventParameterNameContentType`	`string`	`product` or `product_group`
Currency: `FBSDKAppEventParameterNameCurrency`	`string`	ISO 4217 code, for example, `EUR`, `USD`, `JPY`
Description: `FBSDKAppEventParameterNameDescription`	`string`	A string description
Level: `FBSDKAppEventParameterNameLevel`	`string`	Level of a player
Max. Rating Value: `FBSDKAppEventParameterNameMaxRatingValue`	`int`	Upper bounds of a rating scale, for example `5` on a `5` star scale
Number of Items: `FBSDKAppEventParameterNameNumItems`	`int`	Number of items
Order ID: `FBSDKAppEventParameterNameOrderID`	`string`	The unique ID for all events within a subscription
Payment Info Available: `FBSDKAppEventParameterNamePaymentInfoAvailable`	`1` or `0`	`1` for yes, `0` for no
Registration Method: `FBSDKAppEventParameterNameRegistrationMethod`	`string`	Facebook, Email, Twitter, etc.
Search String: `FBSDKAppEventParameterNameSearchString`	`string`	The string that was searched for
Success: `FBSDKAppEventParameterNameSuccess`	`1` or `0`	`1` for yes, `0` for no

Web

Standard Events

Event Name: AppEventsConstants Value	Parameters	Description
Achieve Level: `EVENT_NAME_ACHIEVED_LEVEL`	`LEVEL`	The achievement of specific levels you define within your application, business or organization.
Activate App: `EVENT_NAME_ACTIVATED_APP`		The launch of your app.
In-App Ad Click: `EVENT_NAME_AD_CLICK`	`AD_TYPE`	An ad from a third-party platform is clicked within your app.
In-App Ad Impression: `EVENT_NAME_AD_IMPRESSION` valueToSum: Ad impression value to be added	`AD_TYPE`	An ad from a third-party platform appears on-screen within your app. If valueToSum is provided, the event can be used for in-app ads optimization. The valueToSum value represents the in-app ads revenue generated from a user viewing an ad in your app. Refer to the documentation here to learn about maximizing the value of in-app ad impressions.
Add Payment Info: `EVENT_NAME_ADDED_PAYMENT_INFO`	`SUCCESS`	The addition of customer payment information during a checkout process.
`Schedule`	See App Events Schema
`Subscribe`	See App Events Schema
Add to Cart: `EVENT_NAME_ADDED_TO_CART` valueToSum: Price of item added	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	The addition of an item to a shopping cart or basket. For example, clicking an Add to Cart button on a website.
Add to Wishlist: `EVENT_NAME_ADDED_TO_WISHLIST` valueToSum: Price of item added	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	The addition of items to a wishlist. For example, clicking an Add to Wishlist button on a website.
Complete Registration: `EVENT_NAME_COMPLETED_REGISTRATION`	`REGISTRATION_METHOD`	A submission of information by a customer in exchange for a service provided by your business. For example, sign up for an email subscription.
Complete Tutorial: `EVENT_NAME_COMPLETED_TUTORIAL`	`SUCCESS`, and `CONTENT_ID` or `CONTENT`	A completion of a tutorial on your app.
Contact: `EVENT_NAME_CONTACT`		A telephone or SMS, email, chat or other type of contact between a customer and your business.
Customize Product: `EVENT_NAME_CUSTOMIZE_PRODUCT`		The customization of products through a configuration tool or other application your business owns.
Donate: `EVENT_NAME_DONATE`		The donation of funds to your organization or cause.
Find Location: `EVENT_NAME_FIND_LOCATION`		When a person finds one of your locations via web or app, with an intention to visit. For example, searching for a product and finding it at one of your local stores.
Initiate Checkout: `EVENT_NAME_INITIATED_CHECKOUT` valueToSum: Total price of items in cart	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`,`NUM_ITEMS`, `PAYMENT_INFO_AVAILABLE`, and `CURRENCY`	The start of a checkout process.
Purchase: `EVENT_NAME_PURCHASED` valueToSum: Price of Purchase	`NUM_ITEMS`, `CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	The completion of a purchase, usually signified by receiving order or purchase confirmation or a transaction receipt.
Rate: `EVENT_NAME_RATED` valueToSum: Rating given	`CONTENT_TYPE` , `CONTENT_ID` or `CONTENT`, and `MAX_RATING_VALUE`	A rating of something within your app, business or organization. For example, rates a restaurant within a restaurant review app.
Schedule: `EVENT_NAME_SCHEDULE`		The booking of an appointment to visit one of your locations.
Search: `EVENT_NAME_SEARCHED`	`CONTENT_TYPE`, `SEARCH_STRING` and `SUCCESS`	A search performed on your website, app or other property, such as product searches, travel searches, etc.
Spent Credits: `EVENT_NAME_SPENT_CREDITS` valueToSum: Total value of credits spent	`CONTENT_TYPE`, and `CONTENT_ID` or `CONTENT`	The completion of a transaction where people spend credits specific to your business or application, such as in-app currency.
Start Trial: `EVENT_NAME_START_TRIAL` valueToSum: Price of Subscription	`SUBSCRIPTION_ID` and `CURRENCY`	The start of a free trial of a product or service you offer, such as a trial subscription.
Submit Application: `EVENT_NAME_SUBMIT_APPLICATION`		The submission of an application for a product, service or program you offer, such as a credit card, educational program or job.
Subscribe: `EVENT_NAME_SUBSCRIBE` valueToSum: Price of Subscription	`SUBSCRIPTION_ID` and `CURRENCY`	The start of a paid subscription for a product or service you offer.
Unlock Achievement: `EVENT_NAME_UNLOCKED_ACHIEVEMENT`	`DESCRIPTION`	The completion of specific activities or actions you want to reward within your application, business or organization. For example, refer a friend, complete your profile, etc.
View Content: `EVENT_NAME_VIEWED_CONTENT` Price of item viewed (if applicable)	`CONTENT_TYPE`, `CONTENT_ID` or `CONTENT`, and `CURRENCY`	A visit to a content page you care about, such as a product page, landing page or article. Information about the page viewed can be passed to Facebook for use in dynamic ads.

Standard Event Parameters

AppEventConstants::EVENT_PARAM_*	Possible Values	Description
Ad Type: `EVENT_PARAM_AD_TYPE`	`string`	Type of ad: banner, interstitial, rewarded_video, native
Content: `EVENT_PARAM_CONTENT`	`string`	A list of JSON object that contains the International Article Number (EAN) when applicable, or other product or content identifier(s) as well as additional information about the products. `id`, `quantity`, and `item_price` are the available fields. e.g. "[{\"id\": \"1234\", \"quantity\": 2, \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]"
Content ID: `EVENT_PARAM_CONTENT_ID`	`string`	International Article Number (EAN) when applicable, or other product or content identifier
Content Type: `EVENT_PARAM_CONTENT_TYPE`	`string`	'product' or 'product_group'
Currency: `EVENT_PARAM_CURRENCY`	`string`	ISO 4217 code, e.g., "EUR", "USD", "JPY"
Description: `EVENT_PARAM_DESCRIPTION`	`string`	A string description
Level: `EVENT_PARAM_LEVEL`	`string`	Level of a game
Max. Rating Value: `EVENT_PARAM_MAX_RATING_VALUE`	`int`	Upper bounds of a rating scale, for example 5 on a 5 star scale
Number of Items: `EVENT_PARAM_NUM_ITEMS`	`int`	Number of items
Order ID: `EVENT_PARAM_ORDER_ID`	`string`	The unique ID for all events within a subscription
Payment Info Available: `EVENT_PARAM_PAYMENT_INFO_AVAILABLE`	`1` or `0`	`1` for yes, `0` for no
Registration Method: `EVENT_PARAM_REGISTRATION_METHOD`	`string`	Facebook, Email, Twitter, etc.
Search String: `EVENT_PARAM_SEARCH_STRING`	`string`	The text string that was searched for
Success: `EVENT_PARAM_SUCCESS`	`1` or `0`	`1` for yes, `0` for no