Webiny Docs
Welcome to the Webiny documentation — your reference manual for building, extending, and operating Webiny.
Whether you’re integrating Webiny into an existing product, tailoring it into an enterprise content platform, or embedding it as a white-label builder, this portal is where you’ll find the exact methods, functions, and patterns you need.
What Is Webiny?
Webiny is an open-source, self-hosted content platform that combines ready-made apps (like Headless CMS, Website Builder, File Manager/DAM, Publishing Workflows, and Tenant Manager) with a TypeScript framework and APIs you can extend. You get SaaS-like reliability on a serverless foundation — but deployed into your cloud, under your governance.
Webiny is built for teams that want flexibility without lock-in: define models and business rules as code, hook into lifecycle events, automate workflows, and integrate with any frontend or internal systems.
How to Use the Docs
The docs are organized into three sections:
Getting Started Install Webiny, run it locally, deploy to your cloud, and learn the core building blocks.
Guides Step-by-step tutorials for real projects: extending apps, adding custom logic, integrating SSO, automating publishing, building multi-tenant setups, embedding the page builder, and more.
API Reference The detailed technical reference: functions, methods, types, GraphQL operations, lifecycle events, background tasks, and extension points.
Use the sidebar to navigate, or search (Ctrl+K / Cmd+K) to jump straight to what you need.
Webiny Apps and “Framework Mode”
Webiny has two complementary ways to work:
Apps (ready-made products) Use Webiny’s built-in applications like Headless CMS, Website Builder, File Manager, Publishing Workflows, and Tenant Manager. They come with UI, permissions, editorial tooling, and the defaults most teams need.
Framework mode (build your own) Treat Webiny as your programmable foundation: add modules, extend APIs, create custom screens, enforce business rules, and shape workflows around your organization — all in a way that stays maintainable and upgrade-safe.
Prerequisite Knowledge
This documentation assumes you’re comfortable with:
- JavaScript / TypeScript
- Modern web development fundamentals
- GraphQL basics
- Node.js tooling
If you’re new to GraphQL or TypeScript, start with the Getting Started section and follow the examples as you go.
Where to Start
The best place to start learning Webiny is to go through the Learn Webiny Course. It’s a free, self-paced course that takes you through the basics of installing Webiny, running it locally, and deploying it to the cloud. You can find the course at learn.webiny.com/
. Join the Webiny Community
If you get stuck, want feedback on an architecture, or need help with an extension, the community and the team are close by. You can also reach out if you want a technical deep-dive for your specific project. Join Webiny Community.