TikTok Conversions
The TikTok Conversions destination is a server-to-server integration with the TikTok Events API that allows advertisers to share website visitor events from Segment directly to TikTok.
Data shared through the Events API is processed similarly to information shared through the TikTok pixel and TikTok SDK business tools. Advertisers can use events data to power solutions like dynamic showcase ads (DSA), custom targeting, campaign optimization and attribution. Advertisers can see their event data in TikTok Events Manager.
Benefits of TikTok Conversions
The TikTok Conversions destination provides the following benefits:
- Clear mapping of data. Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to TikTok.
- Prebuilt mappings. Mappings for TikTok Standard Events, like
PlaceAnOrder, are prebuilt with the prescribed parameters and available for customization. - Streamlined stability and security. Integrate and iterate without client-side limitations, like network connectivity or ad blocker issues.
- Privacy-focused: Stay compliant with rapidly evolving requirements with automatic PII hashing and flexible controls that let you adapt what data you share.
- Maximum event measurement: Capture more events with improved accuracy across different browsers, apps, and devices to get a unified view of your customer’s journey from page view to purchase.
Getting started
Follow the instructions below to enable your TikTok ads account and add the TikTok Conversions destination to your Segment workspace.
TikTok Requirements
The TikTok Conversions destination is configured to use the TikTok Events API. To generate a TikTok Pixel Code and Access Token:
- Create a TikTok For Business account.
- Create a TikTok Pixel in Developer Mode to obtain a Pixel Code. For more information about Developer Mode, please review the TikTok developer documentation.
- Follow instructions for Authorization and generate a long term Access Token.
Connect TikTok Conversions to your workspace
- From the Segment web app, click Catalog, then click Destinations.
- Search for “TikTok Conversions” in the Destinations Catalog, and select the destination.
- Click Configure TikTok Conversions.
- Select the source that will send data to TikTok Conversions and follow the steps to name your destination.
- On the Settings tab, enter in your TikTok Access Token and Pixel Code and click Save.
- Follow the steps in the Destinations Actions documentation on Customizing mappings.
Destination Settings
| Setting | Description |
|---|---|
| Access Token | Required. Your TikTok Access Token. Please see TikTok’s Events API documentation for information on how to generate an access token via the TikTok Ads Manager or API. |
| Pixel Code | Required. Your TikTok Pixel ID. Please see TikTok’s Events API documentation for information on how to find this value. |
Available Presets
TikTok Conversions has the following presets:
| Preset Name | Trigger | Default Action |
|---|---|---|
| Page View | Event type="page" |
Report Web Event |
| Initiate Checkout | Event event = "Checkout Started" |
Report Web Event |
| Place an Order | Event event = "Order Placed" |
Report Web Event |
| Download | Event event = "Download Link Clicked" |
Report Web Event |
| Subscribe | Event event = "Subscription Created" |
Report Web Event |
| Complete Registration | Event event = "Signed Up" |
Report Web Event |
| Add to Wishlist | Event event = "Product Added to Wishlist" |
Report Web Event |
| Submit Form | Event event = "Form Submitted" |
Report Web Event |
| Complete Payment | Event event = "Order Completed" |
Report Web Event |
| View Content | Event event = "Product Viewed" |
Report Web Event |
| Contact | Event event = "Callback Started" |
Report Web Event |
| Search | Event event = "Products Searched" |
Report Web Event |
| Add to Cart | Event event = "Product Added" |
Report Web Event |
| Click Button | Event event = "Product Clicked" |
Report Web Event |
| Add Payment Info | Event event = "Payment Info Entered" |
Report Web Event |
Available Actions
Build your own Mappings. Combine supported triggers with the following TikTok Conversions-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
Report Web Event
Report Web events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.
Report Web Event is a Cloud action.
| Field | Description |
|---|---|
| Event Name* | Type: STRINGConversion event name. Please refer to the “Supported Web Events” section on in TikTok’s Events API documentation for accepted event names. |
| Event ID | Type: STRINGAny hashed ID that can identify a unique user/session. |
| Event Timestamp | Type: STRINGTimestamp that the event took place, in ISO 8601 format. |
| Phone Number | Type: STRINGA single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. e.g. +14150000000. Segment will hash this value before sending to TikTok. |
Type: STRINGA single email address or an array of email addresses. Segment will hash this value before sending to TikTok. |
|
| First Name | Type: STRINGThe first name of the customer. The name should be in lowercase without any punctuation. Special characters are allowed. |
| Last Name | Type: STRINGThe last name of the customer. The name should be in lowercase without any punctuation. Special characters are allowed. |
| Address | Type: OBJECTThe address of the customer. |
| Order ID | Type: STRINGOrder ID of the transaction. |
| Shop ID | Type: STRINGShop ID of the transaction. |
| External ID | Type: STRINGUniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok. TikTok Conversions Destination supports both string and string[] types for sending external ID(s). |
| TikTok Click ID | Type: STRINGThe value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See Set up ttclid for details. |
| TikTok Cookie ID | Type: STRINGTikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the |
| TikTok Lead ID | Type: STRINGID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability |
| Locale | Type: STRINGThe BCP 47 language identifier. For reference, refer to the IETF BCP 47 standardized code. |
| Page URL | Type: STRINGThe page URL where the conversion event took place. |
| Page Referrer | Type: STRINGThe page referrer. |
| IP Address | Type: STRINGIP address of the browser. |
| User Agent | Type: STRINGUser agent from the user’s device. |
| Contents | Type: OBJECTRelated item details for the event. |
| Content Type | Type: STRINGType of the product item. When the |
| Currency | Type: STRINGCurrency for the value specified as ISO 4217 code. |
| Value | Type: NUMBERValue of the order or items sold. |
| Description | Type: STRINGA string description of the web event. |
| Query | Type: STRINGThe text string that was searched for. |
| Limited Data Use | Type: BOOLEANUse this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to Events API 2.0 - Limited Data Use. |
| Test Event Code | Type: STRINGUse this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the “Test Event” tab. You’ll want to remove your Test Event Code when sending real traffic through this integration. |
FAQ & Troubleshooting
Deduplication with the TikTok Pixel
If you independently placed the TikTok Pixel on your website, reach out to your TikTok representative to see if there are any necessary changes to your Pixel to properly deduplicate events sent through both the Pixel and the Segment TikTok Conversions destination.
Match Keys
To increase the probability of matching website visitor events with TikTok ads, send one or more of the following match keys and identifiers when possible:
- TikTok Click ID
- External ID
- Phone Number
- IP Address
- User Agent
Other Standard Events
If you want to send a TikTok standard event that Segment doesn’t have a prebuilt mapping for, you can use the Report Web Event action to send the standard event. For example, if you want to send a CompleteRegistration event:
- Create a mapping for Report Web Event.
- Set up your Event Trigger criteria for completed registrations.
- Input a literal string of “CompleteRegistration” as the Event Name.
Please be aware that TikTok only supports these event names.
PII Hashing
Segment creates a SHA-256 hash of the following fields before sending to TikTok:
- External ID
- Phone Number
Web Diagnostics
You can check whether the integration is working, test events in real-time, and troubleshoot common issues in TikTok’s Web Diagnostics Suite. See the TikTok Pixel Web Diagnostics documentation for more information.
Support
The TikTok Conversions destination is owned and maintained by the TikTok team.
- For general Segment questions, including issues with event data not being sent to TikTok Events Manager, contact Segment support.
- For questions regarding campaign setup and performance, web tracking, or additional API functionality, contact your TikTok representative.
This page was last modified: 21 Feb 2023
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!