TikTok Marketing Suite

Version v1.1.0
Last Updated 26 November 2025

TikTok Pixel & Events API Configuration

Complete reference for TikTok Pixel and Events API settings. Use both for optimal tracking accuracy.

Location: Stores → Configuration → Magmodules → TikTok - Pixel & CAPI

Overview

The module supports two tracking methods:

Method Type Description
TikTok Pixel Client-side (browser) JavaScript-based tracking on your website
Events API Server-side Direct server-to-TikTok communication

Recommendation: Enable both for maximum accuracy. Events API captures events that Pixel might miss due to ad blockers or browser restrictions.

Pixel Configuration

Enable

Enable TikTok Pixel tracking on your store.

Pixel ID

Your unique TikTok Pixel identifier.

Where to find it:

  1. Go to TikTok Ads Manager
  2. Go to Assets → Events
  3. Select your Pixel
  4. Copy the Pixel ID from Settings

Events

Select which events to track via Pixel:

Event Triggers when
PageView Any page is viewed
ViewContent Product page is viewed
AddToCart Product added to cart
ViewCart Cart page is viewed
InitiateCheckout Checkout is started
AddToWishlist Product added to wishlist
Search Search is performed
CompleteRegistration Customer account is created
Purchase Order is completed

Recommendation: Enable all events for complete funnel tracking.

Events API Configuration

Enable

Enable server-side event tracking via Events API.

Access Token

Your TikTok Events API access token (stored encrypted).

Where to find it:

  1. Go to TikTok Events Manager
  2. Select your Pixel
  3. Go to Settings → Events API
  4. Click "Generate Access Token"

Events

Select which events to track via Events API:

Event Triggers when
ViewContent Product page is viewed
AddToCart Product added to cart
AddToWishlist Product added to wishlist
Search Search is performed
InitiateCheckout Checkout is started
AddPaymentInfo Payment method is selected
CompleteRegistration Customer account is created
Subscribe Newsletter subscription
Lead Contact form submission
Purchase Order is completed

Test Event Code

Optional field for testing your Events API integration.

How to use:

  1. Go to TikTok Events Manager → Data Sources → Your Pixel → Test Events
  2. Copy the Test Event Code
  3. Enter it in this field
  4. Perform actions in your store
  5. View real-time events in TikTok's Test Events tab

Important: Remove the Test Event Code after testing is complete!

How Events Are Tracked

Pixel Events (Client-Side)

Events fire via JavaScript when the action occurs in the browser:

Customer action → Browser JavaScript → TikTok Pixel → TikTok

Pros: Real-time, captures client data Cons: Blocked by ad blockers, affected by browser privacy settings

Events API (Server-Side)

Events are queued and sent from your server:

Customer action → Magento Observer → Processing Queue → Cron → TikTok API

Pros: Not affected by ad blockers, more reliable Cons: Slight delay (queue processed every 5 minutes)

Event Deduplication

When both Pixel and Events API are enabled, TikTok uses event_id to deduplicate events, ensuring each action is counted only once.

Data Captured

User Data (Hashed)

The following user data is captured and SHA-256 hashed before sending:

Data Source
Email Customer account or checkout
Phone Billing address
First name Customer account or billing
Last name Customer account or billing
City Billing address
State Billing address
Zip code Billing address
Country Billing address

Technical Data

Data Purpose
IP Address Geo-targeting
User Agent Device targeting
_ttp cookie Cross-device tracking
ttclid TikTok Click ID from URL
External ID Customer ID matching

Processing Queue

Events API events are processed via a queue for reliability:

  1. Event occurs → Added to queue (status: pending)
  2. Cron runs every 5 minutes → Processes pending events
  3. Success → Status updated to "success"
  4. Failure → Retried up to 3 times, then marked "failed"

Monitor the queue at: Marketing → Magmodules TikTok → Processing Queue

Best Practices

Enable Both Pixel and Events API

For maximum event capture rate:

  • Pixel catches immediate interactions
  • Events API provides backup for blocked/missed events
  • TikTok deduplicates automatically

Select Same Events for Both

Enable the same events in both Pixel and Events API settings to ensure complete coverage.

Monitor the Processing Queue

Regularly check the queue for failed events:

  1. Go to Marketing → Magmodules TikTok → Processing Queue
  2. Filter by Status = Failed
  3. Check error messages
  4. Fix configuration issues if needed

Verify in Events Manager

After setup, verify events in TikTok:

  1. Go to Events Manager
  2. Select your Pixel
  3. Check "Overview" for recent events
  4. Use "Test Events" for real-time debugging

Need More Help?

Documentation:

Support:

Article Updated:
star star star star star
star star star star star
Alexandru-Manuel Carabus
Magmodules sets the bar for Magento module quality and support—we check their catalog first for client feature requests, and they’re our first choice for licenses.
Google 11 Nov 2025
star star star star star
star star star star star
Matt Austin
Possibly the fastest support response times of any Magento Extension vendor. Great extensions too!
Google 09 Sep 2025
star star star star star
star star star star star
Jan Privé
Dankzij de heldere uitleg en snelle reactie van Magmodules kon mijn vraag, en dus mijn Magento-probleem, binnen enkele uren worden beantwoord. Doeltreffend, zonder moeilijke termen, gewoon zo als het zou moeten zijn.... Bedankt!
Google 05 Sep 2025
star star star star star
star star star star star
Denis Metzler
To evaluate a provider, it is not enough to consider only the product offered, but also its after-sales service, such as support and troubleshooting. Magmodules has been extremely satisfactory at all levels on multiple occasions and sets the bar at the top when comparing the competition.
Google 02 Sep 2025
star star star star star
star star star star star
Bleijenberg winkelinrichting en materialen
Goed bereikbaar, reageren snel en denken oplossingsgericht. Een aanrader.
Google 30 Jul 2025
star star star star star
star star star star star
Patrick Verduijn
Magmodules biedt plugins aan die van hoge kwaliteit zijn tegen een goede prijs, waar dit bedrijf in uitblinkt is de bereidheid om de zeldzame feedback & problemen met de plugins te willen onderzoeken, mee te willen denken in het debuggen van problemen en goede oplossingen toe te passen. In mijn decennium ervaring met Magento & 3th parties is Magmodules absoluut een uniqum binnen de markt.
Google 25 Jul 2025
star star star star star
star star star star star
Erik de Groot
Magemodules heeft hele sterke Magento extensies en een proactieve support. Al jaren heel erg tevreden over jullie service en producten!
Google 18 Jul 2025
star star star star star
star star star star star
René Zeuner
We are using the Mollie Magento extension from Magmodules. It works excellently without flaws. Very fast, competent and friendly support. Thanks!
Google 30 Jun 2025
star star star star star
star star star star star
R. U.
Erg goed team, reageren snel en duidelijk en hebben met toegang tot onze database erg goed geholpen (eigenlijk een gratis customization).
Google 18 Jun 2025
star star star star star
star star star star star
Hugo de Groot
Uitstekende support! Wij gebruiken o.a. de Rich Snippets Suite extensie voor onze Magento 2 webshop (Hyvä) en hadden een specifieke vraag over structured data op PLP-pagina’s. Binnen no-time kregen we een inhoudelijk en duidelijk antwoord. Zeer prettig contact en goed onderbouwde uitleg. Absoluut een betrouwbare partner voor Magento-extensies!
Google 13 Jun 2025