iframe query params
last updated: September 1, 2026
if you're rendering a widget on the server (php, etc), you can also read instance data from query parameters. WidgetStar sends 2 params:
settings
JSON object with all instance settings.
const settings = JSON.parse(new URLSearchParams(location.search).get('settings'));
// settings.title, settings.color, ...
on the server that's req.query.settings (express) or $_GET['settings'] (php).
ws
JSON object with info about the instance.
{
instanceId: 123,
widgetId: 45,
domain: "example.com",
name: "my countdown",
origin: "https://widget.st",
embedMode: "iframe"
}
instanceId- instance id (number)widgetId- widget id (number)domain- hostname the widget is embedded onname- instance nameorigin- WidgetStar originembedMode-"iframe"or"script"
const ws = JSON.parse(new URLSearchParams(location.search).get('ws'));