Documentation
CMS Orbit
Pages, content and campaigns for every website and app, with reviews, translation and AI agents.
Using CMS Orbit
Edit pages, publish safely, run campaigns and keep SEO healthy.
Get started
Guides
- Edit a pageBlocks, fields, the live preview, autosave, undo and the page settings.
- Publish, schedule and take offlinePut a page live now or at a set time, take it offline, and go back to an earlier version.
- Compare and restore versionsSee how a page looked in any earlier version next to your draft, on the real website, check what changed, and bring a version back.
- Send a page for review, and approve oneAsk for sign-off on a page, follow its progress, and approve or ask for changes.
- Copy a page to another region or languageMake a linked copy, keep regional values such as prices, and pull later changes from the source.
- Upload, crop and describe imagesAdd files to the library, write alt text, crop for different sizes, and record consent for before-and-after photos.
- Add images to a pageChoose an image from the media library or drop a new one onto a field, crop it for its place, and make sure it has alt text.
- Build a menuAdd, nest and reorder menu items, link them to pages or addresses, and hide items for later.
- Fix missing addresses and broken linksFind the addresses visitors could not reach and the links inside the CMS that lead nowhere, and mend them with redirects or edits.
- Reuse a section on many pagesMake a block shared, add it to other pages, edit it in place, and copy and paste blocks between pages.
- Improve SEO healthRead the score, start with the quick wins, fix issues page by page, and keep metadata complete.
- Edit search titles and descriptionsCheck and change how every page looks in search results, write titles and descriptions in bulk with AI, and leave warnings that are right for a page.
- Hand a banner over when its countdown endsSet the banner that takes over the second another one ends, such as when a sale's countdown reaches zero.
- Publish an emergency bannerPut a notice on every page at once, without review or a release, when something urgent happens.
- Use approved claims and disclaimersPlace approved wording on pages from the region's library, so a change reaches every page at once.
- Keep product pages reviewedReview-by dates make sure someone checks a page's claims are still right, with reminders before the date.
- Put several changes live togetherGroup pages into a release and publish them at the same moment, now or on a schedule.
- Restore something deletedDeleting moves things to the bin, where they can be brought back. Erasing for good is for the Owner.
- When someone else is editingOnly one person edits a page at a time. See who is there, ask to take over, or hand it over.
- Give someone accessAdd people to a space, choose their role, and limit them to some regions.
- Let an AI assistant draft contentConnect an assistant such as Claude so it can draft, edit and check content for you, and tidy up its own drafts. Nothing it does goes live without a person.
- Read the reportsSee how much was changed and published, how fresh the content is, the SEO trend, AI writing and API use.
- Write with AIDraft, improve, shorten or simplify text in any text field with AI, and describe images for alt text and captions, in the page's language and your organisation's tone of voice. You decide what is used.
- See how pages and campaigns doVisitors, sources, scroll depth, goals and Google searches for each page, visitors and conversions in lists, and views and clicks for banners and popups, with variants side by side, from Insights Orbit.
- Set up writing with AIAdd your organisation's AI key, choose a model, set the writing guidelines, and decide where on the website editors can write with AI.
- Tag content with taxonomiesCreate shared lists of terms, such as brands or activities, and use them to tag and filter content.
- Create and import redirectsSend visitors from an old address to a new one, by hand or many at once from a spreadsheet, and export what you have.
- Create a spaceAdd a new website to your organisation, choose what it starts with, and get it ready for its first page.
- Change a space's settingsName a space, choose what the website does when a page is missing, set its time zone, and duplicate, export, import or remove it.
- Organisation settings, audit log and publishing historyChange the organisation's name and feature flags, see who changed what across every space, and see what has gone live on a website.
- Change site settingsEdit what the whole website shares, such as contact details, the footer text and the buttons in the header.
- Choose how a collection is editedOpen a collection's entries in the full editor with a live preview, like pages, or in a side panel beside the list, like FAQ entries.
Concepts
- Languages, regions and search engines (hreflang)How CMS Orbit tells search engines which pages are the same page in another language or region, what x-default is, and how to read and fix the Languages checks.
- How CMS Orbit is organisedOrganisations, spaces, environments, regions and languages, and why the scope in the top bar matters.
- How publishing worksDrafts and published versions, approval, schedules, and how quickly the website shows a change.
- Governance: keeping claims right and the brand consistentThe controls that keep safety and product content accurate and compliant, and how they fit together.
Reference
- Roles and permissionsWhat each built-in role can do, permission by permission. Built from the same definitions the CMS checks.
- Page statusesWhat Draft, Live, Live · edited, In review, Scheduled and the other labels mean.
- Keyboard shortcutsThe keys that save time in the CMS.
- GlossaryThe words the CMS uses, in one place.
For developers
Connect a website, read content and react to events.
Get started
- Connect a website to CMS OrbitEvery step from an empty Next.js app to a website that renders CMS pages, previews drafts in the editor and refreshes the moment editors publish, with every file in full.
- Connect a website without Next.jsUse the SDK from any JavaScript framework, or call the delivery API over plain HTTP from any language, with preview and refresh on publish.
Guides
- Render componentsDraw the components editors place on pages with your own React components: the registry, the props each component gets, nested blocks and slots, images, rich text, links, shared sections, client components and the click-to-select preview.
- Menus, site-wide content and listsRead menus, site-wide entries such as a header or footer, index pages with pagination, filters and search, entries without an address such as FAQs, and references between entries, with the SDK.
- Set up the live previewLet editors see drafts in your website inside the CMS editor, and click blocks to select them.
- Refresh the website when content changesCreate a webhook, receive and verify its signed messages with or without the SDK, and refresh only the pages, menus and sitemaps that changed.
- Caching and refreshing pagesEvery cache between the CMS and a visitor, the settings that control them, which cache tags each call and each webhook uses, how to test refreshes on your computer, and what to check when a page stays out of date.
- Render banners, popups and countdownsShow the live banner and popup for a page, preview both on your website as editors type, tick countdowns on the CMS clock, and swap to a follow-up banner on time.
- Regions and languagesBuild a website with several regions or languages: address patterns and the folders for each, reading the right region and language, fallbacks and notices, hreflang, language switchers, previews and cache refresh per region.
- Connect an AI agent over MCPAdd the CMS to Claude, Cursor, VS Code or any MCP client, sign in or use an agent key, test the connection and revoke it.
- Add a website addressTell CMS Orbit where each environment's website lives, verify it, and choose the primary address.
- Metadata, sitemaps and robots with the SDKGive every page its title, description, canonical link, share image, hreflang and structured data from the CMS, and serve sitemaps, a sitemap index and robots.txt for one region or many, including on staging.
- Test your websiteTest pages, components, redirects and webhooks without calling the CMS, using the SDK's mock client and fixtures, and catch schema changes in CI by generating types.
- Deploy your websiteRun a staging website for previews and a live website for visitors, with the right keys, settings and webhook for each, on Vercel, Netlify, Docker or a static host, and keep the website up if the CMS cannot be reached.
Concepts
- How your website and CMS Orbit work togetherThe parts involved when a website shows CMS content, what each one does, and what happens when a visitor opens a page, an editor previews and an editor publishes.
- Keys, permissions and sign-inThe keys and tokens websites, scripts and agents use, how permissions are decided, and how sign-in is protected.
Reference
- SDKsOfficial SDKs for JavaScript, PHP, Swift and Kotlin, and everything in the JavaScript SDK, from setup and types to pages, preview, cache refresh, campaigns, errors and tests.
- The Kotlin SDKRead CMS Orbit content in Android apps and on JVM servers, from Kotlin or Java: install, set up, every method, your own types, Jetpack Compose, preview and errors.
- The PHP SDKEverything in bifrost-orbit/cms-sdk for PHP websites, from setup and every client method to rendering components, preview, refresh on publish, SEO, errors, Laravel and Symfony.
- The Swift SDKRead CMS Orbit content in iOS, macOS and server-side Swift apps: install, set up, every method, your own types, SwiftUI, preview and errors.
- Delivery APIEvery endpoint websites read content from, with parameters, example answers, keys, fallback, caching, rate limits, limits, timeouts and errors.
- GraphQLRead pages, lists, menus, globals and campaigns in one request, with the schema, examples, errors and limits.
- Management APIThe API the CMS itself uses, for scripts and integrations that change content.
- Field typesEvery field a content type or component can have, its settings and rules, and how each one arrives in the delivery API and in generated types.
- MCP toolsEvery tool the MCP server offers agents, what each one takes and returns, what agents may not do, how they tidy up their own work, and what is recorded.
- Events and webhooksThe events the CMS sends when content changes, what each one carries, how it is delivered, and which reach webhooks.
- Troubleshooting your websiteEvery error message the SDK and API give a website, and every common symptom with pages, previews, cache refresh, types, SEO and regions, with the cause and the fix.