Parameters

Action

Parameters

Hide parameters

Event Source

string

required

This field maps to the destination API event_source field.

Test Event Code

string

This field maps to the destination API test_event_code field.

Event

string

required

This field maps to the destination API data.event field.

Event Time

timing.v1.Timestamp

required

This field maps to the destination API data.event_time field.

Event ID

string

This field maps to the destination API data.event_id field.

TikTok Click ID

string

This field maps to the destination API data.user.ttclid field.

Emails

[]string

required

PII This field maps to the destination API data.user.email field.

Phones

[]string

required

PII This field maps to the destination API data.user.phone field.

External IDs

[]string

required

ID This field maps to the destination API data.user.external_id field.

This field maps to the destination API data.user.ttp field.

IP Address

string

PII This field maps to the destination API data.user.ip field.

User Agent

string

PII This field maps to the destination API data.user.user_agent field.

Locale

string

This field maps to the destination API data.user.locale field.

Content IDs

[]string

required

This field maps to the destination API data.properties.content_ids field.

Content Type

string

This field maps to the destination API data.properties.content_type field.

Currency

string

This field maps to the destination API data.properties.currency field.

Value

float64 (double)

This field maps to the destination API data.properties.value field.

Number of Items

int64

This field maps to the destination API data.properties.num_items field.

Search String

string

This field maps to the destination API data.properties.search_string field.

Description

string

This field maps to the destination API data.properties.description field.

Order ID

string

This field maps to the destination API data.properties.order_id field.

Shop ID

string

This field maps to the destination API data.properties.shop_id field.

Price

float64 (double)

This field maps to the destination API data.properties.contents.price field.

Content ID

string

This field maps to the destination API data.properties.contents.content_id field.

Content Category

string

This field maps to the destination API data.properties.contents.content_category field.

Content Name

string

This field maps to the destination API data.properties.contents.content_name field.

Brand

string

This field maps to the destination API data.properties.contents.brand field.

URL

string

required

This field maps to the destination API data.page.url field.

Referrer

string

This field maps to the destination API data.page.referrer field.

Limited Data Use

bool

This field maps to the destination API data.limited_data_use field.

{
  "$result_object_key": {
    "code": 0,
    "message": "OK",
    "request_id": "123456789021142B04A217BC0086BACCDA"
  }
}

{
  "$result_object_key": {
    "code": "Tiktok response code",
    "message": "Response message",
    "request_id": "The log ID of a request, which uniquely identifies the request"
  }
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.

SendEventResponse

Fetch Action Response Object

Hide fields

code

int64

required

Tiktok response code

CEL

$result_object_key.code

Example

message

string

required

Response message

CEL

$result_object_key.message

Example

"OK"

request_id

string

required

The log ID of a request, which uniquely identifies the request

CEL

$result_object_key.request_id

Example

"123456789021142B04A217BC0086BACCDA"

Events

Actions

Integrations

Send Event

Parameters

Result Object Field Details

Events

Actions

Integrations

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details