Skip to content

TikTok.Subscribe

Someone subscribes on TikTok, or renews: months says how many months so far.

  • Platform: tiktok
  • Shape: sub
  • Source event: TikTok.Subscribe
Widget.on("TikTok.Subscribe", (event) => {
// event.user, event.platform…
});
  • user (string): Display name; «Anonymous» for anonymous gifts.
  • userId (string): User id on its platform.
  • userLogin (string): Login, lowercase.
  • tier (1 | 2 | 3): Subscription tier.
  • prime (boolean): Whether it is a Prime sub.
  • months (number): Always 1 for a new sub.

It also carries platform (the source platform) and raw (the original payload).

The example payload that reaches the Studio simulator:

{
"userId": "7012345678901234567",
"uniqueId": "neonfox",
"nickname": "NeonFox",
"profilePictureUrl": "",
"subMonth": 1,
"msgId": "7298765432109876547"
}