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 source
event_sourcetextRequired - Event source.One of:
web,offline,crm. - Event source id
event_source_idtextRequired - Event source id.
- Event
eventtextRequired - Event.One of:
AddPaymentInfo,AddToCart,AddToWishlist,ApplicationApproval,CompleteRegistration,Contact,CustomizeProduct,Download,FindLocation,InitiateCheckout, and 9 more. - Custom event name
custom_event_nametext - Custom event name.
- Event time
event_timedate and timeRequired - Event time.
- Event id
event_idtextRequired - A stable unique ID for this event. Reuse it when resending the same event.
- Page url
page_urltext - Full page URL, required for web events.
- Referrer
referrertext - Referrer.
- Lead id
lead_idtext - TikTok lead ID, required for CRM events.
- Email
emailtext - Customer email. Lodol trims, lowercases and hashes it with SHA-256.
- Phone
phonetext - Customer phone in E.164 format, including + and country code. Lodol hashes it with SHA-256.
- External id
external_idtext - Customer identifier. Lodol hashes it with SHA-256.
- Ttclid
ttclidtext - Ttclid.
- Ttp
ttptext - Ttp.
- Ip
iptext - Ip.
- User agent
user_agenttext - User agent.
- Properties
propertiesobject - Properties.
- Limited data use
limited_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 source
event_sourcetextRequired - Event source.One of:
web,app,offline,crm. - Event source id
event_source_idtextRequired - Event source id.
- Events
eventslistRequired - Events.
Outputs
dataobject- Tik Tok Events API response data.
Example output
{
"data": {}
}