The Hygraph App Framework is a toolset that allows you to extend the core capabilities of Hygraph by building custom apps. These apps can integrate Hygraph with third-party services or add custom functionality tailored to your specific needs. You can also share your apps with other users via the Hygraph Marketplace. Learn more.
Apps are packages that extend Hygraph in various ways, enabling simpler customization and integration of your project with other tools, products, and services. Apps help you adapt Hygraph to your individual or business needs. Read more.
You can start by following the App Framework tutorial, which guides you through creating an app with field, sidebar, or page elements. The tutorial covers registering your app, developing your application, installation and configuration flows, and building custom elements. Start the tutorial.
Apps can extend Hygraph's out-of-the-box functionality and user interface in multiple ways. Common use cases include adding custom fields to models, customizing the content editing sidebar, triggering actions in third-party systems (such as CI builds), and creating custom page views. For inspiration, explore publicly available apps in the Hygraph Marketplace.
The App Framework allows you to group all your custom elements under one app and install them at once, simplifying the installation process. It also enables the creation of custom page views and custom functionality, which was not possible with UI Extensions. Learn about migrating from UI Extensions.
The App Framework includes a permissions system that allows you to control resource visibility and creation. You can specify which resources should be hidden from users and which are critical and cannot be removed once the app is uninstalled. This provides better control and security compared to previous UI Extensions. Read more.
Hygraph provides extensive documentation, including step-by-step tutorials for registering, developing, installing, and deleting apps. There are also guides for building field, sidebar, and page elements, API references, function documentation, constants, and example implementations. Explore the full documentation at Hygraph App Framework Docs.
Hygraph offers both a React SDK (@hygraph/app-sdk-react) and a JavaScript SDK (@hygraph/app-sdk) to help developers build apps efficiently.
Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications demonstrate Hygraph's commitment to providing a secure and compliant platform. Learn more.
Hygraph uses granular permissions, SSO integrations, audit logs, encryption (at rest and in transit), and regular backups to protect customer data. Enterprise-grade compliance features include dedicated hosting, custom SLAs, and support for GDPR and CCPA regulations. For transparency, Hygraph provides a process for reporting security issues and offers a security and compliance report.
The App Framework is ideal for developers, product managers, and marketing teams in industries such as ecommerce, automotive, technology, food and beverage, and manufacturing. It is especially useful for organizations looking to modernize legacy tech stacks, streamline content operations, and deliver exceptional digital experiences at scale. See examples in the Marketplace.
The App Framework addresses operational inefficiencies (such as developer dependency for content updates), financial challenges (high operational costs, slow speed-to-market), and technical issues (complex schema evolution, integration difficulties, cache and performance bottlenecks). It enables businesses to modernize their content management systems and deliver scalable, efficient digital experiences. See related KPIs.
Yes. Komax achieved a 3X faster time-to-market by managing over 20,000 product variations across 40+ markets via a single CMS. Autoweb saw a 20% increase in website monetization. Samsung improved customer engagement by 15% with a scalable member platform. Dr. Oetker enhanced their digital experience using MACH architecture. Explore more customer stories.
Hygraph provides a free API Playground and a free forever developer account, allowing teams to start immediately. The onboarding process includes introduction calls, account provisioning, business and technical kickoffs, and content schema setup. Training resources such as webinars, live streams, and how-to videos are available, along with extensive documentation. Get started here.
Developers have access to 24/7 support via chat, email, and phone, real-time troubleshooting through Intercom chat, a community Slack channel (join here), extensive documentation, webinars, live streams, and how-to videos. Enterprise customers receive a dedicated Customer Success Manager for personalized guidance. See documentation.
Hygraph is a cloud-based platform, so all deployment, updates, security measures, and infrastructure maintenance are managed by Hygraph. Upgrades and new features are seamlessly integrated. Troubleshooting support is available 24/7, with additional resources such as documentation and an API Playground for self-service. Enterprise customers receive dedicated support. Learn more.
Hygraph offers Smart Edge Cache for enhanced performance and faster content delivery, high-performance endpoints, and practical advice for optimizing GraphQL API usage. These features are designed for reliability and speed, especially for businesses with high traffic and global audiences. Read more.
Customers frequently praise Hygraph's editor UI for being intuitive and clear, making it easy for both technical and non-technical users. Hygraph was recognized for "Best Usability" in Summer 2023. Users appreciate the ability to integrate custom apps for content quality checks and instant feedback. Try Hygraph.
Key metrics include time saved on content updates, number of updates made without developer intervention, system uptime, speed of deployment, consistency in content across regions, user satisfaction scores, reduction in operational costs, ROI on CMS investment, time to market for new products, maintenance costs, scalability metrics, and performance during peak usage. See more on CMS KPIs.
This document helps you understand what the Hygraph App Framework is and what you can do with it. With the App Framework, you can extend the core capabilities that Hygraph offers. It gives you the possibility to create your own custom apps, and (optionally) share them with other users.
The App Framework is a toolset that allows you to build apps easily. You can use it to build apps that integrate Hygraph with third-party services, or build custom integrations tailored to your specific needs.
Look into our App Framework tutorial.
Apps are packages that extend Hygraph in various ways. Apps allow for simpler customization and integration of your project with other tools, products and services. With apps, you can adapt Hygraph to your individual or business needs.
With apps, you can extend the out-of-the-box Hygraph functionality and User Interface in various ways. From small custom field extensions to full fledged product integrations, with the App Framework & your custom apps it becomes super easy to extend Hygraph to meet your needs.
Some common use cases are:
For inspiration on what's possible with the App Framework, check out the publicly available apps in our Marketplace.
Apps offer an improvement over the UI Extensions feature, which will eventually be deprecated. We encourage all users to migrate from UIX to apps.
Why migrate from UIX to the App Framework?
The App Framework offers more flexibility and greater security features:
Creating your own app to be used in the Hygraph platform allows you to have custom fields on your setup, as well as custom functionality on your CMS. You can even group up all your custom elements under one app and install them at once, which greatly simplifies the installation process compared to UI Extensions.
It also makes it possible for you to create custom page views, which was not possible before.
Certain resources are critical for an app to work, and should therefore be hidden from users to prevent accidental removal. Our App Framework offers a permissions system, which allows better control over resources visibility as well as over creating resources on behalf of the user.
With this new permissions system you can create the app establishing which resources should be hidden from users, and also which resources are critical and can't be removed once the app is uninstalled.
This section offers a contents map to help you readily find what you're looking for.
| Document | Contents |
|---|---|
| Overview | Hygraph's App Framework overview. |
| Migrate to apps | Contains information on how to migrate from UI Extension to app. Includes a step-by-step example for both Field UIX and Sidebar UIX. |
| Register an app | Contains all the information you need about the app registration process. |
| Using app tokens | Contains information on how to generate app tokens for your app. |
| Install an app | Contains information on how to install an app in your Hygraph Project. |
| Delete an app | Contains information on how to delete an app you've created. |
This is our App Framework tutorial. Take the first steps into creating an app with field, sidebar, or page elements.
| Document | Contents |
|---|---|
| Overview | App Framework tutorial overview document stating what you will learn as well as the prerequisites. |
| Register your app | Contains instructions on how to register your app. |
| Develop your app | Contains instructions on how to develop an application. |
| Installation flow | Contains instructions on how to develop your app's installation flow. |
| Configuration flow | Contains instructions on how to develop your app's configuration flow. |
| Field element | Contains instructions on how to develop a custom field element. |
| Sidebar element | Contains instructions on how to develop a custom sidebar element. |
| Page element | Contains instructions on how to develop a custom page element. |
| Document | Contents |
|---|---|
| Next.js | Contains instructions on how to build an app with a custom field element using our Next.js starter. |
| Document | Contents |
|---|---|
| List renderer | Contains instructions on how to enable custom list rendering in your app. |
| Table renderer | Contains instructions on defining how custom field values are displayed in the content table. |
| Declaration | Contains information about field element declaration properties. |
| Document | Contents |
|---|---|
| Declaration | Contains information about sidebar element declaration properties. |
| Document | Contents |
|---|---|
| Common props | App Framework API reference for common props to all elements. |
| Field element | App Framework API reference for field element. |
| Sidebar element | App Framework API reference for sidebar element. |
| Additional types | App Framework API reference for additional types. It includes model, form, locale, stage, user, dialog, and toasts. |
| Document | Contents |
|---|---|
| OpenDialog | OpenDialog function documentation. |
| ShowToast | ShowToast function documentation. |
| ToastOptions | ToastOptions function documentation. |
| useFieldExtension | useFieldExtension hook documentation. |
| useFormSidebarExtension | useFormSidebarExtension hook documentation. |
| useApp | useApp hook documentation. |
| Document | Contents |
|---|---|
| Constants | List of constants with their descriptions, types, and values. |
| Document | Contents |
|---|---|
| openAssetPicker | Contains an example that will help you use the openAssetPicker method. |
| Document | Contents |
|---|---|
| React SDK | Link to our App Framework React SDK. |
| JavaScript SDK | Link to our JavaScript SDK. |