Taboola Pixel + S2S Postback — Documentation

Track Taboola Realize traffic and ecommerce actions from your PrestaShop store with the browser Taboola Pixel and optional server-to-server postbacks. You can measure product views, cart actions, purchases, searches, sign-ups, wishlist clicks, and custom campaign events from the same module.

Features

• Browser Taboola Pixel. The module injects the Taboola Pixel from displayHeader when tracking is enabled and a numeric Account ID is configured.
• Page and ecommerce events. It can send page view, product view, category view, add to cart, checkout start, purchase, search, wishlist, and registration events.
• Order confirmation purchase tracking. Purchase events run from displayOrderConfirmation and can include revenue, currency, quantity, product data, and order ID.
• Server-to-server postback queue. When S2S is enabled and a Taboola click ID exists, eligible events are queued and sent to Taboola by the module cron task.
• Click ID capture. The front script reads tblci and taboola_click_id from landing URLs and stores them in cookies for later attribution.
• Custom event rules. You can add JSON rules for click, URL, controller, module, and DOM-event based conversions.
• Consent-aware loading. If mprcookiesrevolution or mprcookiebanner is active, the module waits for marketing consent when consent respect is enabled.
• Employee exclusion. Logged-in back-office employees can be excluded from front-office tracking to keep staff visits out of campaign data.
• Diagnostics panel. The back office shows readiness checks, S2S queue counts, recent events, a probe button, and a retry button for failed postbacks.
• Install integrity checks. The module checks required configuration, registered hooks, database tables, and the shared conversion queue.

Configuration options

• Enable Taboola Pixel. Master on/off switch for browser tracking; default: 0.
• Taboola Account ID. Numeric Taboola Account ID from Realize > Tracking; default: "".
• Exclude employees. Stops tracking while a logged-in back-office employee browses the front office; default: 1.
• Respect cookie consent. Waits for marketing consent from mprcookiesrevolution or mprcookiebanner when one of those modules is active; default: 1.
• Track PageView. Sends the standard page_view event on tracked pages; default: 1.
• Track View Content. Sends the product view event on product pages; default: 1.
• Track View Category. Sends the category or collection view event when a current category is detected; default: 1.
• Track Add To Cart. Sends add-to-cart browser events from PrestaShop cart events or detected add-to-cart buttons; default: 1.
• Track Checkout. Sends the checkout start event when the module detects the checkout start page and the cart has products; default: 1.
• Track Purchase. Sends purchase events from order confirmation and order validation; default: 1.
• Track Search. Sends search events on the search controller when a search term is present; default: 1.
• Track Add To Wishlist. Sends wishlist events from supported wishlist buttons and the PrestaShop wishlist event bus; default: 1.
• Track Sign Up. Sends a registration event after a new customer account is created; default: 1.
• Purchase event name. Taboola event name used for purchases and purchase S2S postbacks; default: make_purchase.
• Product view event name. Taboola event name used for product views; default: product_view.
• Collection/category view event name. Taboola event name used for category views; default: collection_view.
• Add to cart event name. Taboola event name used for add-to-cart actions; default: add_to_cart.
• Start checkout event name. Taboola event name used for checkout starts; default: start_checkout.
• Search submitted event name. Taboola event name used for searches; default: search_submitted.
• Wishlist event name. Taboola event name used for wishlist additions; default: add_to_wish_list.
• Registration event name. Taboola event name used for new account registration; default: complete_registration.
• Track custom events. Enables the custom JSON rules and their optional S2S bridge; default: 0.
• Custom event rules. JSON array of custom event rules for click, url, controller, or event triggers; default: "".
• Enable S2S postback events. Queues eligible events with a captured tblci click ID and sends them to Taboola server-side; default: 0.
• Test tblci. Optional real Taboola click ID used only by the admin S2S probe; default: "".
• Keep IP and user agent in queued metadata. Keeps IP and user-agent metadata in the shared queue for diagnostics; default: 1.
• Queue batch limit. Maximum queued Taboola conversion events processed per run, accepted range 1 to 1000; default: 20.

Customization examples

Use a numeric Account ID and enable the standard event set:

ENABLED=1
ACCOUNT_ID=1234567
TRACK_PAGEVIEW=1
TRACK_VIEWCONTENT=1
TRACK_VIEWCATEGORY=1
TRACK_ADDTOCART=1
TRACK_STARTCHECKOUT=1
TRACK_PURCHASE=1
TRACK_SEARCH=1
TRACK_ADDTOWISHLIST=1
TRACK_SIGNUP=1

Rename built-in Taboola event names if your Taboola Realize setup uses different conversion names:

EVENT_VIEWCONTENT=product_view
EVENT_VIEWCATEGORY=collection_view
EVENT_ADDTOCART=add_to_cart
EVENT_STARTCHECKOUT=start_checkout
EVENT_PURCHASE=make_purchase
EVENT_SEARCH=search_submitted
EVENT_ADDTOWISHLIST=add_to_wish_list
EVENT_SIGNUP=complete_registration

Enable S2S queue processing for attributed events:

S2S_ENABLED=1
S2S_SEND_IP_UA=1
S2S_BATCH_LIMIT=20

Taboola ad landing URLs must carry a click ID for S2S attribution:

https://www.example.com/product-name?tblci=TABOOLA_CLICK_ID
https://www.example.com/product-name?taboola_click_id=TABOOLA_CLICK_ID

The module stores valid click IDs in these cookies:

mprtbpx_tblci
taboola_click_id

Track clicks on a product gallery and optionally bridge the event to S2S:

[
  {
    "event": "gallery_browse",
    "trigger": "click",
    "selector": ".product-images img,.images-container img",
    "params": {
      "property": "product_gallery"
    },
    "s2s": true,
    "once": false
  }
]

Track visits to campaign landing URLs:

[
  {
    "event": "landing_page_view",
    "trigger": "url",
    "contains": ["/sale", "utm_campaign=taboola"],
    "params": {
      "property": "taboola_landing"
    },
    "s2s": true
  }
]

Track a specific controller, optionally limited to a front-office module name:

[
  {
    "event": "contact_page_view",
    "trigger": "controller",
    "controllers": ["contact"],
    "modules": [],
    "params": {
      "property": "contact"
    },
    "s2s": true
  }
]

Trigger a custom conversion from your theme or custom JavaScript:

[
  {
    "event": "lead",
    "trigger": "event",
    "dom_event": "mprtbpx:custom",
    "params": {
      "property": "lead_form"
    },
    "s2s": true
  }
]

document.dispatchEvent(new CustomEvent('mprtbpx:custom', {
  detail: {
    params: {
      value: 1,
      currency: 'EUR'
    }
  }
}));

Pass extra parameters from clicked elements into a click rule:

<a href="/contact"
   class="taboola-lead-button"
   data-taboola-param-property="lead_button"
   data-mprtbpx-param-location="product_page">
  Contact us
</a>

Send a custom browser event directly after the module has loaded:

if (typeof window.mprtbpxTrack === 'function') {
  window.mprtbpxTrack('lead', {
    value: 1,
    currency: 'EUR',
    event_source_url: window.location.href
  }, true);
}

Installation

1. In your PrestaShop Back Office, go to Modules > Module Manager.
2. Click Upload a module and select the module ZIP file.
3. After installation, click Configure.
4. Enter your numeric Taboola Account ID.
5. Enable Taboola Pixel, choose the events you want to track, and save.
6. Optional: enable S2S postbacks after confirming your Taboola campaign URLs pass tblci or taboola_click_id.
7. Optional: add custom event rules for store interactions that are not covered by the built-in ecommerce events.

How it works

The module adds the Taboola browser script to the front office, then sends configured events from PrestaShop page context, order confirmation, customer registration, cart actions, wishlist actions, and custom JavaScript rules.

In the back office, you see the settings form followed by S2S diagnostics. The diagnostics panel shows readiness checks for the Account ID, browser tracking, purchase event name, S2S status, custom event rules, click ID capture, and queue table. It also shows queue totals for pending, sending, sent, and failed, with buttons to send a test S2S probe or retry failed events.

Honest limits

• Browser tracking needs a valid numeric Taboola Account ID and the module must be enabled.
• S2S attribution only works when a valid Taboola click ID is available from tblci, taboola_click_id, or a stored click ID cookie.
• S2S postbacks are optional; the browser Pixel can run without them.
• The S2S probe should use a real Taboola click ID from an ad click URL.
• Custom event rules must be valid JSON and use supported triggers: click, url, controller, or event.
• Event names may contain only letters, numbers, and underscores after normalization.
• Cookie-consent waiting depends on mprcookiesrevolution or mprcookiebanner; without those modules, consent blocking is not applied by this module.
• Add-to-cart and wishlist detection depends on standard PrestaShop events or recognizable theme buttons and data attributes.

Compatibility: PrestaShop 1.6 to 9.0 (latest), PHP 7.1+. We continue to support upcoming PrestaShop versions.