Skip to content
adscapi

TikTok CAPI Payload Preview

The server-side request adscapi builds when you track() a purchase and TikTok is configured. Secrets and hashed values show as placeholders.

Request

POST
Endpoint
https://business-api.tiktok.com/open_api/v1.3/event/track/
Headers
Access-Token: {TIKTOK_EVENTS_TOKEN}
Content-Type: application/json
Body (purchase example)
{
  "event_source": "web",
  "event_source_id": "{TIKTOK_PIXEL_ID}",
  "data": [
    {
      "event": "Purchase",
      "event_time": 1739452800,
      "user": {
        "email": "<sha256(normalized-email)>",
        "phone_number": "<sha256(e164-phone)>",
        "ip": "203.0.113.10"
      },
      "properties": {
        "value": 49.99,
        "currency": "USD",
        "order_id": "order_1001"
      },
      "event_id": "order_1001"
    }
  ]
}

Verified against the library dispatcher (src/dispatchers/tiktok.ts). See the TikTok setup guide for where to get each secret.

Required secrets

TIKTOK_EVENTS_TOKENTIKTOK_PIXEL_ID

TikTok activates when every secret is present. One missing key and the platform no-ops — the rest still receive the event.

Event-name mapping

Canonical eventTikTok receives
page_viewViewContent
leadSubmitForm
signup_startsignup_start (custom event passthrough)
signupCompleteRegistration
checkout_createdInitiateCheckout
purchasePurchase
reply_generatedreply_generated (custom event passthrough)
upgrade_clickedupgrade_clicked (custom event passthrough)

Good to know

  • Token goes in the Access-Token header, not Authorization; the pixel id rides in the body as event_source_id.
  • email, phone_number, and ip in user send only with adUserData consent.
  • The dispatcher reads no click id for TikTok.

Frequently Asked Questions

Related Tools

Discover more free tools to fix your tracking

Event Payload Playground

Pick a canonical conversion event, fill the fields, and see the exact JSON payload adscapi builds — before you write a line of code.

Try it now

PII Hash Previewer

Type a raw email or phone number and see the normalized value plus its SHA-256 hash — the exact rules adscapi applies per platform. Nothing leaves the browser.

Try it now

Platform Coverage Explorer

Search all 26 ad platforms adscapi dispatches to — support level, required secrets, and setup docs, always in sync with the library registry.

Try it now

Ready to track TikTok conversions server-side?

adscapi is free and open source. Set your platform tokens, call track() once, and every configured Conversions API receives the event — hashed the way each platform expects.