Skip to Content
Odoo Menu
  • Sign in
  • Try it free
  • Apps
    Finance
    • Accounting
    • Invoicing
    • Expenses
    • Spreadsheet (BI)
    • Documents
    • Sign
    Sales
    • CRM
    • Sales
    • POS Shop
    • POS Restaurant
    • Subscriptions
    • Rental
    Websites
    • Website Builder
    • eCommerce
    • Blog
    • Forum
    • Live Chat
    • eLearning
    Supply Chain
    • Inventory
    • Manufacturing
    • PLM
    • Purchase
    • Maintenance
    • Quality
    Human Resources
    • Employees
    • Recruitment
    • Time Off
    • Appraisals
    • Referrals
    • Fleet
    Marketing
    • Social Marketing
    • Email Marketing
    • SMS Marketing
    • Events
    • Marketing Automation
    • Surveys
    Services
    • Project
    • Timesheets
    • Field Service
    • Helpdesk
    • Planning
    • Appointments
    Productivity
    • Discuss
    • Approvals
    • IoT
    • VoIP
    • Knowledge
    • WhatsApp
    Third party apps Odoo Studio Odoo Cloud Platform
  • Industries
    Retail
    • Book Store
    • Clothing Store
    • Furniture Store
    • Grocery Store
    • Hardware Store
    • Toy Store
    Food & Hospitality
    • Bar and Pub
    • Restaurant
    • Fast Food
    • Guest House
    • Beverage Distributor
    • Hotel
    Real Estate
    • Real Estate Agency
    • Architecture Firm
    • Construction
    • Estate Management
    • Gardening
    • Property Owner Association
    Consulting
    • Accounting Firm
    • Odoo Partner
    • Marketing Agency
    • Law firm
    • Talent Acquisition
    • Audit & Certification
    Manufacturing
    • Textile
    • Metal
    • Furnitures
    • Food
    • Brewery
    • Corporate Gifts
    Health & Fitness
    • Sports Club
    • Eyewear Store
    • Fitness Center
    • Wellness Practitioners
    • Pharmacy
    • Hair Salon
    Trades
    • Handyman
    • IT Hardware & Support
    • Solar Energy Systems
    • Shoe Maker
    • Cleaning Services
    • HVAC Services
    Others
    • Nonprofit Organization
    • Environmental Agency
    • Billboard Rental
    • Photography
    • Bike Leasing
    • Software Reseller
    Browse all Industries
  • Community
    Learn
    • Tutorials
    • Documentation
    • Certifications
    • Training
    • Blog
    • Podcast
    Empower Education
    • Education Program
    • Scale Up! Business Game
    • Visit Odoo
    Get the Software
    • Download
    • Compare Editions
    • Releases
    Collaborate
    • Github
    • Forum
    • Events
    • Translations
    • Become a Partner
    • Services for Partners
    • Register your Accounting Firm
    Get Services
    • Find a Partner
    • Find an Accountant
      • Get a Tailored Demo
    • Implementation Services
    • Customer References
    • Support
    • Upgrades
    Github Youtube Twitter Linkedin Instagram Facebook Spotify
    +32 2 290 34 90
    • Get a Tailored Demo
  • Pricing
  • Help
  1. APPS
  2. eCommerce
  3. Odoo TikTok Events API v 16.0
  4. Sales Conditions FAQ

Odoo TikTok Events API

by Garazd Creation https://garazd.biz/shop/odoo-tiktok-events-api-241
Odoo

$ 286.94

v 16.0 Third Party 1
Live Preview
Apps purchases are linked to your Odoo account, please sign in or sign up first.
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • Website (website)
• Discuss (mail)
• eCommerce (website_sale)
• Invoicing (account)
Community Apps Dependencies Show
• Odoo TikTok Pixel eCommerce Tracking
• Request Helper
• Odoo TikTok Pixel Integration
• Website | eCommerce Tracking Base
Lines of code 2127
Technical Name website_sale_tiktok_capi
LicenseOPL-1
Websitehttps://garazd.biz/shop/odoo-tiktok-events-api-241
Versions 16.0 17.0 18.0 19.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • Website (website)
• Discuss (mail)
• eCommerce (website_sale)
• Invoicing (account)
Community Apps Dependencies Show
• Odoo TikTok Pixel eCommerce Tracking
• Request Helper
• Odoo TikTok Pixel Integration
• Website | eCommerce Tracking Base
Lines of code 2127
Technical Name website_sale_tiktok_capi
LicenseOPL-1
Websitehttps://garazd.biz/shop/odoo-tiktok-events-api-241
Versions 16.0 17.0 18.0 19.0
  • Description
  • License
This module extends the functionality of the TikTok Pixel eCommerce app.
If you have already purchased it for Odoo 16.0, you will pay only
159.00 EUR
  • Community
  • Enterprise
Enterprise Community

Server-side tracking on Odoo websites with TikTok Conversion API (Events API) integration to send tracking events to TikTok Ads Events Manager

Description

TikTok Events API - is a server-side connection to provide tracking data from Odoo to TikTok.

Odoo e-Commerce events can be tracked as by TikTok Pixel, and the Events API as well. The solution allows you to manage which connection method to use, the browser-side, the server-side, or both.

Events that are sent to TikTok contain product and sale order details, customer data for advanced matching, and the event identifier for deduplication.

The module setup guide:

Configuration in TikTok Enable Website Tracking Configuration in Odoo Advanced Matching Testing Monitoring

Benefits
Easy & Simple

Easy to activate and configure

Multi-Tags

Support multiple tags on one website

Support

Free 60 days support and 360 days bug-fixing

Try me

Demo & Test. Click on the "Live Preview" button

TikTok Pixel and Events API
Setup Events API
Open your TikTok Ads Manager and go to the "Tools" - "Events" menu. Then, add a new data source or use an existing one. You need copy your TikTok Pixel ID, it will be required for Odoo settings.
Odoo 16.0 activation of TikTok Ads Manager tools events menu
Settings for an existing TikTok Pixel
When you already have a TikTok Pixel, go to the Settings tab, and in the Event setup — Events API section generate an access token.
Odoo 16.0 activation of TikTok Pixel Events API
Odoo 16.0 TikTok Conversions API generate token
Copy the generated token, and continue with settings on the Odoo side.
New TikTok Pixel adding
Otherwise, if you are creating the new data source, click to the Connect data source, and choose the Web connection type.
Odoo 16.0 new TikTok Pixel data source
Specify your website in the next step, and select the Manual Setup in the following window.
Odoo website review by TikTok Ads manager for 16.0
Manual setup of TikTok Pixel and vents API in Odoo 16.0
You should choose the TikTok Pixel + Events API option, if you need both the connection methods, the browser-side and server-side.
TikTok Pixel + Events API connection method for Odoo 16.0
Automatic Advanced Matching activation
Activate the Automatic Advanced Matching option to increase audience size and attributed conversions.
TikTok Automatic Advanced Matching activation for Odoo 16.0
Set up events
Skip this step clicking by Next.
Odoo TikTok set up events 16.0
Odoo TikTok verify pixel setup in 16.0
Now, configure your business funnel. Most likely, the E-commerce funnel template will suit you.
TikTok Events configuring for Odoo 16.0
At this step you need also to activate the following events parameters:
  • contend_id
  • contend_type
  • contend_category
  • contend_name
  • description
  • value
  • price
  • currency
  • quantity
  • event_id
Generate access token
In the next step, generate the access token for the TikTok Events API. Copy it and save, as you need it for settings on the Odoo side.
Generate TikTok Conversion API access token for Odoo 16.0
That's all for now on the TikTok side, open your Odoo and let's continue settings there.
Enable Website Tracking
Go to the menu "Website" - "Configuration" - "Settings" and activate the related option in the "Tracking" section.
Odoo Website tracking activate in 16.0
You can activate the debug logging for testing purposes as well. Additional messages will be added to the Odoo log and the browser console.
Sensitive data cleaning up

The solution cleans sensitive tracking data such as payload, client IP address, and user agent. You can control the period after which the purging is performed. By default, it's 30 days.

Configuration of this option only makes sense if you use the "Internal Logs" in your tracking services.

Additionally, you can activate the "Completely delete log entries older than the specified period" option to remove all internal tracking log records after this time.

Customer Names

When you are going to use the Advanced Matching and send your website customers' names in the tracking data, specify the order of the first and the last names. As, in some countries, a partner name can start with the first name, and with the last name in others.

Enable Website Tracking
Go to the menu "Website" - "Configuration" - "Settings" and activate the related option in the "Tracking" section.
Odoo Website tracking activate in 16.0
You can activate the Debug Logging for testing purposes as well. Additional messages will be added to the Odoo log and the browser console.
Sensitive data cleaning up

The solution cleans sensitive tracking data such as payload, client IP address, and user agent. You can control the period after which the purging is performed. By default, it's 30 days.

Configuration of this option only makes sense if you use the "Internal Logs" in your tracking services.

Additionally, you can activate the "Completely delete log entries older than the specified period" option to remove all internal tracking log records after this time.

Configuration
Adding the TikTok tracking service

Click on the "Manage Tracking Services" link or go to the "Configuration" - "Tracking" - "Services" menu and create a new tracking service for your Odoo website.

Odoo TikTok Events API - configure a tracking service in Odoo 16.0

Configure the tracking service in the following way:

  • Specify a website (if you have a multi-website environment).
  • Select the service type "TikTok Pixel".
  • Fill in your TikTok Pixel ID to the Key field.
  • Activate the "Internal Logs" option.

Internal logging is a required option for the TikTok Events API integration, it must be enabled.

Additionally, it provides internal tracking analytics. To view the log records related to the current service, click the "Logs" button at the top of the form.

  • Activate the "API" option.

According to the TikTok's Web measurement guidance, it's recommended "setting up both the TikTok Pixel and Events API together to maximize measurement and performance of your campaigns".

This Odoo app implements this behavior by default, but you can deactivate the TikTok Pixel script on your website by the "Remove JS Pixel script" option.

In the case when both the tracking are active, the solution sends the additional parameter Event ID to perform a deduplication on the TikTok side.

Advanced Matching

Activate the Automatic Advanced Matching for your TikTok Events API in Odoo on the "Advanced Matching" tab.

TikTok Events API Advanced Matching settings for Odoo 16.0
Customer Data Source

In case when you allow guest checkouts without registering on the Odoo portal, it can cause a lack of user data for advanced matching.

By selecting the "Sale Order Partner" option, you can supplement user data by customer details from their sales orders.

Testing
Testing Particularities

As a website activity of Odoo internal users should not be tracked, there are several testing tips:

  • You will not see any internal tracking logs if you are logged in to Odoo and you have an internal user access rights.
  • You need to log out from Odoo, or use the incognito mode, or use another browser to test website tracking.
Testing with Internal Logging

After configuring of the TikTok Conversion API, make a checkout on your Odoo eCommerce. Go through all the checkout steps: from viewing the product list, adding products to cart, initiating a checkout process and completing on the confirmation page. Switch back to your Odoo and open the TikTok tracking service logs, you should see the tracking logs for all eCommerce events.

Odoo TikTok Conversion API tracking logs in 16.0
Testing with TikTok Ads Manager

Select your TikTok Pixel in the Events Manager, and on the Test Events tab copy the test event code:

Getting the TikTok test event code for Odoo 16.0

Put this code to your TikTok tracking service in Odoo.

Testing the TikTok Events API with a test event code in Odoo 16.0

After that, perform several actions on your website and send these tracking events in the following way:

Send a tracking event data to TikTok via Conversions API in Odoo 16.0

On the TikTok Ads Manager side, the events will appear in the Event Activity list.

Testing the TikTok Events API with a test event code in Odoo 16.0
Don't forget to remove the test code from the tracking service in Odoo after testing.
Monitoring events tracking

Monitor your TikTok Events API integration with the TikTok Ads Manager to get analytics and get informed about performance and issues.

Open the Events Manager by going to the "Tools" - "Management" - "Events" menu and select your data source.

Odoo 16.0 TikTok Events API monitoring by Events Manager in TikTok Ads
Related Modules
Odoo App Facebook Conversions API
Facebook Conversions API

Meta Facebook Conversions API | Facebook Conversion API | Meta CAPI for Tracking Events | Facebook CAPI Integration

Odoo App Google Analytics 4 eCommerce
Google Analytics 4 eCommerce

Google Analytics 4 for eCommerce | GA4 Retail and Ecommerce Events

Odoo App Snapchat Pixel Events
Snapchat Pixel Events

Snapchat Pixel eCommerce Events Tracking

Contact Us
Support, customizations, and development
https://garazd.biz/contactus
support@garazd.biz
https://garazd.biz/support
Our expertise
Official Odoo Partner
OCA Member
With Odoo since 2014
Over 25,000 app downloads and purchases
Our apps in the TOP 10 on Odoo Apps
Explore our apps
Watch and subscribe
Version: 16.0.1.0.0
Module design is reserved | Copyright © Garazd Creation
Changelog
  • 16.0.1.0.0 2024-06-04
    • Init version.
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.
Community
  • Tutorials
  • Documentation
  • Forum
Open Source
  • Download
  • Github
  • Runbot
  • Translations
Services
  • Odoo.sh Hosting
  • Support
  • Upgrade
  • Custom Developments
  • Education
  • Find an Accountant
  • Find a Partner
  • Become a Partner
About us
  • Our company
  • Brand Assets
  • Contact us
  • Jobs
  • Events
  • Podcast
  • Blog
  • Customers
  • Legal • Privacy
  • Security

Odoo is a suite of open source business apps that cover all your company needs: CRM, eCommerce, accounting, inventory, point of sale, project management, etc.

Odoo's unique value proposition is to be at the same time very easy to use and fully integrated.

Website made with