How to build your own TikTok LIVE widgets with the Livedeck API
What a widget is, how it runs in your overlay and how to get from the starter kit to a finished widget.
With the Livedeck API you build your own widgets for your overlay: goals, tickers, leaderboards, small games or animations. A widget is a small web page made of HTML, CSS and JavaScript. Livedeck sends it the events from your LIVE (gifts, chat, likes, follows and more), and the widget draws something into your overlay.
How a widget runs
- It runs right inside your normal overlay link (OBS, TikTok LIVE Studio). You don't need a second source.
- Every widget runs shielded in its own frame with its own address. It only sees the events it asks for in its manifest.json and cannot reach your account, your cookies or other widgets.
- Everything the widget needs is inside its package. It loads nothing from other sites: no fonts, images or scripts from the web and no trackers. The browser blocks such attempts during the LIVE as well.
- The widget gets profile and gift pictures through the SDK without loading anything from the web itself.
- If a widget hangs or uses too much CPU, Livedeck switches off only that widget. The rest of your overlay keeps running.
From the starter kit to a finished widget
- Download the starter kit and unzip it.
- Edit manifest.json, index.html, style.css and app.js. "Your first widget" shows every step.
- Zip the files again.
- Upload the ZIP in the editor under My widgets › "Upload your own". You need two-factor protection for this (authenticator app or passkey), and you must have signed in with it.
- Livedeck checks the package and tests the widget automatically. You can try it in the editor preview right away. In the OBS link it runs once an admin has approved it.
Build it with your AI
Don't code yourself? Describe your idea in a sentence and let Claude, ChatGPT, Cursor or another AI build the widget. The AI reads a guide with all of Livedeck's rules and limits and gives you a ZIP that you upload as described above. Check the result in the editor preview before you use it.
Build a widget with your AI
Describe in one sentence what your widget should do, then paste the text into Claude, ChatGPT, Cursor or any other AI. It reads our rules and builds a finished ZIP for you to upload.
Read the instructions at https://help.livedeck.de/widgets/agent.md and use them to build me a Livedeck widget. Follow the rules there exactly.
Want to offer your widget to other creators? Sell it on the Livedeck Marketplace. "Review, selling and updates" explains how.
All developer pages
Was this article helpful?