README

Requirements

Craft CMS 3.x, 4.x or 5.x
Works best with Craft Commerce
Facebook Pixel (See configuration how to obtain the Facebook Pixel)
Facebook Business Manager (See Facebook Business)
Facebook Access Token (See configuration how to obtain the Access Token)

Installation

The plugin can be installed via the Plugin Store in the Craft Control Panel.

Or, open your terminal, go the Craft project and install the plugin via Composer:

composer require dwy/facebook-conversion
./craft plugin/install facebook-conversion

Configuration

Pixel

Open Facebook Business Manager
Select your business
Navigate to the Events Manager
Click the Add Data Source button in the left menu
Use "Web"
Choose "Conversion API" as method.
Fill in a Pixel name and website url
After completing the Pixel creation, you'll find the Pixel-ID in the Settings tab of the Data Source. Copy your Pixel-ID to the Settings page of the plugin.

For more information, check the Create a Facebook Pixel in Business Manager article in the official documention.

Access Token

In the Events Manager:

Select the pixel you want to associate with your Conversions API
Navigate to the Settings tab
Click Create Access Token below the "Set up manually" section
Select the Facebook pixel you want your server events to be associated with
Click Generate Access Token
Copy your access token to the Settings page of the plugin

For more information, check the Create an Access Token for Conversions API in Guided Setup article in the official documention.

Test Event Code

Can be used to test the implementation.

Navigate to the Events Testing tab in the Events Manager
Copy the test_event_code to the Settings page of the plugin

Make sure an event that can be linked to a user by Facebook (i.e. Purchase event, by having a valid fbclid parameter, etc) is used when testing.

Template implementation

The Facebook Pixel can be added to your template by adding the facebook-conversion-head-tag hook to the head of the page and the facebook-conversion-body-tag to the body. For example:

<head>
    <meta charset="utf-8">

    <title>My Website</title>

    {% hook 'facebook-conversion-head-tag' %}
</head>
<body>
    {% hook 'facebook-conversion-body-tag' %}

Please note, when the Facebook Pixel is already added by another plugin (E.g. SEOmatic) don't add the template hook to avoid duplication.

Brought to you by Digital With you, follow us on Instagram

dwy / facebook-conversion

Maintainers

Details