TikTok Events API

App · 2 actions

Report web, offline, app, and CRM conversions through TikTok Events API 2.0 with stable event IDs.

Send event

Send event.

Inputs

Event sourceevent_sourcetextRequired
Event source.One of: web, offline, crm.
Event source idevent_source_idtextRequired
Event source id.
EventeventtextRequired
Event.One of: AddPaymentInfo, AddToCart, AddToWishlist, ApplicationApproval, CompleteRegistration, Contact, CustomizeProduct, Download, FindLocation, InitiateCheckout, and 9 more.
Custom event namecustom_event_nametext
Custom event name.
Event timeevent_timedate and timeRequired
Event time.
Event idevent_idtextRequired
A stable unique ID for this event. Reuse it when resending the same event.
Page urlpage_urltext
Full page URL, required for web events.
Referrerreferrertext
Referrer.
Lead idlead_idtext
TikTok lead ID, required for CRM events.
Emailemailtext
Customer email. Lodol trims, lowercases and hashes it with SHA-256.
Phonephonetext
Customer phone in E.164 format, including + and country code. Lodol hashes it with SHA-256.
External idexternal_idtext
Customer identifier. Lodol hashes it with SHA-256.
Ttclidttclidtext
Ttclid.
Ttpttptext
Ttp.
Ipiptext
Ip.
User agentuser_agenttext
User agent.
Propertiespropertiesobject
Properties.
Limited data uselimited_data_usetrue/false
Limited data use.

Outputs

dataobject
Tik Tok Events API response data.
Example output
{
  "data": {}
}

Send events

Send up to 1,000 already prepared events. Use Unix seconds for event_time and SHA-256 hashes for email, phone, and external_id. App events require TikTok approval.

Inputs

Event sourceevent_sourcetextRequired
Event source.One of: web, app, offline, crm.
Event source idevent_source_idtextRequired
Event source id.
EventseventslistRequired
Events.

Outputs

dataobject
Tik Tok Events API response data.
Example output
{
  "data": {}
}

On this page