TikTok Events API - Server-Side Conversions avatar

TikTok Events API - Server-Side Conversions

Pricing

from $0.01 / 1,000 results

Go to Apify Store
TikTok Events API - Server-Side Conversions

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

The Howlers

Maintained by Community

Actor stats

0

Bookmarked

2

Total users

1

Monthly active users

7 days ago

Last modified

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

ParameterTypeDefaultRequiredDescription
taskstring"send_event"Yes*The operation to perform
accessTokenstring-Yes*TikTok Marketing API access token
pixelCodestring-NoTikTok Pixel code to send events to
advertiserIdstring-NoTikTok Ads advertiser account ID
testEventCodestring-NoTest event code from Events Manager
eventNamestring"CompletePayment"NoStandard or custom event name
customEventNamestring-NoName for custom event (if eventName is CustomEvent)
eventsstring-NoJSON array of event objects for batch sending
emailstring-NoCustomer email (will be hashed)
phonestring-NoCustomer phone (will be hashed)
externalIdstring-NoYour unique customer identifier (will be hashed)
ttclidstring-NoTikTok click ID from URL parameter
ttpstring-NoTikTok cookie value (_ttp)
ipAddressstring-NoCustomer IP address
userAgentstring-NoBrowser user agent string
eventTimestring-NoEvent timestamp (Unix timestamp in seconds)
eventSourceUrlstring-NoURL where the conversion occurred
valuenumber-NoMonetary value of the conversion
currencystring"USD"NoISO 4217 currency code
orderIdstring-NoUnique order/transaction identifier
contentIdstring-NoProduct/content identifier
contentTypestring"product"NoType of content
quantityinteger1NoNumber of items
isAlreadyHashedbooleanfalseNoSet to true if PII data is already SHA256 hashed
webhookUrlstring-NoURL to receive results via webhook
demoModebooleantrueNoRun with sample data for testing (no external API calls)

*Required when Demo Mode is off.


Pricing

This actor uses pay-per-event billing:

EventDescriptionPrice
Event SentEach 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