AppEvents.shared
All event logging goes through the AppEvents.shared singleton. You access it directly without any setup beyond the standard SDK initialisation in your AppDelegate.
import FacebookCore
// Simple event with no parameters
AppEvents.shared.logEvent(.viewedContent)
Logging a simple event
Use logEvent(_:) when you only need to record that something happened:
AppEvents.shared.logEvent(.searched)
Logging an event with a value
Use logEvent(_:valueToSum:parameters:) to attach a numeric value and a parameters dictionary:
AppEvents.shared.logEvent(
.viewedContent,
valueToSum: 9.99,
parameters: [
.contentType: "product",
.contentID: "SKU-12345"
]
)
Standard event names
The SDK defines constants for the most common event names. Use these where possible so Facebook can map them to standard event types.
General events
| Swift constant | Raw value | Description |
|---|
AppEvents.Name.viewedContent | fb_mobile_content_view | User viewed content |
AppEvents.Name.searched | fb_mobile_search | User performed a search |
AppEvents.Name.completedRegistration | fb_mobile_complete_registration | User completed registration |
AppEvents.Name.completedTutorial | fb_mobile_tutorial_completion | User completed a tutorial |
AppEvents.Name.rated | fb_mobile_rate | User rated an item |
AppEvents.Name.contact | Contact | User initiated contact |
AppEvents.Name.customizeProduct | CustomizeProduct | User customized a product |
AppEvents.Name.donate | Donate | User made a donation |
AppEvents.Name.findLocation | FindLocation | User found a location |
AppEvents.Name.schedule | Schedule | User booked an appointment |
AppEvents.Name.submitApplication | SubmitApplication | User submitted an application |
AppEvents.Name.subscribe | Subscribe | User started a paid subscription |
AppEvents.Name.startTrial | StartTrial | User started a free trial |
AppEvents.Name.adClick | AdClick | User clicked an ad |
AppEvents.Name.adImpression | AdImpression | User viewed an ad |
| Swift constant | Raw value | Description |
|---|
AppEvents.Name.addedToCart | fb_mobile_add_to_cart | User added item to cart |
AppEvents.Name.addedToWishlist | fb_mobile_add_to_wishlist | User added item to wishlist |
AppEvents.Name.initiatedCheckout | fb_mobile_initiated_checkout | User entered checkout |
AppEvents.Name.addedPaymentInfo | fb_mobile_add_payment_info | User entered payment info |
AppEvents.Name.purchased | fb_mobile_purchase | User completed a purchase |
| Swift constant | Raw value | Description |
|---|
AppEvents.Name.achievedLevel | fb_mobile_level_achieved | User achieved a level |
AppEvents.Name.unlockedAchievement | fb_mobile_achievement_unlocked | User unlocked an achievement |
AppEvents.Name.spentCredits | fb_mobile_spent_credits | User spent in-app credits |
Standard parameter names
| Swift constant | Raw value | Description |
|---|
AppEvents.ParameterName.contentType | fb_content_type | Type of content viewed |
AppEvents.ParameterName.contentID | fb_content_id | Identifier for the content |
AppEvents.ParameterName.content | fb_content | JSON-encoded content descriptor |
AppEvents.ParameterName.numItems | fb_num_items | Number of items |
AppEvents.ParameterName.paymentInfoAvailable | fb_payment_info_available | Whether payment info is on file |
AppEvents.ParameterName.currency | fb_currency | ISO 4217 currency code |
AppEvents.ParameterName.searchString | fb_search_string | Search query |
AppEvents.ParameterName.success | fb_success | Whether the action succeeded |
AppEvents.ParameterName.registrationMethod | fb_registration_method | How the user registered |
AppEvents.ParameterName.orderID | fb_order_id | Order identifier |
Logging a purchase
Use the dedicated logPurchase(purchaseAmount:currency:) helper for e-commerce transactions:
// Simple purchase
AppEvents.shared.logPurchase(purchaseAmount: 9.99, currency: "USD")
// Purchase with extra parameters
AppEvents.shared.logPurchase(
purchaseAmount: 29.99,
currency: "USD",
parameters: [
.contentID: "SKU-99",
.numItems: 2,
.contentType: "product"
]
)
FBSDKAppEventNamePurchased event with the currency injected as a parameter.
User properties
You can associate user data with events to improve matching and measurement. The SDK hashes all values before transmitting them.
AppEvents.shared.setUser(
email: "[email protected]",
firstName: "Jane",
lastName: "Smith",
phone: nil,
dateOfBirth: nil,
gender: nil,
city: nil,
state: nil,
zip: nil,
country: nil
)
AppEvents.shared.userID = "your_internal_user_id"
AppEvents.shared.clearUserData()
AppEvents.shared.userID = nil
Flush behaviour
By default, the SDK uses FBSDKAppEventsFlushBehaviorAuto, which batches events and flushes them when 100 events have accumulated or after 15 seconds, whichever comes first.
To flush immediately — for example, just before your app terminates — call:
To require manual flushing only:
AppEvents.shared.flushBehavior = .explicitOnly
AppEvents.shared.flush() // must call this yourself
Use FBSDKAppEventsFlushBehaviorExplicitOnly during testing so you can control exactly when events are sent and verify them in Events Manager.
