Pin Message

• Alert key: tiktok-pinMessage
• Source: TikTok
• Event list label: Pin Message

Default message template

Pinned message: {{message}}

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
{{message}}	data.extraSettings.message	The message text sent by the user
{{messageId}}	data.extraSettings.messageId	The ID of the message
{{pinId}}	data.extraSettings.pinId	No description available yet.
{{pinTime}}	data.extraSettings.pinTime	No description available yet.
{{operatorUsername}}	data.extraSettings.operatorUsername	No description available yet.
{{operatorUserId}}	data.extraSettings.operatorUserId	No description available yet.

Example payloads

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

Pinned Message

{
  "alert": "tiktok-pinMessage",
  "dynamic": {
    "value": "Remember to follow!"
  },
  "extraSettings": {
    "message": "Remember to follow!",
    "pinId": "1",
    "messageId": "",
    "pinTime": "",
    "operatorUsername": "",
    "operatorUserId": ""
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

• RANDOM
• EQUAL_STRING - Message is equal to
• EQUAL_VARIABLE

Related

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