Changelog

The changelog is the global feed of every live announcement across every collection in your project. Unlike announcement.openCollection, it shows filter pills so users can scope to a single collection.

Open the changelog

Chirp.changelog.open(opts?: AnnouncementOpenOpts): void

Field	Type	Notes
`opts.layout`	`'modal' \| 'drawer'`	Default `'drawer'` (right-side panel).
`opts.layoutSettings`	`{ styles?: ... }`	Per-open theme override — `background`, `text`, `textMuted`, `primary`, `border`, `fontFamily`. See Theming below.

Minimum usage

Chirp.changelog.open();

Chirp.changelog.open({ layout: "modal" });

Dark theme to match your app

Chirp.changelog.open({
  layout: "drawer",
  layoutSettings: {
    styles: {
      background: "#0a0f2e",
      text: "#ffffff",
      textMuted: "rgba(255,255,255,0.55)",
      primary: "#6366f1",
      border: "rgba(255,255,255,0.1)",
    },
  },
});

The defaults come from your project's theme. Override here only when you need something different per-open — e.g. matching the host page's dark / light mode at runtime.

Close the changelog

Chirp.changelog.close(): void

Chirp.changelog.close();

Common pattern: a "What's new" button

<button onClick={() => Chirp.changelog.open()}>
  What's new
</button>

You can also link directly to the public changelog page (no SDK needed) — the URL is on Project Settings → Brand → Your Public Portal.

Notes

Only live announcements appear in the feed. Drafts, scheduled, paused, and archived posts are hidden.
Per-announcement frequency rules still apply — an announcement marked "show once per user" will not re-appear here after dismiss.
Users can filter by collection using the pills at the top of the feed.

Next steps

Announcements — show one announcement or a single-collection feed
Events — changelog:shown, changelog:dismissed

On this page