TikTok Events API

Before setting up activity tracking on your Odoo website, get a pixel ID and an access token for server-side integration via the API. To do this, follow the steps below.

• 01
  Log in to your TikTok Ads Manager account
• 02
  Go to Tools — Events Manager — Data Sources and click Connect Data Source

• 03
  Select Web as the data source

• 04
  Paste your Odoo website URL into the corresponding field or skip this step

• 05
  Select Manual Setup as the connection method

• 06
  Select TikTok Pixel + Events API as the manual connection method

• 07
  Enter a Name for your pixel

• 08
  On the Implement Events API step, copy the Pixel ID, click Generate Access Token, and also copy the generated value

After installing the module, go to the website settings and enable the Activate Tracking option in the Enhanced Website Tracking section. To test your website tracking and view tracking events in the browser console, temporarily enable the Debug Logging feature.

The module tracks e-commerce events on an Odoo website using a tracking service. It sends tracking events to TikTok Ads Manager along with product information and user-provided data. You can send data via both the TikTok Pixel and the Events API. Add and configure the tracking service for your Odoo website.

Adding a Tracking Service

Go to the Website — Configuration — Tracking — Services menu and click New to add a new tracking service for your Odoo website.

Firstly, fill in the following fields:

• Specify a Website (if multiple websites are used)
• Select TikTok Pixel as the service Type
• Paste your Pixel ID into the Key field

Then select the product identifier type and the product category to send to TikTok Ads Manager.

If products have attributes and variants, choose Product Variant ID in the Item Type field; if not, select Product Template ID.

Select the desired Category Type: an eCommerce Public Category or an internal Product Category.

The next option is the Lead Value on the Options tab. Set the monetary value of lead generation according to your estimates.

Activating the Events API

Activating the TikTok Events API requires an access token and event logging.

Saving tracking events in internal Odoo logs is mandatory for server-side integration.

Enable the Internal Logs option on the Options tab.

Next, activate the server-side integration in the API section—enable the Activate option and paste the generated Access Token.

For instructions on how to generate an access token, see the Getting a Pixel ID and API Access Token section.

Advanced Matching

Advanced matching optimizes your ads by providing user data to TikTok Ads Manager. Open the Advanced Matching tab and specify what information the tracking service should send. The Enable Allowed button allows you to enable all available options for this tracking service.

Checking the Hashed checkbox next to the Customer Name, Email, and Phone options indicates that this customer information is protected using hashing, complying with TikTok requirements.

For better results, also Enable Automatic Advanced Matching (AAM) in your data source settings within TikTok Events Manager.

The tracking service sends events from the internal log via the TikTok Events API at a set interval.

To view internal tracking events, go to Website — Configuration — Tracking — Logs or click the Logs button at the top of the tracking service form.

Enable the State and API Sent Date columns to display the status and date of event transmission to TikTok Ads Manager via the Events API.

Automatic Event Transmission

The module automatically sends tracking events using an Odoo scheduled action. By default, it runs every 30 minutes, and you can adjust this interval to suit your requirements.

The list of scheduled actions is located in Settings — Technical — Automation — Scheduled Actions and is accessible only in Developer Mode.

To send tracking data manually, select tracking logs from the list or open an individual log record and click Send Event.

Sensitive Data Cleanup

Because tracking logs contain sensitive data such as IP addresses and user agents, configure a cleanup schedule. Go to the website settings and set the cleaning Period. The default period is 30 days.

Enable the Unlink Logs After Period option to completely remove tracking logs older than the specified period.

The module includes additional settings available in Developer Mode.

Product Identifier

The module uses the Product ID field as a unique product identifier. To use a different value, specify another product field containing the desired identifier on the Technical tab:

The specified product field should provide non-empty values and remain unique for each product. Otherwise, the tracking data for this product becomes unusable.

Purchase on Portal

To track portal purchases, enable the Track Purchase on Portal option:

Exclude Delivery

The next available setting for tracking services is Exclude Delivery. When enabled, the service excludes delivery lines from sales orders in tracking data transmissions:

Exclude Rewards

To exclude reward order lines from tracking data, enable the Exclude Reward option:

Add to Cart

By default, the module tracks the actual addition of a product to the cart. To track the event upon clicking the button without waiting for the actual addition to the cart, perform the following steps:

• Navigate to Website — Configuration — Websites
• Open the website on the Enhanced Tracking tab
• Enable the Add to Cart on Click option

Tracking the actual addition might fail if third-party modules modify the logic. In this case, this option allows for event tracking by binding it to button selectors used in native Odoo website templates.

Purchase

To track purchases only after a successful payment transaction, enable the Track Confirmed Purchases only option:

This option only affects the event transmission through the tracking service; the internal log records the event regardless.

If business logic considers an order with a Pending payment status as a purchase, enable the Track Pending Purchases too option as well.

You can test the TikTok Events API server-side integration using test events. To do this, follow the steps below.

First, open your data source in TikTok Events Manager under the Test Events tab and copy the Test Code.

Next, open your TikTok Pixel tracking service in Odoo on the Options tab and paste the copied Test Code into the corresponding field. Additionally, enable the Remove JS Script option to prevent sending events to TikTok via the pixel script before launching the event API.

Now, perform several actions on your website, such as browsing the product list or adding an item to the cart.

For testing, log out of Odoo or use a different browser, as website event tracking does not work for internal Odoo users.

After that, go to the log list and send these events manually. If the status is Warning or Error, review the API Response value on the Technical tab for detailed information.

The Sent status means the event was successfully sent via the API.

Return to TikTok Events Manager and check for the presence of test events in the list.

Once testing is complete, clear the Test Code field and disable the Remove JS Script option, as combining browser and server-side event tracking improves performance.