Gift

Alert key: tiktok-gift
Source: TikTok
Event list label: Gift
Carries alert image: yes (extraSettings.contentImage)

Default message template

{{username}} sent x{{giftAmount}} {{giftName}}

Template variables

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variable	Overlay payload field	Description
`{{username}}`	`data.extraSettings.username`	The username of the sender
`{{userId}}`	`data.extraSettings.userId`	The user ID of the sender
`{{avatar}}`	`data.extraSettings.avatar`	The url of the avatar of the sender for a message
`{{coins}}`	`data.extraSettings.coins`	No description available yet.
`{{diamonds}}`	`data.extraSettings.diamonds`	No description available yet.
`{{giftId}}`	`data.extraSettings.giftId`	TikTok battle gift ID for this progress update
`{{giftName}}`	`data.extraSettings.giftName`	No description available yet.
`{{giftPictureUrl}}`	`data.extraSettings.giftPictureUrl`	No description available yet.
`{{giftType}}`	`data.extraSettings.giftType`	No description available yet.
`{{giftAmount}}`	`data.extraSettings.giftAmount`	Amount gifted by user
`{{amount}}`	`data.extraSettings.amount`	The amount sent

Example payloads

Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).

Rose (1 coin)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 1,
    "name": "Rose",
    "amount": 1
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Rose",
    "giftType": 1,
    "giftId": 5655,
    "giftAmount": 1,
    "value": 1,
    "coins": 1,
    "diamonds": 1,
    "amount": 1,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/eba3a9bb85c33e017f3648eaf88d7189~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Finger Heart (5 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 5,
    "name": "Finger Heart",
    "amount": 5
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Finger Heart",
    "giftType": 1,
    "giftId": 5487,
    "giftAmount": 1,
    "value": 5,
    "coins": 5,
    "diamonds": 2,
    "amount": 5,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/a4c4dc437fd3a6632aba149769491f49.png~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Rosa (10 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 10,
    "name": "Rosa",
    "amount": 10
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Rosa",
    "giftType": 1,
    "giftId": 8913,
    "giftAmount": 1,
    "value": 10,
    "coins": 10,
    "diamonds": 5,
    "amount": 10,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/eb77ead5c3abb6da6034d3cf6cfeb438~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Perfume (20 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 20,
    "name": "Perfume",
    "amount": 20
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Perfume",
    "giftType": 1,
    "giftId": 5658,
    "giftAmount": 1,
    "value": 20,
    "coins": 20,
    "diamonds": 10,
    "amount": 20,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/20b8f61246c7b6032777bb81bf4ee055~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Doughnut (30 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 30,
    "name": "Doughnut",
    "amount": 30
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Doughnut",
    "giftType": 1,
    "giftId": 5879,
    "giftAmount": 1,
    "value": 30,
    "coins": 30,
    "diamonds": 15,
    "amount": 30,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/4e7ad6bdf0a1d860c538f38026d4e812~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Hand Hearts (100 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 100,
    "name": "Hand Hearts",
    "amount": 100
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Hand Hearts",
    "giftType": 1,
    "giftId": 5660,
    "giftAmount": 1,
    "value": 100,
    "coins": 100,
    "diamonds": 50,
    "amount": 100,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/6cd022271dc4669d182cad856384870f~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Sunglasses (199 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 199,
    "name": "Sunglasses",
    "amount": 199
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Sunglasses",
    "giftType": 2,
    "giftId": 5509,
    "giftAmount": 1,
    "value": 199,
    "coins": 199,
    "diamonds": 99,
    "amount": 199,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/alisg/webcast-sg/08af67ab13a8053269bf539fd27f3873.png~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Baby Chicks (500 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 500,
    "name": "Baby Chicks",
    "amount": 500
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Baby Chicks",
    "giftType": 2,
    "giftId": 54725,
    "giftAmount": 1,
    "value": 500,
    "coins": 500,
    "diamonds": 250,
    "amount": 500,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/alisg/webcast-sg/resource/f1b0b043890f33ba610f2b30fffad49f.png~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Galaxy (1,000 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 1000,
    "name": "Galaxy",
    "amount": 1000
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Galaxy",
    "giftType": 2,
    "giftId": 11046,
    "giftAmount": 1,
    "value": 1000,
    "coins": 1000,
    "diamonds": 500,
    "amount": 1000,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/resource/79a02148079526539f7599150da9fd28.png~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Whale Diving (2,150 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 2150,
    "name": "Whale Diving",
    "amount": 2150
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Whale Diving",
    "giftType": 2,
    "giftId": 6820,
    "giftAmount": 1,
    "value": 2150,
    "coins": 2150,
    "diamonds": 1075,
    "amount": 2150,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/46fa70966d8e931497f5289060f9a794~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Lion (29,999 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 29999,
    "name": "Lion",
    "amount": 29999
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Lion",
    "giftType": 2,
    "giftId": 6369,
    "giftAmount": 1,
    "value": 29999,
    "coins": 29999,
    "diamonds": 14999,
    "amount": 29999,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/4fb89af2082a290b37d704e20f4fe729~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

TikTok Universe (44,999 coins)

{
  "alert": "tiktok-gift",
  "dynamic": {
    "value": 44999,
    "name": "TikTok Universe",
    "amount": 44999
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "TikTok Universe",
    "giftType": 2,
    "giftId": 9101,
    "giftAmount": 1,
    "value": 44999,
    "coins": 44999,
    "diamonds": 22499,
    "amount": 44999,
    "contentImage": "https://p16-webcast.tiktokcdn.com/img/maliva/webcast-va/8f471afbcebfda3841a6cc515e381f58~tplv-obj.webp",
    "userId": "",
    "giftPictureUrl": ""
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

RANDOM
EQUAL_SELECTION - Gift Name is equal to
EQUAL_NUMBER - Coins is equal to
GREATER_NUMBER - Coins is greater than or equal to
EQUAL_USERNAME
EQUAL_VARIABLE

Alert Explorer - live preview of every alert
Overlay Type Definitions - full AlertEvent TypeScript type

Default message template​

Template variables​

Example payloads​

Rose (1 coin)​

Finger Heart (5 coins)​

Rosa (10 coins)​

Perfume (20 coins)​

Doughnut (30 coins)​

Hand Hearts (100 coins)​

Sunglasses (199 coins)​

Baby Chicks (500 coins)​

Galaxy (1,000 coins)​

Whale Diving (2,150 coins)​

Lion (29,999 coins)​

TikTok Universe (44,999 coins)​

Variation conditions​

Related​