Facebook Lead Ads To boberdoo Integration

In order to post leads directly from your Facebook Lead Ads forms into your boberdoo system, we have built an integration tool using Facebook's APIs. Because we utilize Facebook's APIs, please be aware of the following limitations before getting configured.

1. Facebook has an hourly rate limit on its API calls. This rate limit equates to approximately 200 lead submissions per hour. If this hourly limit is reached, your integration will fail until you fall below Facebook's hourly limit.

2. This integration process requires you to build a Facebook developers app and follow Facebook's app review process. This review process can take up to 3 weeks to be approved by Facebook.

3. The Facebook app review process requires a signatory to verify your business and agree to follow Facebook's supplemental terms on behalf of your business.

To integrate your Facebook Lead Ads with your boberdoo lead system, please follow the instructions below.

*Facebook Leads Manager is a custom add-on and has to be built into your boberdoo system.  If you do not see FB Leads Manager in the lefthand navigation of you system, please open a ticket to have this added.

Step 1: Build A Dummy Ad Campaign

In order to complete the integration between Facebook Lead Ads and your boberdoo system, you must have an existing Facebook Lead Ad form built in the ad account you wish to connect to boberdoo.

If you already have a Facebook Lead Ads form built, skip to Step 2: Set Up Your Facebook App.

If this is your first time using Facebook Lead Ads, we suggest setting up a dummy campaign during this walkthrough so you can fully complete the boberdoo integration. After your dummy campaign is built and the integration is complete, you can repeat these steps to build a live, targeted campaign.

Access your Facebook Ad Manager and select the Ad Account through which you plan on running your Facebook Lead Ads. Select the Campaigns tab, click the Create button then select the marketing objective titled Lead generation.  Name your campaign and continue.

fb leads ads

Next, build the Ad Set for your campaign. First select the Facebook page that you would like to promote for this campaign and then define your campaign's audience, placements, budget, schedule and ad set name. If you are building a dummy campaign, as referenced above, you do not need to adjust your campaign specifics. You will not launch this campaign, so the budget, schedule, etc. is irrelevant. Click continue.

Next, customize the format and text of your ad. At the bottom of this page, you will see a Lead Form section. Click the Create Lead Form button.

Create a Lead Form

Select the New Form option and click next. Name your form and complete the Form Type and Into sections. Your next step is to add the fields or questions that you will display on your form. The User Information section provides you all of the data that can be pulled directly from the user's profile. Note: Although Full name is a pre-checked option, you must use the separated First name and Last name options instead so you can properly map those fields to your lead type. To add additional fields, click the Add a question link. Keep in mind that Facebook only allows 3 custom questions per form. For a full list of Lead Ads parameters, read more here.

facebook lead ads screenshot

Finally, complete the Privacy Policy and Thank You Screen options and save your form.

With your form added to your campaign, you can review your order and click the Place Order button when complete.

Step 2: Set Up Your Facebook App

The next step requires you to set up a unique app within the Facebook Developers Portal that you will integrate with your boberdoo lead system. Go to developers.facebook.com. Log in to your Facebook account, then in the top right dropdown menu, select Add a New App. Add a display name for your app and contact email. Click the Create App ID button.

Next, you will be redirected to the Products section of your newly created App. From the lefthand navigation, click the Settings>Basic tab. From here you will need to add information about your leadsystem to help you connect the two platforms

  • App Domains: enter the subdomain+domain of your leadsystem in the following format: yourcompany.leadportal.com
  • Contact Email: Add your email address.
  • Privacy Policy URL: Include the URL to your privacy policy.
  • App Icon: Upload a 1024x1024 version of your company logo.
  • Category: Select Business and Pages
  • Business Use: Select Support my own business

facebook integration

Next, locate the Data Protection Officer Contact Information section. If you generate any leads in the UI or the EU, complete this section.

Next, locate the Add Platform button at the bottom of the page. Click Add Platform then select the Website option.

facebook integration

In the new, Site URL field, enter the entire URL of your leadsystem in the following format: https://yourcompany.leadportal.com/ 

Click Save Changes.

Next, click the Products + button in the lefthand navigation and click the Facebook Login Set Up button. This will take you to a Quickstart sub-section. Instead of following the Quickstart, click the Facebook Login Settings link from the lefthand navigation.

facebook lead ads

This will bring you to the Client OAuth Settings. Locate the Valid OAuth redirect URIs field and enter your leadsystem URL. This will be the exact URL you entered in the previous step. Example: https://yourcompany.leadportal.com/

Click the Save Changes button.

facebook integration

Step 3: Request App Permissions And Submit For Review

In this step, you need to request several permissions that are required to build the integration. Select the App Review tab from the lefthand navigation. Click the Start a Submission button. Next, select the leads_retrieval and manage_pages permissions and click Add 2 Items. Before submitting your app for review, you must provide specific details for each permission.

leads_retrieval: Click Add Details and paste in the following answers to their corresponding question requests

Q: How is your app using leads_retrieval?

A: This app performs two functions. The first is to use the Facebook login to connect Facebook pages and the corresponding Facebook Ad accounts to a CRM. The second is to retrieve lead submissions from Facebook Lead Ads and post them into the CRM. leads_retrieval is required to retrieve Facebook Lead Ads submissions and post them into the CRM.

QWhat platforms does your app use leads_retrieval on?

A: Web

QPlease give them detailed step-by-step instructions for how to see this permission the same way people using your app would.

A: To demonstrate the leads_retrieval permission requirement, you need to connect a Facebook account to the boberdoo CRM, build a form mapping between your Facebook Lead Ads form to the boberdoo CRM, submit a lead via a live Facebook Lead Ads campaign and leads_retrieval is necessary to post leads form the Facebook Lead Ads submission into the CRM.

1. Log in to https://yourcompany.leadportal.com/new_admin/ (*Note: You must replace yourcompany.leadportal.com with your actual leadsystem URL. Do not include this note in your submission)
U: FacebookTest1
P: FacebookTest1

2. From the left-hand navigation, select FB Leads Manager>Setup. If there is an existing profile listed, click RESET. If not, see step 3.

3. Insert the App ID and App Secret for this app, click continue, connect your Facebook account and select a page you can run live Facebook Lead Ads through.

4. Click the Webhook button to build a webhook connection with the page

5. Above the Setup tab, click the Lead Ads Forms page and click the Add New FB Form Mapping button.

6. Select a form from the Facebook page you connect with in step 3.

7. Complete the form mapping for all required fields.
- LeadType: select FB Test
- For Field Name Landing Page, select the Facebook Field "Default Value" and write in a Default Value of "Facebook"
- For Field Name SRC, select the Facebook Field "Default Value" and write in a Default Value of "FB"
- For Field Name IP_Address, select the Facebook Field "Default Value" and write in a Default Value of "1.11.11.11.1"
- For Field Name First_Name, select the Facebook field "Full Name". Your Facebook Lead Ads form selected in Step 6 must include the Full Name field.
- For Field Name Email, select the Facebook field "Email". Your Facebook Lead Ads form selected in Step 6 must include the Email field.
- Click Add Form

8. Your Facebook Lead Ads to CRM integration is now complete. To test the leads_retrieval permission, launch a live Facebook Lead Ads campaign using the form selected in step 6 and submit a live lead.

9. Finally, from https://yourcompany.leadportal.com/new_admin/ go to the Leads tab and view the lead that was retrieved from Facebook Lead Ads and posted into the CRM. (*Note: You must replace yourcompany.leadportal.com with your actual leadsystem URL. Do not include this note in your submission)

facebook integration

Click Save. Your leads_retrieval permission should now have a blue check mark next to it.

manage_pages: Click Add Details and paste in the following answers to their corresponding question requests

Q: How is your app using manage_pages?

A: Other: This app uses the Facebook login to connect Facebook pages and the corresponding Facebook Ad accounts to a CRM.

QWhat platforms does your app use leads_retrieval on?

A: Web

QPlease give them detailed step-by-step instructions for how to see this permission the same way people using your app would.

A: To demonstrate the manage_pages permission requirement, you need to connect a Facebook account to the boberdoo CRM and retrieve the corresponding Facebook pages to view the Facebook Lead Ads forms built for those pages.

1. Log in to https://yourcompany.leadportal.com/new_admin/ (*Note: You must replace yourcompany.leadportal.com with your actual leadsystem URL. Do not include this note in your submission)
U: FacebookTest1
P: FacebookTest1

2. Under FB Leads Manager, click the Setup tab

3. If there is an existing profile listed, click RESET. If not, see step 4.

4. Insert the App ID and App Secret for this app, click continue. Next you will see a connect your Facebook account button. Click this button to trigger the connection between the app and your Facebook account. Connect your Facebook account and select a page you can run live Facebook Lead Ads through.

5. Click the Webhook button to build a webhook connection with the page

6. Select a facebook page to connect with

7. Click the Webhook button to build a webhook connection with the page

8. Go to the Lead Ads Forms tab to see the forms pulled from the connected Facebook page

QUpload screencast

A: Download this mp4 file and upload it as your screencast file.

Click Save. Your manage_pages permission should now have a blue check mark next to it.

You have now added all permission details for your app. Click Submit For Review.

facebook integration

Finally, read Facebook's Platform Onboarding Terms, click the accpet checkbox and submit your app for review.

Your app is now in review. Step 1 of the review process can take anywhere between 3 days and 10 days.

Step 4: Submit Your Business Verification

Once step 1 of the review process is complete, you will receive a notification in your Facebook account as well as an alert in your Facebook developers portal inbox. The next step is to create a Business Manager Account within Facebook's developer portal and associate your business with your newly created app. Start the business verification process either from your Inbox alert or the App Review page.

Note: the Facebook Business Manager Account is different than a Facebook business page. If you do not see a dropdown option for an existing Business Manager account, you must create one.

Facebook business verification

This process requires you to enter your business name, contact information and business details.

Next, you are required to upload a document that verifies either your Business Phone Number, Address or Tax ID. Typically, the simplest option is to attach a copy of a utility, internet or phone bill.

Facebook business verification

Finally, you must identify a Business Signatory who has the authority to sign a contract on behalf of and bind your business. This signatory will be responsible for reviewing and signing Facebook's Supplemental Terms.

Facebook business verification

Enter your Business Signatory's information and click Submit. The terms and signing instructions will be emailed to your Business Signatory to complete. Once completed, your business verification is complete.

Your app will once again return to the App Review state to await final approval. Again, this review can take several days.

Step 5: Confirm Your App Verification

When the app review is complete, you will receive a Facebook notification as well as an alert in your Facebook developers portal inbox. Go to the App Review section and confirm that each of your permissions were verified. Located the Approved Items section and ensure it looks exactly like the screenshot below.

facebook integration

If any of your permissions were denied or missing from the Approved Items section, please alert boberdoo support and include a screenshot of the entire App Review page.

Next, locate the switch above your Approved Items. Your app is currently in development and unavailable to the public. Toggle the switch to make your app public. Click Confirm.

facebook lead ads
Step 6: Integrate Your App With boberdoo

Your next step is to integrate your Facebook App with your leadsystem. Return to Settings>Basic in your Facebook Developers Portal. Locate and copy your App ID and App Secret. Next go to your boberdoo lead system. Click the FB Leads Manager tab, then click the subtab titled Setup. Paste your App ID and App Secret and click Continue. Finally click the Connect with Facebook button.

facebook lead ads

This will open a browser popup from Facebook that allows you to sync your Facebook app with your personal Facebook account that you will be running your Facebook Lead Ads through. Make sure the personal Facebook account you sync here has access to the Facebook page or Facebook business page that you will be running ads through. Click the Continue button that appears on the popup. Next, the Facebook popup will inform you that the Facebook app you created would like access to your pages. Click OK.

The Facebook popup will then close and return you to your boberdoo lead system. A list of all of your Facebook pages that are accessible from your account will appear. Click on the page you want to build the first integration with and then press the Save button.

facebook lead ads

Once saved, you'll see every Facebook Page that you have access to and the ability to add a subscription to any of them. Click the subscribe button for every Facebook page that is used to run Lead Ads campaigns. Once subscribed, you will be able to access all Lead Ads forms associated with each page.

setting up Facebook lead ads

Once successfully configured, you will see your Facebook app credentials and a red button titled No Webhook. Click the refresh button next No Webhook to automatically generate and activate the webhook between your leadsystem and your Facebook app. The App Webhook row should now say Live.

Step 7: Map Your Facebook Form To boberdoo Lead Type

Your next step is to map your Lead Ads form with one of your lead system's lead types. Under FB Leads Manager, go to the Leads Ads Forms tab. Click the Add New FB Form Mapping button. From here you can select any of the forms you have already created in your Facebook Ads Manager.

Facebook Lead Ads

 

Once you select a form, use the dropdown to select the lead type that you'd like to map your Lead Ads form to.

You will also see the option titled Use "Skip_Dupe_Check" Parameter in Request. This feature allows your lead system to skip specific dedupe checks, but is only used in very specific scenarios. Please contact support before activating this feature.

Next use the mapping manager to assign a value for every lead type field that appears in the Field Name column. For each Field Name, you have three options for the corresponding Facebook Field:

  • No mapping: This field will be ignored and not posted to the leadsystem. Note: You cannot use this option for any field that is labeled as Required.
  • Default value: Your lead system will capture the value that you enter in the corresponding “Default Value” column.
  • Facebook Fields: This field will be captured from the Facebook Lead Ad Form. The dropdown options under Facebook Fields are dependent on the fields included on the Facebook form you selected.
facebook lead ads boberdoo screenshot

Mapping Recommendations

  • IP Address: Use the Default Value option and add a default IP. Ex. 111.11.111.11
  • Sub ID/Pub ID/Optout/Unique Identifier: Use the No Mapping option
  • SRC: Use the Default Value option and select a source you designate for your Facebook Lead Ads or one of your pre-existing sources.
  • Landing Page: Use the Default Value option and enter a landing page value. Ex. Facebook Lead Ads
  • Required Fields Not Included On Your Facebook Form: All required fields need a corresponding value. If you do not include a required field on your Facebook form, you must designate a default value.

Once your fields are mapped, click Add Form. Your form will now appear on the Leads Ads Forms page. You can use the edit tool to adjust your field mapping or delete this form at any time.

Step 8: Test Your Integration

To send a test lead from your Facebook Lead Ad into your boberdoo system, access the Lead Ads Testing page of your developers.facebook account. From the page dropdown, select the page that you used when building your Lead Ads form. Next select the form you would like to test from the form dropdown. Make sure you select a form that you have already mapped to your leadsystem in the previous step. Next, instead of creating a lead, click the Preview form link. This will bring up your Lead Ads Form. Fill out this form to send through your test lead. Next, return to the Leads page of your lead system to confirm the test lead successfully entered your system. Each time you enter a new test lead you must first use the Delete lead button in the Lead Ads Testing page to clear your previous lead before filling out the form again.

facebook lead ads boberdoo screenshot

Frequently Asked Questions

Q: My Facebook Lead Ads form contains a "Full Name" field, but my lead type contains a "First Name" and "Last Name" field. How should I map these fields?
A: The simplest solution is to adjust your Facebook form. Edit your form, uncheck the "Full Name" option and replace it with the "First Name" and "Last Name" fields.

Q: Facebook's forms do not allow fields that are required in my lead type (e.g. health related fields). 
A: Option 1: Open a boberdoo ticket to make the field not required.
     Option 2: In the Map Your Facebook Form step, identify a default value for this field.