Skip to content

Configuration

Open Add-ons → Manage add-ons → Server-Side Tracking for Meta Pixel and Conversions API → Settings. The settings are per storefront: on CS-Cart (Ultimate) choose the storefront at the top of the page, on Multi-Vendor use the storefront selector. Values of the root (all storefronts) apply where a storefront has no value of its own.

Setting Default Description
Pixel ID (dataset ID) empty The pixel from Events Manager → Data sources → Settings. Required; nothing is tracked without it.
Conversions API access token empty Generated in Events Manager → Settings → Conversions API. Without a token only the browser pixel runs.
Test event code empty Routes server events to Test events in Events Manager. Clear it when you go live.
Graph API version v26.0 Conversions API version. Meta supports a version for about two years. Update the value when Meta announces a new one. Invalid values fall back to v26.0.
Load the Meta Pixel library On Turn off only if your theme already loads fbevents.js. Events are still sent through the existing fbq().
Do not track administrators and vendors On Logged-in staff browsing the storefront are ignored.
Allow vendors to add their own pixel Off Multi-Vendor only. See Vendor pixels.
Debug mode Off Logs every pixel call with its event ID in the browser console as [Meta CAPI].

The Status block shows whether the pixel and the Conversions API are ready, the Graph API version in use, and test mode. It also has a Send a test event button and warns about other Meta pixel integrations, such as the core Facebook pixel add-on.

Setting Default Description
Browser events (Meta Pixel) all Events sent with fbq().
Server events (Conversions API) all Events sent by the server. An event enabled in both lists is deduplicated by Meta.
Content ID Product ID Value of content_ids and of the catalog feed id. Product code (SKU) falls back to the ID when a product has no code. It must match your Meta catalog.
Currency Customer’s currency Currency of value and prices: the currency the customer selected, or one fixed store currency.
Purchase value Order total Order total (with shipping and taxes) or the subtotal after discounts.
Send the server Purchase when the order status is Processed, Complete, Open The server-side Purchase is queued once, when a storefront order first enters one of these statuses. Payment gateways that confirm later (status Incomplete first) are reported when the payment arrives.

The events and where they come from:

Event When
PageView Every full page load
ViewContent Product page and quick view
Search Search results, first page
AddToCart Any add to cart or quantity increase, including AJAX and the mini-cart
AddToWishlist Product added to the wishlist (Wishlist add-on)
InitiateCheckout Checkout page, once per cart content
AddPaymentInfo Payment method changed on checkout, or at order placement if the preselected method was kept
Purchase Browser: the order confirmation page, once. Server: when the order reaches a purchase status.
Lead Newsletter subscription (Newsletters add-on) and call request (Call requests add-on)
CompleteRegistration Customer registration on the storefront
Setting Default Description
Advanced matching On Sends hashed customer data with the pixel (fbq('init', id, {...})) and the Conversions API.
Customer fields all Email, phone, first name, last name, city, state, zip, country, date of birth, external ID (cscart_<user_id>).
Send IP address with server events On The client IP address (never hashed). The user agent is always sent: Meta requires it for website events.
Create _fbp / _fbc cookies on the server On After consent, writes _fbp and turns an fbclid from the ad click into _fbc, so matching survives ad blockers.

Data comes from the logged-in customer’s profile, from what the shopper typed at checkout, and, for purchases, from the order. Plain values never leave the store; see Usage for the exact normalisation rules.

Setting Default Description
Consent handling Automatic Automatic: wait for marketing consent when a consent banner is detected (the CS-Cart cookie dialog of the GDPR add-on, or the Kavio Labs cookie consent add-on). Opt-in: always wait. Off: always track.
Use the CS-Cart cookie consent dialog On Adds Meta Pixel and Conversions API as a marketing service to the GDPR add-on’s cookie dialog.
Limited Data Use Off Flags all events with Meta’s Limited Data Use (data_processing_options: ["LDU"] with geolocation), for US state privacy laws.

The Consent status block shows the effective behaviour and the detected consent sources. Custom banners can use the contract described in the Developer guide.

Setting Default Description
Delivery Automatic Automatic: queued events are sent right after the page has been delivered (fastcgi_finish_request on PHP-FPM / LiteSpeed), or by a short non-blocking background request to the store on other servers. Cron job only: the queue is sent only by cron or the Send queued events now button.
Keep the event log for (days) 14 Sent, failed and expired events older than this are deleted once a day.

The Queue block shows the counters of the last 24 hours, the last run, a link to the event log and the cron command. A cron job every 5 minutes is a good safety net even with automatic delivery:

*/5 * * * * php /path/to/store/admin.php --dispatch=kv_meta_conversions_api.process
Setting Default Description
Enable the catalog feed On Turns the feed URLs on or off.
Feed access key random Generated on install; part of the URL. Change it to revoke old URLs.
Feed currency Primary currency Currency of price and sale_price.
Brand Automatic Product feature used as brand. Automatic uses the first Brand feature. Products without a brand get the vendor or store name, because Meta requires a brand, GTIN or MPN.
Description Short description Short description, falling back to the full description, or always the full description.
Include out-of-stock products On Out-of-stock products are listed as out of stock (or available for order if backorders are allowed).

The Feed URLs block shows the CSV and XML URLs. Add &sl=de (any language code) for another language.

The license status is shown in a License card at the top of the add-on page, above the tabs, so you see it on every tab. The License tab holds the key itself. The key is stored once for the whole installation (not per storefront).

License card on the add-on page: status, licensed domain, storefronts, last and next check, with Change license key, Check now and Manage license

The License card shows:

  • the status in color: green when valid, blue for a development host or the 14-day period before a key is required (with the days left), amber when the license server could not be reached (with the days left) or a Marketplace number is still being verified, red when the add-on is switched off;
  • in plain words what the status means and, when the add-on is (or will be) switched off, what stops: no Meta Pixel, no Conversions API events and no catalog feed; the relay and consent endpoints accept nothing. Checkout and order status changes keep working;
  • the licensed domain, every storefront with its result (covered, development host, not covered), the end of the updates and support period, the last and the next check, and the key in use (masked);
  • the actions Enter license key / Change license key (opens the License tab), Check now (verifies at once and stays on the page), Manage license (your licenses on cs-cart.kaviolabs.com) and, without a valid license, Buy a license.

In Add-ons → Manage add-ons the add-on’s row shows a small license badge next to its name, for example License: Valid or License: Pending · 9 days left.

The add-on’s own admin page, the event log, shows a compact license status line at the top: a small green License: Valid chip (blue for a development host, amber while a Marketplace number is being verified) when licensed, and a banner with the status, what is switched off and the actions otherwise.

Setting Description
License key Your Kavio Labs license key (KAVIO-XXXX-XXXX-XXXX-XXXX, from My licenses on cs-cart.kaviolabs.com) or your CS-Cart Marketplace license number. If you entered the Marketplace license number in Add-ons → Manage add-ons (the add-on’s license field), leave this empty: the add-on uses that number.
License status Points to the License card and explains what the check sends.

What the license covers. A license is bound to the base domain you entered at purchase (for example example.com) and covers every subdomain of it (www.example.com, shop.example.com, staging.example.com). Local development hosts are always allowed: localhost, 127.0.0.1 and other private IP addresses, and host names ending in .localhost, .test, .local, .example or .invalid. A store on a different base domain needs its own license. If you move your store to a new domain, contact support.

When the add-on checks. When you save the key, and then once a day. The check runs only in the admin panel (on a page you open) or from cron, never while customers browse the storefront, and takes a few seconds at most. A cron job keeps the license verified even when nobody opens the admin panel:

php /path/to/store/admin.php --dispatch=kv_meta_conversions_api_license.check

What is sent. The check sends this to https://cs-cart.kaviolabs.com and nothing else: the license key, the add-on ID and version, the host names of your storefronts, your CS-Cart version and edition, and a random one-time value. No customer, order or personal data is sent. The server answers with a digitally signed result, so a forged answer is ignored.

Statuses.

Status (card) Color What happens
Valid Green The license is valid for this domain. Everything works.
Development host Blue The store runs on a local development host, which every license covers. Everything works.
Pending verification Amber A CS-Cart Marketplace license number was accepted, but the Marketplace has not confirmed it yet. Everything works.
Pending · N days left Blue No verified key yet (a new installation, or right after upgrading from 1.0.x). Everything works for 14 days.
Grace period · N days left Amber The last checks failed (for example a network problem). The add-on keeps working for 14 days after the first failed check.
Partly valid Amber (CS-Cart with several storefronts) Some storefronts run on another base domain. The pixel and the server events are off on those storefronts only.
Not activated, Invalid key, Revoked, Domain mismatch, Not verified Red No pixel, no browser or server (Conversions API) events and no catalog feed (the feed URLs answer 404); queued events are not sent. Checkout, order status changes and the rest of your store are not affected. Domain mismatch shows the licensed domain next to the domain your store runs on.

When your updates and support period ends, the add-on keeps working. Only updates and support stop.

License information appears in the admin panel only, and only for administrators who may manage add-ons; vendors (Multi-Vendor) and customers never see it. When the add-on is switched off, other admin pages also show a notice once per session with a link to the add-on page; the add-on page itself shows the card instead.