Tiktok Offline Conversions (Actions) Destination

On this page

Destination Info
  • Accepts Track calls.
  • Refer to it as Tiktok Offline Conversions (Actions), or Tiktok Offline Conversions in the Integrations object
  • This destination is in Beta
Partner Owned
  • This integration is partner owned. Please reach out to the partner's support for any issues.

Tiktok’s Offline Events API helps advertisers measure how TikTok ads result in offline customer actions, such as in-store purchases or offline subscriptions, purchases and more. Attributing online and offline events is an important step for advertisers to measure omni-channel results from their campaigns.

Benefits

  • Measure how TikTok ads influence offline conversions. Learn what online strategies lead to better Brick & Mortar sales, subscription sign-ups or leads.
  • Power holistic attribution models with cross-channel event tracking. Combine online and offline touchpoints to get comprehensive campaign metrics, like ROAS.
  • Reach offline customers online with custom audiences. Promote new products or services to high-value customers who initiative offline events.

This destination is maintained by Tiktok. For any issues with the destination, contact their Support team.

Getting started

Prior to setting up the TikTok Offline Conversion Destination, please create an Offline Event Set and generate the Access Token for it from TikTok Events Manager.

  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 Offline Conversions (Actions).
  4. Select an existing Source to connect to Tiktok Offline Conversions (Actions).
  5. Give Destination a name.
  6. On the Settings screen, provide Access Token and Event Set ID.
  7. Toggle on the Destination.
  8. Hit the Save Change button.

Mappings Enabled by Default

After setting up the Destination, four mappings will be enabled by default. You can click on the mappings tab to view and edit these mappings.

  • Complete Payment: use this to track offline purchase events
  • Subscribe: use this to track offline subscription events
  • Contact: use this to track offline contact events
  • Submit Form: use this to track offline form submissions

Destination Settings

Setting Description
Access Token Required.

Your TikTok Access Token. Please see TikTok’s Events API 2.0 documentation for information on how to generate an access token via the TikTok Ads Manager or API.
Event Set ID Required.

Your TikTok Offline Event Set ID. Please see TikTok’s Events API 2.0 documentation for information on how to find this value.

Available Presets

Tiktok Offline Conversions has the following presets:

Preset Name Trigger Default Action
Add to Cart Event event = "Product Added"
 Track Offline Conversion
Submit Form Event event = "Form Submitted"
 Track Offline Conversion
Complete Registration Event event = "Signed Up"
 Track Offline Conversion
Contact Event event = "Callback Started"
 Track Offline Conversion
Initiate Checkout Event event = "Checkout Started"
 Track Offline Conversion
Search Event event = "Products Searched"
 Track Offline Conversion
Complete Payment Event event = "Order Completed"
 Track Offline Conversion
Subscribe Event event = "Subscription Created"
 Track Offline Conversion
View Content Event event = "Product Viewed"
 Track Offline Conversion
Download Event event = "Download Link Clicked"
 Track Offline Conversion
Click Button Event event = "Product Clicked"
 Track Offline Conversion
Place an Order Event event = "Order Placed"
 Track Offline Conversion
Add to Wishlist Event event = "Product Added to Wishlist"
 Track Offline Conversion
Add Payment Info Event event = "Payment Info Entered"
 Track Offline Conversion
Page View Event type="page"
 Track Offline Conversion

Available Actions

Build your own Mappings. Combine supported triggers with the following Tiktok Offline Conversions-supported actions:

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

[Deprecated] Track Non Payment Offline Conversion

[Deprecated] Send a non payment related event to the TikTok Offline Conversions API. This Action has been Deprecated. Please use the ‘Track Payment Offline Conversion’ Action instead

[Deprecated] Track Non Payment Offline Conversion is a Cloud action.

Click to show / hide fields

Field Description
Event Name* Type: STRING

Conversion event name. Please refer to the “Offline Standard Events” section on in TikTok’s Events API 2.0 documentation for accepted event names.
Event ID Type: STRING

Any hashed ID that can identify a unique user/session.
Event Timestamp Type: STRING

Timestamp that the event took place, in ISO 8601 format.
Phone Number Type: STRING

A single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. At least one phone number value is required if both Email and External ID fields are empty.
Email Type: STRING

A single email address or an array of email addresses. Segment will hash this value before sending to TikTok. At least one email value is required if both Phone Number and External ID fields are empty.
Order ID Type: STRING

Order ID of the transaction.
Shop ID Type: STRING

Shop ID of the transaction.
External ID Type: STRING

Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok. TikTok Offline Conversions Destination supports both string and string[] types for sending external ID(s). At least one external ID value is required if both Email and Phone Number fields are empty.
TikTok Click ID Type: STRING

The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See Set up ttclid for details.
TikTok Cookie ID Type: STRING

TikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the _ttp cookie. The value of _ttp is used to match website visitor events with TikTok ads. You can extract the value of _ttp and attach the value here. To learn more about the ttp parameter, refer to Events API 2.0 - Send TikTok Cookie (_ttp).
TikTok Lead ID Type: STRING

ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability
Locale Type: STRING

The BCP 47 language identifier. For reference, refer to the IETF BCP 47 standardized code.
Page URL Type: STRING

The page URL where the conversion event took place.
Page Referrer Type: STRING

The page referrer.
IP Address Type: STRING

IP address of the browser.
User Agent Type: STRING

User agent from the user’s device.
Contents Type: OBJECT

Related item details for the event.
Content Type Type: STRING

Type of the product item. When the content_id in the Contents field is specified as a sku_id, set this field to product. When the content_id in the Contents field is specified as an item_group_id, set this field to product_group.
Currency Type: STRING

Currency for the value specified as ISO 4217 code.
Value Type: NUMBER

Value of the order or items sold.
Description Type: STRING

A string description of the web event.
Query Type: STRING

The text string that was searched for.
Limited Data Use Type: BOOLEAN

Use this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to Events API 2.0 - Limited Data Use.
Test Event Code Type: STRING

Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the “Test Event” tab. You’ll want to remove your Test Event Code when sending real traffic through this integration.

[Deprecated] Track Payment Offline Conversion

[Deprecated] Send details of an in-store purchase or console purchase to the Tiktok Offline Events API. This Action has been Deprecated. Please use the ‘Track Payment Offline Conversion’ Action instead

[Deprecated] Track Payment Offline Conversion is a Cloud action.

Click to show / hide fields

Field Description
Event Name* Type: STRING

Conversion event name. Please refer to the “Offline Standard Events” section on in TikTok’s Events API 2.0 documentation for accepted event names.
Event ID Type: STRING

Any hashed ID that can identify a unique user/session.
Event Timestamp Type: STRING

Timestamp that the event took place, in ISO 8601 format.
Phone Number Type: STRING

A single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. At least one phone number value is required if both Email and External ID fields are empty.
Email Type: STRING

A single email address or an array of email addresses. Segment will hash this value before sending to TikTok. At least one email value is required if both Phone Number and External ID fields are empty.
Order ID Type: STRING

Order ID of the transaction.
Shop ID Type: STRING

Shop ID of the transaction.
External ID Type: STRING

Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok. TikTok Offline Conversions Destination supports both string and string[] types for sending external ID(s). At least one external ID value is required if both Email and Phone Number fields are empty.
TikTok Click ID Type: STRING

The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See Set up ttclid for details.
TikTok Cookie ID Type: STRING

TikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the _ttp cookie. The value of _ttp is used to match website visitor events with TikTok ads. You can extract the value of _ttp and attach the value here. To learn more about the ttp parameter, refer to Events API 2.0 - Send TikTok Cookie (_ttp).
TikTok Lead ID Type: STRING

ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability
Locale Type: STRING

The BCP 47 language identifier. For reference, refer to the IETF BCP 47 standardized code.
Page URL Type: STRING

The page URL where the conversion event took place.
Page Referrer Type: STRING

The page referrer.
IP Address Type: STRING

IP address of the browser.
User Agent Type: STRING

User agent from the user’s device.
Contents Type: OBJECT

Related item details for the event.
Content Type Type: STRING

Type of the product item. When the content_id in the Contents field is specified as a sku_id, set this field to product. When the content_id in the Contents field is specified as an item_group_id, set this field to product_group.
Currency Type: STRING

Currency for the value specified as ISO 4217 code.
Value Type: NUMBER

Value of the order or items sold.
Description Type: STRING

A string description of the web event.
Query Type: STRING

The text string that was searched for.
Limited Data Use Type: BOOLEAN

Use this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to Events API 2.0 - Limited Data Use.
Test Event Code Type: STRING

Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the “Test Event” tab. You’ll want to remove your Test Event Code when sending real traffic through this integration.

Track Offline Conversion

Send details of an in-store purchase or console purchase to the Tiktok Offline Events API

Track Offline Conversion is a Cloud action.

Click to show / hide fields

Field Description
Event Name* Type: STRING

Conversion event name. Please refer to the “Offline Standard Events” section on in TikTok’s Events API 2.0 documentation for accepted event names.
Event ID Type: STRING

Any hashed ID that can identify a unique user/session.
Event Timestamp Type: STRING

Timestamp that the event took place, in ISO 8601 format.
Phone Number Type: STRING

A single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. At least one phone number value is required if both Email and External ID fields are empty.
Email Type: STRING

A single email address or an array of email addresses. Segment will hash this value before sending to TikTok. At least one email value is required if both Phone Number and External ID fields are empty.
Order ID Type: STRING

Order ID of the transaction.
Shop ID Type: STRING

Shop ID of the transaction.
External ID Type: STRING

Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok. TikTok Offline Conversions Destination supports both string and string[] types for sending external ID(s). At least one external ID value is required if both Email and Phone Number fields are empty.
TikTok Click ID Type: STRING

The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See Set up ttclid for details.
TikTok Cookie ID Type: STRING

TikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the _ttp cookie. The value of _ttp is used to match website visitor events with TikTok ads. You can extract the value of _ttp and attach the value here. To learn more about the ttp parameter, refer to Events API 2.0 - Send TikTok Cookie (_ttp).
TikTok Lead ID Type: STRING

ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability
Locale Type: STRING

The BCP 47 language identifier. For reference, refer to the IETF BCP 47 standardized code.
Page URL Type: STRING

The page URL where the conversion event took place.
Page Referrer Type: STRING

The page referrer.
IP Address Type: STRING

IP address of the browser.
User Agent Type: STRING

User agent from the user’s device.
Contents Type: OBJECT

Related item details for the event.
Content Type Type: STRING

Type of the product item. When the content_id in the Contents field is specified as a sku_id, set this field to product. When the content_id in the Contents field is specified as an item_group_id, set this field to product_group.
Currency Type: STRING

Currency for the value specified as ISO 4217 code.
Value Type: NUMBER

Value of the order or items sold.
Description Type: STRING

A string description of the web event.
Query Type: STRING

The text string that was searched for.
Limited Data Use Type: BOOLEAN

Use this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to Events API 2.0 - Limited Data Use.
Test Event Code Type: STRING

Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the “Test Event” tab. You’ll want to remove your Test Event Code when sending real traffic through this integration.

Acess Token & Event Set ID

Please refer to the documentation to obtain the Access Token and the Event Set ID.

PII Requirement & Validation

TikTok Offline Events API requires at least one type of PII (email addresses and/or phone numbers) to be included in all offline conversion events. The email addresses and phone numbers will be hashed using SHA 256 from Segment before they are sent to TikTok. TikTok Offline Conversions Destination will automatically hash the provided PII, so please do not hash the PIIs before sending them to Segment. In addition, TikTok Offline Conversions Destination will validate all offline events before forwarding them to TikTok Offline Events API. TikTok Offline Conversions Destination will not send any offline events to TikTok with invalid or missing PIIs.

Data and Privacy Considerations

  • Every offline event sent to TikTok Offline Events API requires at least one email address or phone number.
  • E-mails and phone numbers will be hashed in a privacy-safe way by default so that TikTok cannot identify customers who are not TikTok users.
  • iOS compliance checks will be performed on PII (ATT opt-out users will still be reported and attributed).
  • TikTok will pruge unmatched offline conversions IDs/records.

Engage

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Real-time to batch destination sync frequency

Real-time audience syncs to Tiktok Offline Conversions (Actions) may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
Access Token
(required)		 string. Your TikTok Access Token. Please see TikTok’s Events API 2.0 documentation for information on how to generate an access token via the TikTok Ads Manager or API.
Event Set ID
(required)		 string. Your TikTok Offline Event Set ID. Please see TikTok’s Events API 2.0 documentation for information on how to find this value.

This page was last modified: 06 Dec 2023

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account

Was this page helpful?