settings:

- category: Connection Settings

settings:

- name: Access Token (required)

description: TikTok Long Term Access Token. You can generate this from the TikTok Marketing API portal. Please follow TikTok's [Authorization guide](https://ads.tiktok.com/athena/docs/index.html?plat_id=-1&doc_id=100010&id=100681&key=e98b971a296ae45d8e35a22fba032d1c06f5973de9aab73ce07b82f230cf3afd){:target="_blank"} for more info.

default:

- name: Secret Key (required)

description: TikTok App Secret Key. You can find this key in the "Basic Information" tab of your TikTok app.

default:

- name: App Id (required)

description: TikTok App Id. You can find this key in the "Basic Information" tab of your TikTok app.

default:

- name: Pixel Code (required)

description: An ID for your pixel. Required to send events to the TikTok pixel.

default:

actions:

- action: Report Web Event

blurb: Report events directly to TikTok.

fields:

- name: Email

description: Email address of the user who triggered the conversion event.

default: coalesce(properties.email, traits.email)

- name: External ID

description: Uniquely identifies the user who triggered the conversion event.

default: coalesce(userId, anonymousId)

- name: Event Name

description: Conversion event name. Please refer to the "Supported Web Events" section on [this](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106){:target="_blank"} page for accepted event names.

default:

- name: Event ID

description: Any hashed ID that can identify a unique user/session.

default: messageId

- name: Event Timestamp

description: Timestamp that the event took place, in ISO 8601 format.

default:

- name: Segment Event Type

description: The Segment Event type, for example, "page".

default: type

- name: Properties associated with the event

description: Additional properties such as content info, description, and currency.

default:

- name: Phone Number

description: Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000.

default: coalesce(properties.phone, traits.phone)

title: TikTok Conversions

hide-boilerplate: true

hide-dossier: true

hidden: true

{% include content/plan-grid.md name="actions" %}

The TikTok Conversions Destination enables advertisers to send Segment events to report events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.

Reporting web events allows advertisers to send user data directly to TikTok for downstream targeting and optimization. Advertisers will be able to see their event data in TikTok Events Manager.

1. **Streamlined stability and security**: Integrate and iterate without client-side limitations, like network connectivity or ad blocker issues.

2. **Configurable privacy controls**: Stay compliant with rapidly evolving requirements with flexible privacy controls that let you adapt what data you share and when you share it.

3. **Maximum event measurement**: Capture more events with improved accuracy across different browsers, apps and devices to get a unified view of your customer's journey from page view to purchase.

Follow the instructions below to enable your TikTok ads account, and add the TikTok Conversions destination to your Segment workspace.

1. [Create a TikTok For Business account](https://ads.tiktok.com/marketing_api/docs?id=1702715936951297){:target="_blank"}.

2. [Register as a developer](https://ads.tiktok.com/marketing_api/docs?id=1702716323359809{:target="_blank"}).

3. [Create a developer application](https://ads.tiktok.com/marketing_api/docs?id=1702716474845185){:target="_blank"}.

4. Follow instructions for [Authorization](https://ads.tiktok.com/marketing_api/docs?id=1701890912382977){:target="_blank"} and generate a long term access token.

1. From the Segment web app, click **Catalog**, then click **Destinations**.

2. Find the Destinations Actions item in the left navigation, and click it.

3. Click **Configure TikTok Conversions**.

4. Select an existing Source to connect to TikTok Conversions.

5. On the next page enter your TikTok Access Token, Secret Key, App Id, and Pixel Code. Click Verify credentials.

{% include components/actions-fields.html name="tiktok" connection="true" %}

By default a new TikTok Conversions destination comes with the following subscriptions.

| Subscription Name | Trigger | TikTok Conversions Action |

| ----------------- | --------------------------------------------------- | ------------------------- |

| Products Searched | All events where the name is `Products Searched` | Report Web Event |

| Add Payment Info | All events where the name is `Payment Info Entered` | Report Web Event |

| Initiate Checkout | All events where the name is `Checkout Started` | Report Web Event |

| Order Completed | All events where the name is `Order Completed` | Report Web Event |

| View Content | All **Page** events | Report Web Event |

Choose **Quick Setup** during configuration to can select these subscriptions. You can enable, edit, and disable them from the Actions tab of the destination.

The pre-built TikTok Conversions Subscriptions trigger the same action, **Report Web Event**. The default subscriptions map events that follow Segment's Spec to the TikTok spec. You can create new subscriptions and map events that best suit your configuration.

The table below shows the mapping of the Segment semantic ecommerce or custom event names to the TikTok semantic conversion event names in the prebuilt subscriptions.

| Segment Event Name | TikTok Semantic Conversion Event Name |

| -------------------- | ------------------------------------- |

| Checkout Started | InitiateCheckout |

| Products Searched | Search |

| Payment Info Entered | AddPaymentInfo |

| Order Completed | PlaceOrder |

| Segment Event Type | TikTok Semantic Conversion Event Name |

| -------------------------- | ------------------------------------- |

| All **Segment Page Calls** | ViewContent |

Combine the supported [triggers](/docs/connections/destinations/actions/#components-of-a-destination-action) with the following TikTok-supported actions:

- [Report Web Event](#report-web-event)

{% include components/actions-fields.html name="tiktok" %}

All TikTok Conversions subscriptions trigger the Report Web Event action.

This action sends a request from Segment to the [TikTok Events Web API](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106){:target="_blank"}.

Ensure you've created your TikTok Pixel within Events Manager before sending events. Instructions to create a pixel can be found [here](https://ads.tiktok.com/help/article?aid=10021){:target="_blank"}.

- The TikTok Events API supports QPS =< 1k per app（TikTok Marketing API app）per endpoint. If more is required, please contact your TikTok account representative.

- Requests report events to one pixel ID. This restriction is because authorization is done at user/pixel level. See the Authorization section for details.

- Data that is shared to the Events API is processed similar to information shared through other TikTok data integration business tools, like the TikTok pixel and TikTok SDK.