If you are an advertiser who fetches leads via an API or webhook (or uses a partner that does this), you can use the hidden fields feature for lead ads to pass certain ID information from your lead form through to your CRM, in order to better understand which leads are coming from where.

By passing hidden fields to your CRM, such as campaign name or ID from your system, you can effectively distinguish which leads are associated with the campaigns you're running across channels – including Affiliate sites – without having this information be visible to people filling in your form.

Getting started

Recommendations

We recommend that you have an existing webhook and API integration for lead ads. Learn more on our developer's website:

• Webhooks
• API integration for lead ads

Bear in mind

The hidden fields feature adds fields to the API responses for leads based on parsing the URL parameters of an ad. That said:

• Because the fields come from the URL parameters of an ad, they will only be present when a lead is delivered via an ad. Organic traffic will not include the hidden fields.
• CSV/TSV downloads from the Facebook UI will not include the hidden fields.

Setup

1. Create a lead form.
2. Set up an ad using your lead form.

3. Add your fields to the URL parameters.

   For example, if you want to add utm_source with a value of Facebook and campaign_name with a value of Lead Gen, your URL parameters would look like: utm_source=Facebook&campaign_name=Lead+Gen.

   Note: The keys and values are URL encoded, transforming the space in Lead Gen to a plus sign.
4. To test: generate a preview of the ad.
   After you've finished filling in your ad, submit it by pushing the Publish button in the bottom-right. Your webhook will receive the fields that you provided and the additional hidden fields in the URL parameters.

CRM partner-specific instructions

Eloqua

Eloqua monitors the fields received from the lead forms and updates the field names available for mapping into Eloqua fields approximately every 15 minutes.

Follow the standard setup instructions above, then wait 15 minutes. Edit the mapping from Facebook to Eloqua for the lead form in question and the new fields should appear.

Marketo

Learn more about creating, managing and troubleshooting your lead ad.

* Nguồn: Facebook