This article describes how to set up the TikTok Events connector.

In this article:

API Information

This connector uses the following vendor API:

Batch Limits

This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:

  • Max number of requests: 50
  • Max time since oldest request: 5 minutes
  • Max size of requests: 1 MB

Connector Actions

Action Name AudienceStream EventStream
Send Web Event

Configure Settings

Navigate to the Connector Marketplace and add a new connector. Read the About Connectors article for general instructions on how to add a connector.

After selecting your source, click Continue and then Add Connector. Enter a name for the connector and configure the following settings:

  • App ID
    Required if Access Token is not provided. Mobile App ID. Examples: In the Apple App Store, the App ID is A1B2C3D4E5.com.domainname.applicationname. In the Google Play store, if the URL for the app is https://play.google.com/store/apps/details?id=<package_name>, <package_name> is your App ID. If you are using an Android app not in the Google Play store, use the package name.
  • Access Token
    An authorized Access Token configured in TikTok. For more information, see the Events API article in the TikTok documentation. You can generate an access token by navigating to TikTok Events Manager > Events API > Access Token Generation.
  • Pixel ID
    If you already have a TikTok Pixel integrated on the website, you can use the existing Pixel code. You can find the pixel_code by logging in your TikTok Ads Manager Account. TikTok recommends using one pixel per website.
  • TikTok App ID
    A unique code that is generated in the TikTok Ads Manager.

Click Done when you are finished configuring the connector.

Action Settings — Parameters and Options

Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.

The following sections describe how to set up parameters and options for each action.

Action — Send Web Event

Parameters

Parameter Description
Event Type (Required). Conversion event name.
Custom Event Name (Required). App event name.
Pixel ID Override (Required). Pixel ID that can be found in the TikTok Events Manager. This setting overrides Pixel ID used in the Configuration section.
Event ID Any hashed ID that can identify a unique user or session. Example: SessionID_RandomNumber. If you set Generate Event ID in the TikTok Pixel tag to True, this ID will be automatically generated for every TikTok tracking event.
IP IP address of the browser. It should be the public IP and not hashed. To increase the probability of matching website visitor events with TikTok ads, we recommend sending both IP and User Agent.
User Agent Non-hashed user agent from the user's device. To increase the probability of matching website visitor events with TikTok ads, we recommend sending both IP and User Agent.
Test Event Code To test event tracking, use this field to specify a test code. If the event is received in TikTok, this test code will display in the Test Events tab of the Pixel in TikTok Ads Manager.
Timestamp Timestamp that the event took place. Timestamp with ISO 8601 format 'YYYY-MM-DDThh:mm:ssZ. If no timestamp is provided, the current timestamp will be used.
Callback The value of ttclid used to match website visitor events with TikTok ads.
Referrer Page referrer.
URL Page URL when event happened.
User External ID (apply SHA256 hash) (Recommended). The external user ID. It must be hashed with SHA256. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option.
User External ID (already SHA256 hashed) (Recommended). The external user ID. It must be hashed with SHA256. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option.
User Phone Number (apply SHA256 hash) (Recommended). User's phone number. It must be hashed with SHA256. Include country code with '+' and remove any other characters (spaces, '-') between numbers (Example for US: +12133734253). If the country code is 86, do not include country code (Example: 13800000000). Use Apply SHA256 Hash if unhashed. If already hashed, use Already SHA256 Hashed option.
User Phone Number (already SHA256 hashed) (Recommended). User's phone number. It must be hashed with SHA256. Include country code with '+' and remove any other characters (spaces, '-') between numbers (Example for US: +12133734253). If the country code is 86, do not include country code (Example: 13800000000). Use Apply SHA256 Hash if unhashed. If already hashed, use Already SHA256 Hashed option.
User Email (apply SHA256 hash) (Recommended). Email address. Must be 256 Hashed. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option.
User Email (already SHA256 hashed) (Recommended). Email address. Must be 256 Hashed. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option.
Content Price Price of the item. Supports number data type.
Content Type A description of the product item (Example: being purchased).
Content Quantity Number of items. Supports number data type.
Content ID Product ID in your system.
Description A description of the app event.
Currency 3 Digit ISO-4217 code. Examples: “EUR”, “USD”, “JPY”.
Value Total value of the order or items sold.
Query The text used in a search query.
Public