API

circle-exclamation

Below you will find the keys to generate secret payloads for adding or updating a channel via the Script API.

Refer to the configuration pagearrow-up-right for detailed information on the purpose and usage of each input.

TT_OAUTH_ACCESS_TOKEN

In this secret, you would store the access token obtained from the TikTok OAuth process. Example value 012cb7a37cea4p4b05ac0233c498d8aac4c33e53 Type PASSWORD Optional false

TT_PIXEL_ID

Use for storing the Pixel ID.

Example value CM08ISRC77U2H4CKPULG Type IDENTIFIER Optional false

TT_PURCHASE_EVENT

Please always send the value as 'CompletePayment' if it has not been configured earlier. See the config descriptionarrow-up-right.

Example value CompletePayment or PlaceAnOrder

Type TEXT

Optional true

TT_ADVERTISER_ID

Use for storing Ad Account ID

Example value 7276450817098661891 Type TEXT Optional false

TT_BROWSER_PIXEL

See the config descriptionarrow-up-right.

Possible values 1 or 0

Type CHECKBOX

Optional true

TT_PRODUCT_ID_MAPPING

See the config descriptionarrow-up-right.

Possible values 0 for Product ID 1 for Variant ID 2 for SKU

Type TEXT

Optional true

TT_OFFLINE_SET_ID

See the config descriptionarrow-up-right.

Example value 7298285311644254209

Type TEXT

Optional true

TT_PIXEL_TEST

See the config descriptionarrow-up-right.

Example value TEST39331

Type TEXT

Optional true

Last updated

Was this helpful?