TikTok Events API - Server-Side Conversions
Pricing
from $0.01 / 1,000 results
TikTok Events API - Server-Side Conversions
Send offline events and server-side conversions to TikTok Events API. Track purchases, signups, and custom events with automatic PII hashing for campaign attribution.
Pricing
from $0.01 / 1,000 results
Rating
0.0
(0)
Developer
The Howlers
Actor stats
0
Bookmarked
2
Total users
1
Monthly active users
7 days ago
Last modified
Categories
Share
Send offline events and server-side conversions to TikTok Events API. Track purchases, signups, and custom events with automatic PII hashing.
BYOK (Bring Your Own Key) -- you provide your own API credentials.
Before You Start
This actor requires your own API credentials to fetch real data.
Where to get your key: TikTok Marketing API access token
You can test with Demo Mode first (free, no key needed) to see the output format before committing.
Quick Start
Test with Demo Mode (free, no API key needed)
{"demoMode": true,"eventSourceUrl": "https://example.com"}
Run with real data
{"demoMode": false,"task": "send_event","accessToken": "YOUR_API_KEY_HERE","eventName": "CompletePayment","eventSourceUrl": "https://example.com","currency": "USD","contentType": "product","quantity": 1,"isAlreadyHashed": false}
Input Parameters
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
task | string | "send_event" | Yes* | The operation to perform |
accessToken | string | - | Yes* | TikTok Marketing API access token |
pixelCode | string | - | No | TikTok Pixel code to send events to |
advertiserId | string | - | No | TikTok Ads advertiser account ID |
testEventCode | string | - | No | Test event code from Events Manager |
eventName | string | "CompletePayment" | No | Standard or custom event name |
customEventName | string | - | No | Name for custom event (if eventName is CustomEvent) |
events | string | - | No | JSON array of event objects for batch sending |
email | string | - | No | Customer email (will be hashed) |
phone | string | - | No | Customer phone (will be hashed) |
externalId | string | - | No | Your unique customer identifier (will be hashed) |
ttclid | string | - | No | TikTok click ID from URL parameter |
ttp | string | - | No | TikTok cookie value (_ttp) |
ipAddress | string | - | No | Customer IP address |
userAgent | string | - | No | Browser user agent string |
eventTime | string | - | No | Event timestamp (Unix timestamp in seconds) |
eventSourceUrl | string | - | No | URL where the conversion occurred |
value | number | - | No | Monetary value of the conversion |
currency | string | "USD" | No | ISO 4217 currency code |
orderId | string | - | No | Unique order/transaction identifier |
contentId | string | - | No | Product/content identifier |
contentType | string | "product" | No | Type of content |
quantity | integer | 1 | No | Number of items |
isAlreadyHashed | boolean | false | No | Set to true if PII data is already SHA256 hashed |
webhookUrl | string | - | No | URL to receive results via webhook |
demoMode | boolean | true | No | Run with sample data for testing (no external API calls) |
*Required when Demo Mode is off.
Pricing
This actor uses pay-per-event billing:
| Event | Description | Price |
|---|---|---|
| Event Sent | Each TikTok event sent | $0.01 |
Demo mode is free -- no charges for sample data.
Troubleshooting
"API key is required"
You have Demo Mode turned off but didn't provide an API key. Either:
- Turn Demo Mode on to test with sample data
- Add your API key in the input
"API error 403" or "Unauthorized"
Your API key is invalid, expired, or doesn't have access to this specific API endpoint. Double-check your key and account permissions.
"API error 429" or "Rate limit"
Too many requests. Wait a minute and try again, or reduce the number of items per run.
No results or empty dataset
Check the run log for error messages. Common causes:
- Invalid input format (check the examples above)
- API key without proper permissions
- The target data doesn't exist or is too small to track
How do I test without an API key?
Enable Demo Mode in the input. This returns realistic sample data so you can verify the output format works for your workflow.
Built by John Rippy | Actor Arsenal