Facebook (Graph API) – Setup

This guide covers authentication and setup relating to Facebook’s Graph API, which is used by the following Cyclr Connectors:

  • Facebook Insights
  • Facebook Marketing API

The Facebook Graph API uses OAuth 2.0 authentication and requires you to create a Facebook Developer account then a Facebook App to obtain an App ID and an App Secret.

NOTE: The process of having your Facebook App approved by Facebook can take around 5 business days.

Setup & Authentication

Creating a Facebook App

  1. Log into your Facebook account.
  2. Create a Facebook Developer account if you don’t already have one here: https://developers.facebook.com
  3. Go to My Apps: https://developers.facebook.com/apps
  4. Select Create App, and select Business as the app type. Complete the following sections:
    • App Display Name: This is the name your customers will see when they grant consent to access their data.
    • App Purpose: Set to Clients.
  5. Select Create App (You will be asked to enter your Facebook password).
  6. You should see a screen entitled Add Products to Your App.
  7. Under Facebook Login, select Set Up.
  8. This should now be added.
  9. In the menu on the left, select Facebook Login > Settings.
  10. Under Valid OAuth Redirect URIs enter https://Your Service Domain/connector/callback
    (Your service domain can be found in your Cyclr console under Settings > General Settings > Service Domain.) and select Save Changes.
  11. Under App Review on the left, select Permissions and Features. Here you’re going to set the permissions you’ll be asking your user for when they see the consent screen. The permissions you choose will vary depending on your use case, but you will always need advanced access to the user’s public profile to allow them to sign in.
  12. Search for public_profile, select Get Advanced Access, and complete the confirmation screen. You will notice that Advanced Access to public_profile is granted automatically. The other permissions will require a bit more admin.
  13. For this example, we’ll add the leads_retrieval permission, which is required if you are working with Form submissions.
  14. Once you have requested Advanced Access on this (and any other permissions), you’ll be invited to Edit App Review Request. Select this, complete all the required sections, and Submit for Review.
  15. Under Settings > Basic on the left menu, you’ll be able to complete any missing sections, and copy your App ID and App Secret. Once your app has been approved by Facebook, you’ll be able to use these to authenticate your App in Cyclr.

Cyclr Partner Setup

  • Go to your Cyclr Console > Connectors > Application Connector Library.
  • Select the Edit button for the appropriate Facebook Connector, e.g. Facebook Insights or Facebook Marketing API.
  • Go to the Settings tab then enter the following:
    • App/Client ID: This is the App ID displayed after you created your Facebook app.
    • App/Client Secret: This is the App Secret displayed after you created your Facebook app.

You should now be able to install and provide consent for the Facebook Connector you’ve provided those details for.

Official Facebook Documentation

For reference, these links take you to Meta’s own documentation around their APIs: