TikTok.Gift

Someone sends a TikTok gift; a streak arrives once, when it ends.

• Platform: tiktok
• Shape: gift
• Source event: TikTok.Gift

Usage

Widget.on("TikTok.Gift", (event) => {
  // event.user, event.platform…
});

Fields

• user (string): Display name; «Anonymous» for anonymous gifts.
• userId (string): User id on its platform.
• userLogin (string): Login, lowercase.
• gift (string): Gift name.
• imageUrl (string): Gift image, or empty.
• amount (number): How many are sent; in a streak, the total when it ends.
• diamonds (number): Diamonds each one is worth.

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

Example

The example payload that reaches the Studio simulator:

{
  "userId": "7012345678901234567",
  "uniqueId": "neonfox",
  "nickname": "NeonFox",
  "profilePictureUrl": "",
  "giftId": 5655,
  "giftName": "Rose",
  "giftPictureUrl": "",
  "diamondCount": 1,
  "giftType": 1,
  "repeatCount": 3,
  "repeatEnd": true,
  "msgId": "7298765432109876546"
}