TikTok Events API
Server-side event delivery to TikTok's Events API for enhanced conversion tracking, bypassing browser limitations and improving match quality for ad optimization.
TikTok Events API is a server destination in the walkerOS flow:
Sends events server-side to TikTok's Events API using raw HTTP (no SDK). Identity fields (email, phone_number, external_id) are SHA-256 hashed before sending. Events include a stable `event_id` for deduplication with the browser pixel.
Installation
- Integrated
- Bundled
Configuration
This destination uses the standard destination config wrapper (consent, data, env, id, ...). For the shared fields see destination configuration. Package-specific fields live under config.settings and are listed below.
Settings
| Property | Type | Description | More |
|---|---|---|---|
pixelCode | string | TikTok Pixel Code from Events Manager | |
accessToken | string | Events API access token from TikTok Events Manager | |
url | string | Custom Events API endpoint URL | |
test_event_code | string | Test event code for debugging in TikTok Events Manager | |
doNotHash | Array<string> | User data fields to skip hashing | |
user_data | Record<string, string> | Mapping for user data fields | |
partner_name | string | Partner name for TikTok attribution |
Mapping
This package does not define custom rule-level settings. For the standard rule fields (consent, condition, data, batch, name, policy) see mapping.
Examples
Add to cart
A product add is sent to TikTok as an AddToCart event with value, currency, and product contents.
Submit form
A newsletter form submission is sent to TikTok as a SubmitForm event with the hashed email in user context.
Page view
A page view is forwarded to TikTok as a page view event with the source URL in the page context.
Complete payment
A completed order is sent to the TikTok Events API as a CompletePayment with value, currency, and contents.
Hashing
The destination automatically SHA-256 hashes email, phone_number, and external_id before sending to TikTok. Pass raw values and the hashing is handled for you. If your data is already hashed or you want to skip hashing for specific fields, use the doNotHash setting:
Deduplication
Each event is sent with event_id set to the walkerOS event id. If you also run the TikTok browser pixel, TikTok deduplicates server and browser events that share the same event_id, so conversions are not double-counted.