Description
PixelSync connects your WooCommerce store to TikTok Ads. It sends events from the visitor’s browser (TikTok Pixel) and from your server (TikTok Events API / Conversions API), and gives each pair of events the same event_id so TikTok counts every action once.
Key features
- Pixel and Conversions API together: Browser and server events share one deterministic
event_id, so TikTok can merge them into a single event. - Standard and same-page checkouts: Purchases are tracked on the normal WooCommerce thank-you page, and also when an order is placed from a single-page form with no redirect. Several orders placed on the same page without reloading are each tracked.
- Standard e-commerce events: PageView, ViewContent, Search, AddToCart, InitiateCheckout, AddPaymentInfo, CompletePayment and CompleteRegistration. Each one can be switched on or off.
- Advanced Matching (optional): Email, phone number and city are hashed with SHA-256 before they are sent, which can improve event match quality.
- Duplicate protection: Each order is flagged when its Purchase event is sent, so refreshing the thank-you page does not send it again.
- Live Diagnostic Feed (beta): An optional log in your admin that shows the events being sent, so you can check deduplication.
- Product catalogue feed: A private feed URL you can give to TikTok Catalog.
External Services
This plugin sends tracking and conversion data to TikTok. It only does so after you enter your Pixel ID, and server events are sent only when you also enter an access token.
TikTok Pixel (browser)
* Service: TikTok Pixel SDK, loaded from https://analytics.tiktok.com/i18n/pixel/events.js.
* Used for: sending events from the visitor’s browser to TikTok Ads.
* Data sent: page views, product views, add to cart, checkout, payment and purchase events with product and order details (IDs, names, prices, currency, quantity), and, when Advanced Matching is on, hashed email, phone and city. TikTok’s script also receives the visitor’s IP address and browser information.
TikTok Events API / Conversions API (server)
* Service: https://business-api.tiktok.com/open_api/v1.3/pixel/track/.
* Used for: sending the same events from your server, so they are not lost to browser restrictions.
* Data sent: the event name and ID, the same event details as above, the visitor’s IP address and user agent, the TikTok cookie and click ID (ttp, ttclid) when present, and SHA-256 hashed email and phone number when available.
Your Pixel ID and access token stay on your site and are used to authorise the requests.
- TikTok Privacy Policy: https://www.tiktok.com/legal/page/row/privacy-policy/en
- TikTok Business Products Terms: https://ads.tiktok.com/i18n/official/policy/business-products-terms
You are responsible for informing your visitors and getting any consent that the law requires in your country.
Screenshots
Installation
- Make sure WooCommerce is installed and active.
- Upload the
pixelsyncfolder to/wp-content/plugins/, or install the plugin from the Plugins screen. - Activate PixelSync through the Plugins menu.
- Open PixelSync in the admin menu and enter your TikTok Pixel ID and, for server events, your Events API access token.
- Choose which events to track, save, and check them with TikTok’s Test Events tool (you can enter a test event code in the settings).
FAQ
-
How does event deduplication work?
-
PixelSync creates an
event_idon the server and gives the same ID to the browser script. The browser Pixel and the server Conversions API both send that ID, so TikTok merges them into one event. -
Do I need the Conversions API access token?
-
No. Without a token only browser events are sent. With a token, server events are also sent, which helps when browsers block tracking.
-
Is my customer’s personal data sent to TikTok?
-
Only what TikTok needs to match events. Email addresses and phone numbers are hashed with SHA-256 before they are sent, and only when Advanced Matching is on. Technical data such as the visitor’s IP address, browser user agent and the TikTok cookie and click ID (
ttp,ttclid) are sent as they are, because TikTok uses them for matching. See the External Services section below. -
Will this slow down my site?
-
The Pixel script loads asynchronously. Server events are sent while WordPress handles the request, with a 20-second timeout. If TikTok does not accept an event, the plugin retries it in the background using Action Scheduler, which comes with WooCommerce.
-
Does it work with page caching?
-
Yes, with one thing to watch. Some caching plugins can serve a stored page after an add-to-cart redirect, so the browser AddToCart event may be late or missing on that page. If you see this, exclude the cart and checkout pages from caching, and clear your site cache after updating the plugin.
-
Can I see what is being sent?
-
Yes. Turn on the Live Diagnostic Feed in the settings. It lists each event with its source (browser or server), status and event ID.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“PixelSync – Pixel & Conversions API for TikTok” is open source software. The following people have contributed to this plugin.
Contributors
Translate “PixelSync – Pixel & Conversions API for TikTok” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- First public release.
- Browser Pixel and server Conversions API with shared event IDs.
- Purchase tracking for standard and same-page checkouts.
- Advanced Matching with SHA-256 hashing.
- Live Diagnostic Feed and catalogue feed.
- Automatic upgrade of settings from earlier private versions.