Skip to main content

Widget

Embeddable widget

A small public card for your own footer — and the gate that keeps it honest.

One widget per site: a card you embed on your own pages, showing live figures to anybody who loads them.

Off until you turn it on

enabled defaults to false, which is the opposite of the shared board.

The difference is what creating means. A board is created by publishing — the act and the row are the same thing. A widget's row is created to hold settings, and putting it on a public page is a separate decision.

So PUT with no enabled stores settings and publishes nothing.

It cannot go public before the first event

Switching a widget on needs at least one recorded event on the site.

The reason is identity, not data. Domain ownership is not verified, so without this gate somebody could add a competitor's domain and publish an empty badge under their brand — on a card that looks official because it carries live figures.

The check is on the act of enabling, not on creation. Creating or editing a disabled widget is always fine, because nothing is public until it is switched on. Trying to enable one on a site with no events answers 409 no_events_yet whether or not the widget already exists.

Publishing revenue is its own switch

publish_revenue is separate from the widget type, and false unless you ask for it.

Choosing the revenue card is a display choice. Putting takings on a page anybody can load is a disclosure. Riding both on one value would mean picking a card and publishing your numbers in the same click.

The address is random

w_ followed by sixteen characters, unlike a board whose address is your domain.

A widget is embedded rather than sent as a link, so a readable address buys nothing — and one that cannot be guessed from the domain is worth having on a card that sits on a public page.

Removing versus switching off

What survives
{"enabled": false}The address and settings. The embed goes blank; turning it on restores it.
DELETENothing. Creating a widget again mints a new address, so an embed already on a page stops rendering.

The same distinction the shared board draws between closing and revoking.

Was this page helpful?

Last updated September 16, 2026