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
Setup
- Integrated
- Bundled
Configuration reference
| 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 |
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.
Docker deployment
Step 1: Create flow configuration
Use the $env.NAME syntax in your flow configuration to reference environment variables at runtime:
Step 2: Bundle the flow
Bundle your flow configuration before running in Docker:
Step 3: Run with Docker
Docker Compose example
Never commit access tokens to version control. Use environment variables or a secrets manager to inject credentials at runtime.