Embed the widget

Dashboard API reference API explorer

Two lines on any page

The widget is one self-contained script — no framework, no build step, no external dependencies. It reads the API address from its own src, so the same snippet works in every environment. Fill in the options below and the snippet updates as you type.

Your publishable key from the dashboard's API keys tab.

    

The publishable key is safe in a browser: it can only list your published events and submit registrations. Never put a secret key (sk_…) in a web page.

Options

Every attribute is optional except data-key. Defaults are left out of the snippet, so what you copy is only what you actually changed.

CSS selector. Omit and the widget renders where the script tag sits.
Starting layout. Visitors may switch unless you lock it.
Never shown for full, whatever you set here.
Put the switcher icons in your own element instead of above the list.
Show N first, with a “Load more” button. Unset shows everything.
Appears by itself once your events span 2+ categories.
BCP-47, e.g. zh-Hant. Leave empty so each visitor sees their own.
Point Share buttons at a dedicated events page.

Live preview

Renders the snippet above in an isolated frame, against your real published events. It always starts fresh, so you see the layout your attributes ask for — a returning visitor may instead see the list/grid choice their browser remembers.

Enter your publishable key, then run the preview.

All parameters

Everything the script tag accepts.

AttributeRequiredValues / defaultWhat it does
data-keyyes pk_… Your publishable API key. Identifies your company; only published events are shown.
data-targetno CSS selector Element the list renders into. If omitted — or the selector matches nothing — the widget renders itself directly before its own <script> tag.
data-layoutno list (default) · grid · full Initial display layout. Anything unrecognised falls back to list.
data-switcherno off Hides the list/grid switcher icons and locks the layout. The switcher is never shown for data-layout="full".
data-toolbar-targetno CSS selector Renders the switcher icons into your own element — a slot in a section heading, say — instead of above the list.
data-page-sizeno positive integer Shows the first N events with a “Load more (X more)” button. Unset shows all. Works in every layout, and the revealed count survives auto-refreshes.
data-category-filterno off A category dropdown appears automatically once your published events span 2+ categories. Set off to hide it.
data-langno BCP-47 locale Language for content and chrome. Event text is served in that language where you have a translation, falling back to the event's base language. Built-in UI text covers en, zh-Hant, zh-Hans, ja; others get English chrome. Unset follows the visitor's browser, which is what most sites want.
data-permalink-baseno URL Base for the Share button's links. Defaults to the page the widget is on — set it if you embed in several places and want one canonical events page.

Share links append ?evw=<eventId>. A visitor arriving with it gets filters and paging cleared, the event scrolled to, and its detail opened. Set your Company URL in Profile and links switch to /s/<eventId>, which serves per-event OpenGraph tags so chats unfurl a real preview card.

Layouts

list default

Compact rows: thumbnail, title, date, location, two-line description, spots-left badge. Clicking a row expands it in place with the banner, full description, and the registration form.

grid

Responsive card grid, roughly 230px columns. Clicking a card opens a full-height drawer from the right with the banner, description, location, and form. Closes on ✕, backdrop, or Escape.

full

Large cards with everything visible at once: 3:1 banner, full description, registration button inline. Best for one or two flagship events.

Unless disabled, a visitor's list/grid choice is remembered in their browser and overrides data-layout on return visits.

Styling, the registration form, and troubleshooting are covered in docs/EMBED.md.