Facebook Lead Ads Source

1. See Facebook's steps on how to set up a Facebook Lead Ad campaign if you don't have one already.
2. Connect Facebook Lead Ad with Segment. Search for Segment.com in the CRM provider search box.
3. Go to the Segment UI and navigate to Connections > Catalog and search for Facebook Lead Ads.
4. Select the Facebook Lead Ads source and click Add Source.
5. Give the source a name. The name is a label used in the Segment interface, and Segment creates a related schema name which you query against in your warehouse. The nickname can be whatever you like, but Segment recommends sticking to something that reflects the source itself, like Facebook Lead Ads or Facebook Lead Ads Prod.
6. Click Authenticate.
7. Select which accounts you would like to sync (you may change this selection later).
8. Verify that your leads are flowing into Segment. You can quickly test this connection by sending a test lead to Segment with Facebook's Lead Ad testing tool.
9. Click on the Debugger to see a live stream of data coming in from Facebook. You should see your leads come in as Identify calls.

Use the following permissions to access the page and lead information for enrichment purposes with Facebook lead ads. You must have the following permissions to set this source up:

• pages_show_list
• pages_read_engagement
• pages_manage_ads
• leads_retrieval
• ads_management

Learn more about permissions in Facebook's Retrieving Leads documentation. Leads Access permissions are required to retrieve leads generated by Facebook Lead Ads. This is the default permissions for most roles. Learn more about permissions by following this link.

Stream

Facebook Lead Ads uses our stream Source component to send events to Segment. These events are then available in any destination that accepts server-side events, including your data warehouse.

The following table lists events that Facebook Lead Ads sends to Segment. These events will show up as tables in your Warehouse, and as regular events in your other destinations.

The event properties included in the identify calls are dependent on the fields included in your Lead Ads form. When the user submits the form, an identify call is made. From the Segment Debugger, you can look at the raw code from the identify call.

See the following example:

1
{
2
 "anonymousId":"254875448264245",
3
 "messageId":"fb_leadads-MND7ItD0c2-254875448264245",
4
 "timestamp":"2016-12-08T16:39:58.000Z",
5
 "traits": {
6
   "adId": 6052204319312,
7
   "email":"-----------@example.com",
8
   "formId": 225571381194652,
9
   "First_Name":"------------",
10
   "Last_Name":"------------",
11
   "job_title":"warehouse",
12
   "work_email":"----------@example.com"
13
  },
14
 "type":"identify",
15
 "writeKey":"-------------------",
16
 "context": {
17
   "integration": {
18
     "name":"facebook-lead-ads",
19
     "version":"0.0.3"
20
    },
21
   "library": {
22
     "name":"unknown",
23
     "version":"unknown"
24
    }
25
  },
26
 "integrations": {},
27
 "receivedAt":"2016-12-08T16:40:05.490Z",
28
 "originalTimestamp":"2016-12-08T16:39:58.000Z"
29
}

If you've selected any checkboxes on Facebook's Custom Disclaimer form, the custom_disclaimer_responses field is included in the data request sent to Segment. For more information, refer to Facebook's Retrieving Leads documentation.

Segment recommends updating the checkbox_key in your Facebook Lead Ads source settings to ensure that Segment accurately checks custom disclaimer responses. If no custom disclaimer checkboxes are selected, Segment does not forward lead information to the source.

If no checkbox_key is added to Segment's source settings, Segment sends lead information by default, regardless of your custom disclaimer selections.

Expand image

Now that your source is set up, you can connect it to destinations.

Only the destinations listed can be used with Facebook Lead Ads. Facebook only passes an email address as a customer identifier, but not all destinations can use an email address instead of a User ID.

• HubSpot
• HubSpot Cloud Mode (Actions)
• HubSpot Web (Actions)
• Woopra

• Freshsales
• Freshsales Suite - CRM
• Salesforce (Actions)

• Help Scout
• Natero
• Zendesk

• ActiveCampaign
• AutopilotHQ
• Drip
• Eloqua
• MailChimp
• Mailjet
• Marketo Static Lists (Actions)
• Marketo v2
• Pardot (Actions)

• Clearbit Enrichment
• Clearbit Reveal
• Madkudu

• Intercom
• Intercom Cloud Mode (Actions)
• Intercom Web (Actions)

• Iterable
• Iterable (Actions)

Log in to your downstream tools and check that your events are populating, and contain all of the properties you expect. If all your events and properties are not showing up, refer to the relevant destination docs](/docs/segment/connections/destinations/) for troubleshooting.

When you update or change credentials on a connected account, you need to create a new Facebook Lead Ads source to reauthorize Facebook. Reauthorization implies that a new token is generated, but the token is not the only link between Segment and Facebook.

When you connect the Facebook Leads Ads source, a Segment application is installed on the connected Facebook account. If you were to generate a new token on the same source, it would invalidate all other tokens attached to that Facebook account.

For example, if you have a Facebook Account with three accounts: Account A, Account B, and Account C, you can connect Segment to all of them and then generate a token for each account. Later on, if you need to reauthorize the "Account A" page, the tokens for Account B and Account C are invalidated, and the pages stop working.