previewPackageWidgetFrame

GET

/api/v1/packages/{packageId}/widgets/{widgetId}/frame

const url = 'https://example.com/api/v1/packages/example/widgets/example/frame';
const options = {method: 'GET', headers: {cookie: 'tilecast_session=<tilecast_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/packages/example/widgets/example/frame \
  --cookie tilecast_session=<tilecast_session>

Sandboxed frame document for one installed Widget contribution: the generated bootstrap with the verified bundle interpolated. Studio loads it in an opaque-origin allow-scripts iframe to preview external Widgets. The response carries a sandbox Content-Security-Policy, so the document cannot access credentials even when opened top-level. Readable by any signed-in account. Unknown packages and missing bundles share one package_widget_unavailable 404.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

packageId

required

string

/^[a-z][a-z0-9_.:-]{0,127}$/

Store package identifier such as countdown_bar.

widgetId

required

string

<= 80 characters

Responses

200

Sandboxed Widget frame document

text/html

string

401

Dashboard authentication required

404

Package_widget_unavailable