custom-pages-and-apis

Installation
SKILL.md

EventCatalog Custom Pages & APIs

Build user-defined pages and API routes that are served by EventCatalog itself — with full access to catalog data (domains, services, events, teams, ...) through a stable, documented toolkit.

Custom pages live in a pages/ folder at the root of the catalog and are served under a configurable URL prefix (default /custom). API routes live in pages/api/ and require SSR mode.

Requirements (check these FIRST)

Before writing any files, verify both.

  1. Core version — custom pages are served for every catalog from @eventcatalog/core 5.0.0 (no plan or license key needed). Versions 4.1.0–4.x only served them with a Scale license key, and the Layout's fullWidth prop needs 4.12 or later. Check the catalog's package.json, and suggest upgrading if it's on 4.x.
  2. SSR for API routes only — .astro pages work in any output mode, but anything under pages/api/ requires output: "server" in eventcatalog.config.js. A production build fails with a hard error if API routes exist in static mode (dev only warns). See references/api-routes.md.

Instructions

Step 1: Locate the catalog

Find the user's EventCatalog project (look for eventcatalog.config.js). Then check:

Installs
492
GitHub Stars
16
First Seen
Jul 9, 2026