The TikTok Events API is a Server-to-Server (S2S) integration that allows you to share website and app visitor events directly to TikTok. Data that is shared via the Events API is processed similar to information shared via other TikTok data integration business tools, like the TikTok pixel and TikTok SDK.
This Tag uses the standard GA4 Client and parses GA4 input into TikTok data and sends it through the Events API.
/This tag also supports to send from other sources/
- TikTok Pixel Code
- TikTok Pixel Access Token
- (optional) GA4 Map Purchase Event
The Tag parses all GA4 Client Events into TikTok Events.
page_view - PageView
view_item - ViewContent
click - ClickButton
search - Search
add_to_wishlist - AddToWishList
add_to_cart - AddToCart
begin_checkout - InitiateCheckout
add_payment_info - AddPaymentInfo
purchase - PlaceAnOrder or CompletePayment (see below)
contact - Contact
file_download,download - Download
generate_lead - Submitform
complete_registration - CompleteRegistration
subscribe - Subscribe
For the Purchase event you will be able to select in the dropdown menu which of the following TikTok Purchase events to map with: PlaceAnOrder or CompletePayment. By default PlaceAnOrder will be selected.
If you are not using GA4 standard events you can still use this tag to send data to TikTok
The request Parameters supported are
General
x-ttq-event-name - TikTok Event Name
x-ttq-timestamp - Timestamp in seconds
x-ttq-event-id - Event Id for the event (will be generated by the tag if skipped)
Context
x-ttq-ct-ip-adress - User IP Adress
x-ttq-ct-user-agent - Web User Agent
x-ttq-ct-page-url - Page Url
x-ttq-ct-page-referrer - Page Referrer
x-ttq-ttclid - TikTok Click ID - If not in the Url, this can be sent manually.
User Data
x-ttq-ud-external-id - external id (if hashed, use sha256)
x-ttq-ud-email - email (if hashed, use sha256)
x-ttq-ud-phone-number - phone number (if hashed, use sha256)
Properties
x-ttq-pt-contents - Contents Array
x-ttq-pt-currency - Currency Code
x-ttq-pt-value - Total Value (numeric)
x-ttq-pt-description - Dscription
x-ttq-pt-query - Search Query