Get Started – Web

This guide shows you how to add App Events to your new or existing app by integrating the Facebook SDK then logging these events.

Step 1: Configure Your Facebook App

Go to the App Dashboard, click My Apps, and create a new app if you don't already have one. Navigate to Settings > Basic to view the App Details Panel with your App ID, your App Secret, and other details about your app.

Set up your app for advertising by adding the following details:

  • App Domains - Provide Google Play Store URL of your app.
  • Privacy Policy URL - Provide a Privacy Policy URL. Required to take your app public.
  • Terms of Service URL - Provide a Terms of Service URL.
  • Platform - Scroll to the bottom of the Settings panel to add the Web Platform. Add the follow details of your app:

Save your changes.

To learn more about adding details to your app, such as an icon or category, visit the App Development docs.

To run ads and measure installs in the Ads Manager, you need to associate at least one Ad Account with your app.

  1. In the app dashboard click Settings > Advanced.
  2. In Authorized Add Account IDs, add your Ad Account IDs. You can get your ad account IDs from your Ads Manager.

Step 3: Integrate the Facebook SDK in Your Website

We provide two ways to integrate the Facebook into your web page, using a Quickstart or adding the SDK manually.

Add the SDK by Using the Quickstart

By using the Quickstart Guide from your App Dashboard to add the Facebook SDK to your Website, the code provided will already include your App ID.

Add the SDK Manually

To add the SDK manually copy and paste the following code but be sure to replace {your-app-id} with your App ID and {version} with the Graph API version your app is using.

<script>
  window.fbAsyncInit = function() {
    FB.init({
      appId      : '{your-app-id}',
      xfbml      : true,
      version    : '{version}'
    });
    FB.AppEvents.logPageView();
  };
</script>

<script async defer 
  src="https://connect.facebook.net/en_US/sdk.js"></script>
</script>

Step 4: Add App Events

There are three ways events are tracked in your app:

For websites, we recommend triggering the page view event on all pages to ensure accurate user accounts and session durations.

Automatically Logged Events

After you integrate the Facebook SDK into your app, these events are automatically logged.

EventDetails

App Install

The first time a new user activates an app or the first time an app starts on a particular device.

App Launch

When a person launches your app, the Facebook SDK is initialized and the event is logged. However, if a second app launch event occurs within 60 seconds of the first, the second app launch event is not logged.

In-App Purchase

When a purchase processed by the Apple App Store or Google Play has been completed. If you use other payments platforms, you will need to add purchase event code manually.

Facebook SDK Crash Report

(For Facebook Use Only.)

If your app crashed due to the Facebook SDK, a crash report is generated and sent to Facebook when your app is restarted. This report contains no user data and helps Facebook ensure the quality and stability of the SDK. To opt out of logging this event, disable automatically logged events.

Manually Log Events

Get Code

You can add standard or custom events, see the Standard Event Names and Event Parameters in our reference guide, to your app.

To Generate Code for a Standard or Custom Event

  1. Choose the tab of the type of event code you want, Standard Event or Custom Event.
  2. In Event Name, enter the name of your event.
  3. Click Add Event Paramater if you would like to add parameters to your custom event.
  4. Click Get Code.
  5. In the window, select a language to get the code to copy and paste into your app.

To log a custom event, just pass the name of the event as a string:

function onButtonClick() {
  // Add this to a button's onclick handler
  FB.AppEvents.logEvent("{my_app_event}");
}

Event Parameters

Use app event parameters to view breakdowns on your insights you are interested in. The parameters are passed via a Bundle where the key holds the parameter name and the value is either a String or an int. The recommended description for these are guidance only; you can use these parameters or provide your own for whatever makes sense for your app. If you provide another type of value that is not compliant such as a boolean, the SDK logs a warning to LogginBehavior.APP_EVENT.

Visit our Help Center to learn how to deactivate parameters.

5. Test Your Events

Use Facebook Analytics Dashboard

View the most recent events logged by your app or website using the Facebook Analytics dashboard. Choose your app and go to Activity > Events Manager.

You should see an App Launches event if you are setting up an app or Page Views event if you are setting up a website, and any custom event for the button click. If you do not see these events, click the refresh button to load the latest events.

Once you have verified that your events are being logged correctly, then you can create funnels to help you measure conversion for any sequence of events you choose.

Use the App Ads Helper Tool

The App Ads Helper allows you to test the app events in your app to ensure that your app is sending events to Facebook.

  1. Open the App Ads Helper.
  2. In Select an App, choose your app and choose Submit.
  3. Scroll down to the bottom and choose Test Events.
  4. Start your app and send an event. The event should appear on the web page.

Learn More

For more information and helpful hints on App Events check out: