Platform X
Search…
⌃K

TikTok

TikTok is a social platform short-form video hosting service. The TikTok Events API is a server-side integration that allows you to share website and app visitor events directly with TikTok using their Events API for Web and Events API for App version 1.3.
The Events API for App support is currently under beta testing and coming soon.

Key features

The TikTok destination provides the following key features:
  • Events structure: our Events reference matches TikTok's one, meaning that your data is properly bridged to the expected fields in an optimized way.
  • Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.
  • Support for multi-item data: information included in the item array is dispatched to TikTok.
  • Support for test event code: real-time validation in your test environments with field test_event_code.

Destination setup

Before you get started with this destination, make sure you can access TikTok Ads Manager.
TikTok doesn't support custom event and/or additional property in the payload. In case these are still sent, TikTok will fully discard the associated event and its data.

Configuration

Settings
Description
Access Token
Required for WEB events.
Your API Access Token as provided by TikTok. More details are available by following this LINK.
TikTok Pixel ID
Required for WEB events.
Your Pixel ID as provided by TikTok. You can only add a single pixel id per destination. More details are available by following this LINK.
Test Event Code
For Web events only.
This is used to test event tracking before deploying in production. This code can be found in the TikTok Ads Manager following AssetsEventsManage (Web Events) ➜ Select your pixel ➜ Test Events (Tab).
User Identifier
You can bridge your selected user identifier for logged users.
User Email Field
Select a standard property for TikTok context.user.email field. This can be either User Email [1], User Email MD5 [1] or User Email Sha256. More details are available following this LINK.
[1] Hashed with SHA256. TheTest Event Codecan only be set in test environments as TikTok won't save data coming from live events where this code is included. More details are available following this LINK.

Quick reference

Web events

TikTok supported web events are detailed in this LINK.
Commanders Act Events
TikTok Events
add_payment_info
AddPaymentInfo
add_to_cart
AddToCart
add_to_wishlist
AddToWishlist
begin_checkout
InitiateCheckout
click_button
ClickButton
complete_payment
purchase
CompletePayment [1]
contact
Contact
download
Download
page_view
ViewContent
search
Search
sign_up
CompleteRegistration
submit_form
SubmitForm
subscribe
Subscribe
[1] WithCompletePaymentevents you can take advantage of TikTok Value-Based Optimization for Web (VBO Web).

Field Mappings

TikTok client-side pixel saves a unique identifier in cookie _ttp, which is used to match website visitor events with TikTok ads. This destination starts by getting this identifier from Commanders Actpartners.tiktok.ttpproperty. If it's not present, it looks for the previously mentioned cookie _ttp and sets TikTokcontext.user.ttpproperty with the resulting value. The Tiktok Click ID, also known as ttclid, is a tracking parameter that is attached to your ad's landing page URLs. This destination checks ifpartners.tiktok.ttclidis set with the ttclid value. If it's not present, it looks for cookie ttclid. If none is found it tries by parsing the value frompage.location.href. Advanced matching parameters are highly recommended to improve attribution rates: ensureproperties.user.emailand/orproperties.user.phoneare set. More details on the phone number format rules are available following this LINK.
Commanders Act Properties
TikTok Properties
event_timestamp
timestamp [1]
properties.id
event_id [2]
TikTok Pixel ID
pixel_code
Test Event Code
test_event_code
page.url
context.page.url
page.referrer
context.page.referrer
device.ip
context.ip
device.user_agent
context.user_agent
properties.user.id
context.user.external_id [3]
properties.user.email
properties.user.email_md5
properties.user.email_sha256
context.user.email [3]
properties.user.phone
context.user.phone_number [3]
properties.items.X.content_type
properties.contents.X.content_type [4]
properties.items.X.id
properties.contents.X.content_id
properties.items.X.product.price
properties.contents.X.price
properties.items.X.quantity
properties.contents.X.quantity
properties.content_type
properties.content_type [4]
properties.currency
properties.currency
event_name
properties.description
properties.search_term
properties.query
properties.value
properties.value
partners.tiktok.ttp
context.user.ttp [5]
partners.tiktok.ttclid
context.ad.callback [6]
[1] Automatically converted in the ISO 8601 format. [2] This is required if you are sending overlapping events from both TikTok client-side pixel and this destination. More details on the deduplication are available following this LINK. [3] Field automatically hashed with SHA256 if not passed using this algorithm. [4] This is eitherproductorproduct_groupdepending on how you have configured your data feed when you set up your product catalog. Default value:product. [5]partners.tiktok.ttphas priority over cookie _ttp. [6]partners.tiktok.ttclidhas priority over cookie ttclid. andpage.location.hrefparsing.