Facebook Custom Audiences Integration
  • 22 Feb 2024
  • 1 Minute to read

    Facebook Custom Audiences Integration


      Article Summary

      To use Facebook Custom Audiences with customers, you must first integrate user object, which is required to collect and process users’ email addresses or phone numbers, and GDPR opt-in information.

      your title goes here
      Note: The email addresses and phone numbers passed to Insider via user object for Facebook Ads Integration are one-way encrypted and are not disclosed to Facebook.

      The following describes how to integrate user objects for Facebook Custom Audiences using Insider Object.

      Sample code for Facebook Custom Audiences user object

      window.insider_object = {
         "user":{
            "gdpr_optin":true,
            "email":"jdoe@mailservice.com",
            "phone_number": "+120394879878"
         }
      }

      Namespace

      The code of the object is as follows:

      window.insider_object.*

      Code for user object for Facebook Ads must be added under code for Insider Object.

      User object for Facebook Custom Audiences: Properties, definitions, and code

      User object includes the user properties. User object can be implemented in all cases, including when the user is not logged in. When the user is not logged in, only the available properties will be filled in; keys without values will not be added to the object.

      KeyPropertyTypeDefinition
      gdpr_optin*GDPR Opt-inBooleanUser's permission for any Insider campaign, data collection and processing.
      False = user will not see any Insider campaign or receive messages from any channel;
      True or empty = Insider is able to interact with the user through personalization campaigns.
      email*Email AddressStringUser's email address
      phone_number*Phone NumberStringUser's phone number in E.164 format (e.g. +6598765432)

      * Required field for this object

      If your company obtains your users' consent in compliance with the local regulations, make sure to pass the GDPR opt-in field to Insider. If you want to stop collecting and processing the data of an identified user, GDPR opt-in field should have the false value. Insider cannot be held liable if these obligations are not fulfilled and reserves the right to seek compensation from your company.

      Your title goes here
      You can pass email or phone number as an identifier. Both of them are not required at the same time.

      Once the user object is integrated into your website, you can provide Insider with the required fields (email, phone_number, gdpr_optin) whenever a user:

      • Logs in
      • Subscribes to a newsletter (e.g. through an input box on the footer)
      • Registers by providing their email (e.g. on the registration page)
      your title goes here
      For users whose gdpr_optin field is not defined or is false: The user object and/or the respective field should not be filled in.


      Checklist for any page where user object is present:

      • Object window.insider_object.user returns on the page.
      • All properties are filled in when user logs in.

      Was this article helpful?


      What's Next
      ESC

      Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses