Skip to content

Work in the admin

Use the admin to create catalogue definitions, reuse existing semantics, publish revisions, and diagnose delivery. The admin and API call the same validation and publication code.

Section Use it to
Catalog Search published services and run bounded queries.
Saved context Open account-wide and personal preferred service, time-series, and event navigation.
Provision Edit service, time-series, event, lookup, group, and contract definitions.
Semantics Find or create entities, units, metrics, dimensions, and event types.
Sources Inspect adapters, create bindings, and submit source definitions for review.
Operations Import or export definitions, inspect publications and revisions, and review audit events.
Help Open these guides or the authenticated API explorer.

The Catalog directories show what consumers can use. The Provision lists show editable drafts and lifecycle state. Use the directory when you want data; use Provision when you want to change a definition.

Saved context keeps routine navigation out of both workflows. Time-series entries show families and their current best authorized variants. Event entries ask for a runtime UTC period and optional location, then show matching occurrences across every selected feed. Create and manage the typed definitions through the authenticated API console.

Confirm the active account

Customer editors and publishers can change records only for their active WorkOS organization. An unexpected read-only form usually means the wrong organization is active or the account lacks the required role. Sign in again with the intended organization before editing. Account routing is assigned by the session and is not editable.

Find before creating

Search Semantics and Sources before adding a record. Reuse:

  • an entity when it represents the same organization, source, publication, or subject;
  • a unit when the code and quantity match;
  • a metric when measurement meaning, unit, and aggregation match;
  • a dimension when key, value type, and meaning match;
  • a binding when source mode, inputs, and limits match;
  • a contract when the accepted inputs and returned fields match exactly.

See Catalogue definitions for the identity and reuse rules.

Edit a definition

  1. Complete the overview fields and save the draft.
  2. Add metrics, dimensions, or event fields in their tabs.
  3. Read Ready to publish? at the top of the saved form.
  4. Open the tab named by each blocker, correct the field, and save again.
  5. Use Preview or Query where available. Previews are read-only and capped at 100 rows.
  6. Select Publish only after the readiness list is clear.

Autocomplete fields search records visible to the active account. Their labels include enough context to distinguish similar definitions; technical IDs remain available in the detail view.

Avoid overwriting another edit

Every editable definition carries a draft version. A save made from an older version is rejected. Review the current draft, reapply the intended change, and save again. Do not work around the conflict by copying stale form data over the new version.

Published revisions and audit events are append-only. Editing a published definition creates a changed draft while consumers continue to use the last delivered revision.

Common tasks

Catalogue definitions are archived, not deleted. Archive keeps the identity, revisions, and audit trail. Active references can prevent a supporting definition from being archived.