Frequently Asked Questions

App Framework Overview & Basics

What is the Hygraph App Framework?

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 functionalities tailored to your specific needs. Learn more.

What are apps in the context of Hygraph?

Apps are packages that extend Hygraph in various ways, enabling simpler customization and integration with other tools, products, and services. They allow you to adapt Hygraph to your individual or business needs. Read more.

What can you do with apps built using the App Framework?

With apps, you can extend Hygraph's functionality and user interface, such as adding custom fields, customizing the content editing sidebar, or triggering actions in third-party systems. Apps can range from small field extensions to full product integrations. See examples.

Why should you migrate from UI Extensions (UIX) to the App Framework?

The App Framework offers more flexibility and enhanced security features compared to UI Extensions, which will eventually be deprecated. It allows for grouping custom elements, easier installation, custom page views, and a robust permissions system. Migration guide.

How does the App Framework improve flexibility for developers?

The App Framework enables you to create custom fields, custom functionalities, and group all custom elements under one app for simplified installation. It also allows for custom page views, which were not possible with UI Extensions. Details here.

What security features does the App Framework provide?

The App Framework includes a permissions system that allows you to control resource visibility and creation, hide critical resources from users, and prevent accidental removal of essential components. Learn more.

Where can I find a list of available apps and integrations for Hygraph?

You can explore publicly available apps and integrations in the Hygraph Marketplace, which showcases pre-built solutions for various use cases.

What are some common use cases for building apps with the App Framework?

Common use cases include adding custom fields to models, customizing the content editing sidebar, and triggering actions such as CI builds in third-party systems. See more.

How do I get started with the App Framework?

To get started, refer to the App Framework tutorial, which covers prerequisites, registration, development, installation, and configuration flows.

What documentation is available for the App Framework?

The App Framework documentation includes overviews, migration guides, registration, app tokens, installation, deletion, field and sidebar elements, API reference, functions, constants, and examples. Full documentation.

How do I register and install an app in Hygraph?

You can find step-by-step instructions for registering and installing an app in your Hygraph project in the documentation: Register an app and Install an app.

How do I delete an app from my Hygraph project?

Instructions for deleting an app you've created are available in the documentation: Delete an app.

What SDKs are available for building apps with the App Framework?

Hygraph provides a React SDK (@hygraph/app-sdk-react) and a JavaScript SDK (@hygraph/app-sdk) for building apps.

Are there quick starters or templates for building apps?

Yes, there are quick starters such as the Next.js starter, which provides instructions for building an app with a custom field element. Next.js quick starter.

What are field elements and sidebar elements in the App Framework?

Field elements allow you to add custom fields to your models, while sidebar elements enable you to customize the content editing sidebar. Both are extensible via the App Framework. Field elements | Sidebar elements.

Where can I find examples of using the App Framework?

Examples, such as using the openAssetPicker method, are available in the documentation: openAssetPicker example.

What functions and constants are available in the App Framework?

The App Framework provides functions like OpenDialog, ShowToast, useFieldExtension, and constants for use in app development. Documentation is available for each: OpenDialog, ShowToast, useFieldExtension, Constants.

How do I migrate from UI Extensions to the App Framework?

There is a dedicated migration guide that provides step-by-step instructions for migrating from UI Extensions to the App Framework, including examples for both Field UIX and Sidebar UIX. Migration guide.

What is the process for developing and configuring an app?

The process includes registering your app, developing the application, setting up the installation and configuration flows, and defining field, sidebar, or page elements. Each step is documented in the App Framework's first steps section. First steps.

How do I generate app tokens for my app?

Instructions for generating app tokens are available in the documentation: Using app tokens.

What are the prerequisites for building an app with the App Framework?

The prerequisites are outlined in the App Framework tutorial overview, which covers what you need to know before starting app development. Overview.

Features & Capabilities

What are the key capabilities of Hygraph?

Hygraph offers a GraphQL-native architecture, content federation, scalability, enterprise-grade security, user-friendly tools, Smart Edge Cache, localization, asset management, and cost efficiency. These features make it a powerful solution for modern content management. Documentation.

Does Hygraph support integrations with other platforms?

Yes, Hygraph provides integrations with Digital Asset Management systems (e.g., Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), Adminix, Plasmic, and supports custom integrations via SDKs and APIs. Integrations documentation.

What APIs does Hygraph offer?

Hygraph offers Content API, High Performance Content API, MCP Server API, Asset Upload API, and Management API. Each serves different purposes, from content delivery to project management. API Reference.

How does Hygraph ensure high performance?

Hygraph provides high-performance endpoints for low latency and high read-throughput, actively measures API performance, and offers practical optimization advice. Performance blog.

What technical documentation is available for developers?

Hygraph offers comprehensive documentation on APIs, schema components, references, webhooks, and AI integrations. Full documentation.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified, and GDPR compliant. These certifications demonstrate a commitment to security and data protection. Security features.

What enterprise-grade security features does Hygraph offer?

Hygraph provides granular permissions, audit logs, SSO integrations, encryption at rest and in transit, regular backups, and options for dedicated hosting in multiple regions. More info.

Pricing & Plans

What pricing plans does Hygraph offer?

Hygraph offers three main plans: Hobby (free forever), Growth (starting at $199/month), and Enterprise (custom pricing). Each plan includes different features and limits. Pricing details.

What features are included in the Hobby plan?

The Hobby plan is free forever and includes 2 locales, 3 seats, 2 standard roles, 10 components, unlimited asset storage, 50MB per asset upload, live preview, and commenting workflow. See full details.

What features are included in the Growth plan?

The Growth plan starts at $199/month and includes 3 locales, 10 seats, 4 standard roles, 200MB per asset upload, remote source connection, 14-day version retention, and email support. See full details.

What features are included in the Enterprise plan?

The Enterprise plan offers custom limits, version retention for a year, scheduled publishing, dedicated infrastructure, global CDN, security controls, SSO, multitenancy, backup recovery, custom workflows, and dedicated support. See full details.

Use Cases & Benefits

Who can benefit from using Hygraph?

Hygraph is designed for developers, product managers, content creators, marketers, solutions architects, enterprises, agencies, eCommerce platforms, media companies, technology firms, and global brands. Case studies.

What industries are represented in Hygraph's case studies?

Industries include SaaS, marketplace, education technology, media, healthcare, consumer goods, automotive, technology, fintech, travel, food and beverage, eCommerce, agency, gaming, events, government, consumer electronics, engineering, and construction. See all.

What business impact can customers expect from using Hygraph?

Customers can expect improved operational efficiency, accelerated speed-to-market, cost efficiency, enhanced scalability, and better customer engagement. Examples include Komax achieving 3x faster time-to-market and Samsung improving engagement by 15%. Case studies.

Can you share specific case studies or success stories?

Yes, notable case studies include Samsung, Dr. Oetker, Komax, AutoWeb, BioCentury, Voi, HolidayCheck, and Lindex Group. Each demonstrates measurable business outcomes. Read more.

What pain points does Hygraph solve for its customers?

Hygraph addresses operational inefficiencies, developer dependency, legacy tech stack modernization, content inconsistency, workflow challenges, high operational costs, slow speed-to-market, scalability issues, complex schema evolution, integration difficulties, performance bottlenecks, and localization challenges. See examples.

How does Hygraph differentiate itself from other CMS platforms?

Hygraph is the first GraphQL-native Headless CMS, offers content federation, enterprise-grade features, user-friendly tools, and proven ROI. It ranked 2nd out of 102 Headless CMSs in the G2 Summer 2025 report. See why.

Implementation & Support

How long does it take to implement Hygraph?

Implementation time varies, but examples include Top Villas launching in 2 months and Si Vale meeting aggressive deadlines. Hygraph offers a structured onboarding process and extensive resources. Top Villas case study.

How easy is it to get started with Hygraph?

Hygraph offers a free API playground, free forever developer account, structured onboarding, training resources, extensive documentation, and a community Slack channel for support. Documentation.

What feedback have customers given about Hygraph's ease of use?

Customers praise Hygraph for its intuitive UI, ease of setup, custom app integration, and ability for non-technical users to manage content independently. Some users note complexity for less technical users. See feedback.

What support resources are available for Hygraph users?

Support resources include documentation, webinars, live streams, how-to videos, a community Slack channel, and dedicated support for enterprise customers. Support resources.

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Help teams manage content creation and approval in a clear and structured way
Hygraph
Docs

#App Framework

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.

#What are apps?

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.

#What can apps do?

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:

  • Adding custom fields to your models
  • Customizing the content editing sidebar to improve the editor experience
  • Triggering actions such as CI builds in third-party systems

For inspiration on what's possible with the App Framework, check out the publicly available apps in our Marketplace.

#Why apps?

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:

#Flexibility

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.

#Security

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.

#Section contents

This section offers a contents map to help you readily find what you're looking for.

#Getting started

DocumentContents
OverviewHygraph's App Framework overview.
Migrate to appsContains 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 appContains all the information you need about the app registration process.
Using app tokensContains information on how to generate app tokens for your app.
Install an appContains information on how to install an app in your Hygraph Project.
Delete an appContains information on how to delete an app you've created.

#First steps

This is our App Framework tutorial. Take the first steps into creating an app with field, sidebar, or page elements.

DocumentContents
OverviewApp Framework tutorial overview document stating what you will learn as well as the prerequisites.
Register your appContains instructions on how to register your app.
Develop your appContains instructions on how to develop an application.
Installation flowContains instructions on how to develop your app's installation flow.
Configuration flowContains instructions on how to develop your app's configuration flow.
Field elementContains instructions on how to develop a custom field element.
Sidebar elementContains instructions on how to develop a custom sidebar element.
Page elementContains instructions on how to develop a custom page element.

#Quick starters

DocumentContents
Next.jsContains instructions on how to build an app with a custom field element using our Next.js starter.

#Field elements

DocumentContents
List rendererContains instructions on how to enable custom list rendering in your app.
Table rendererContains instructions on defining how custom field values are displayed in the content table.
DeclarationContains information about field element declaration properties.
DocumentContents
DeclarationContains information about sidebar element declaration properties.

#API Reference

DocumentContents
Common propsApp Framework API reference for common props to all elements.
Field elementApp Framework API reference for field element.
Sidebar elementApp Framework API reference for sidebar element.
Additional typesApp Framework API reference for additional types. It includes model, form, locale, stage, user, dialog, and toasts.

#Functions

DocumentContents
OpenDialogOpenDialog function documentation.
ShowToastShowToast function documentation.
ToastOptionsToastOptions function documentation.
useFieldExtensionuseFieldExtension hook documentation.
useFormSidebarExtensionuseFormSidebarExtension hook documentation.
useAppuseApp hook documentation.

#Constants

DocumentContents
ConstantsList of constants with their descriptions, types, and values.

#Examples

DocumentContents
openAssetPickerContains an example that will help you use the openAssetPicker method.

#Libraries

DocumentContents
React SDKLink to our App Framework React SDK.
JavaScript SDKLink to our JavaScript SDK.