Frequently Asked Questions
App Framework & useApp Hook
What is the useApp hook in Hygraph's App Framework?
The useApp hook is a function provided by Hygraph's App Framework for use within page elements. It returns properties and methods that allow you to interact with the app installation, context, navigation, asset picker, dialogs, and more. It is essential for building custom app elements that need to access installation details, project context, and Hygraph UI features. Source
What properties does the useApp hook provide?
The useApp hook provides several properties:
- installation: An object containing the installation id, status, and config.
- context: Contextual information about the project and environment, including
authToken, endpoint, id, and name. - historyPush: Function to redirect within Hygraph.
- historyReplace: Function to replace the current entry in the history stack.
- openAssetPicker: Function to open the Hygraph asset picker.
- openDialog: Function to open a dialog for custom UI or external data.
- redirectParent: Function for full external redirects.
- showToast: Function to display native Hygraph toast notifications.
- updateInstallation: Function to get and update the app installation status (available only in the setup page).
Source
How do I use the openAssetPicker method from useApp?
The openAssetPicker method allows you to open the Hygraph asset picker from your app element. This is useful for selecting or uploading assets directly within your custom UI. For an example, see the openAssetPicker example in the documentation.
What is the purpose of the openDialog method in useApp?
The openDialog method opens a separate dialog window where you can load data from an external source or create your own custom UI. This is useful for integrating external workflows or building advanced app features. Learn more in the openDialog documentation.
How can I perform navigation within Hygraph using useApp?
You can use the historyPush and historyReplace methods to navigate within the Hygraph interface. historyPush redirects to a new path, while historyReplace replaces the current entry in the navigation history. Both are intended for internal navigation only. Source
What is the updateInstallation method and when should I use it?
The updateInstallation method allows you to get and update the current app installation status. This method is only available inside the setup page and is useful for managing installation lifecycle events. The status is a key of AppInstallationStatus. Source
How do I perform a full redirect outside of Hygraph using useApp?
You can use the redirectParent method to perform a full redirect to an external URL (hostname + path). This is useful when you need to send users outside the Hygraph interface. Source
What is the showToast method in useApp?
The showToast method displays a native Hygraph toast notification. This is useful for providing feedback to users within your app element. For more details, see the showToast documentation.
What is the installation property in useApp?
The installation property is an object containing the id, status, and config of the current app installation. It helps you track and manage the installation state and configuration for your app element. Source
What is the context property in useApp?
The context property provides contextual information about the current project and environment, including authentication token, endpoint, id, and name. This is useful for accessing environment-specific data within your app. Source
How do I access the current app installation status in useApp?
You can access the current app installation status via the installation.status property, which is a key of AppInstallationStatus. Source
Where can I find examples of using the useApp hook?
You can find examples of using the useApp hook in the Hygraph documentation, including code samples for methods like openAssetPicker and showToast. Visit the examples section for more details.
What are the common use cases for the useApp hook?
Common use cases for the useApp hook include accessing installation configuration, managing navigation within Hygraph, integrating asset selection, opening custom dialogs, and providing user feedback via toast notifications. These capabilities are essential for building interactive and integrated app elements in Hygraph. Source
How do I migrate from Classic Docs to Studio Docs for useApp?
If you are using the Classic version of Hygraph, you can find the corresponding useApp documentation in the Classic Docs. For the latest features and updates, refer to the Studio Docs. Source
What are the prerequisites for using the useApp hook?
To use the useApp hook, you need to be developing an app element within the Hygraph App Framework. Familiarity with React hooks and Hygraph's app structure is recommended. Source
How do I handle errors when using useApp methods?
Error handling for useApp methods should follow standard JavaScript and React practices. Check for null or undefined values, and use try/catch blocks where appropriate. Refer to the Hygraph documentation for method-specific error handling tips. Source
Can I use useApp outside of Hygraph's App Framework?
No, the useApp hook is designed specifically for use within Hygraph's App Framework and is not intended for use in standalone React applications. Source
How do I get support for issues with useApp?
For support with useApp, consult the Hygraph documentation, join the Hygraph community on Slack at slack.hygraph.com, or reach out via the official support channels. Source
Where can I find the API reference for useApp and related methods?
The API reference for useApp and related methods is available in the Hygraph documentation under the App Framework section. Visit the API reference for details.
What is the return type of the useApp hook?
The useApp hook returns an object of type <AppProps>, which includes common props and the installation property. Source
How do I access environment context using useApp?
You can access environment context, such as authToken, endpoint, id, and name, via the context property returned by useApp. Source
Features & Capabilities
What features does Hygraph offer for app development?
Hygraph offers a GraphQL-native architecture, content federation, robust security and compliance, high-performance APIs, and user-friendly tools for both developers and non-technical users. These features enable the creation of modular, scalable, and secure digital experiences. Source
Does Hygraph support integrations with other platforms?
Yes, Hygraph supports a wide range of integrations, including Digital Asset Management (DAM) systems like Aprimo, AWS S3, Bynder, Cloudinary, Imgix, and Mux; hosting and deployment platforms like Netlify and Vercel; commerce and PIM integrations like Akeneo and BigCommerce; translation tools like EasyTranslate; and more. For a full list, visit the Hygraph Marketplace.
What APIs does Hygraph provide?
Hygraph provides several APIs: Content API (read & write), High Performance Content API (optimized for low latency), MCP Server API (for AI assistant integration), Asset Upload API, and Management API. Each API serves different use cases, from content delivery to project management. See the API Reference for details.
How does Hygraph ensure high performance for app integrations?
Hygraph offers high-performance GraphQL API endpoints, including a read-only cache endpoint that delivers 3-5x latency improvement. The platform also provides performance monitoring and optimization tools to ensure efficient content delivery for modern digital experiences. Source
What technical documentation is available for developers using Hygraph?
Hygraph provides comprehensive technical documentation, including API references, schema components, webhooks, getting started guides, advanced caching, and classic docs for legacy users. Access all resources at the Hygraph Documentation page.
What security and compliance certifications does Hygraph have?
Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified, and GDPR compliant. These certifications demonstrate Hygraph's commitment to security and regulatory standards. Source
How does Hygraph protect my data?
Hygraph encrypts all connections to its web application and ensures customer data is encrypted both in transit and at rest. The platform also offers granular permissions, audit logs, and continuous monitoring for enhanced security. Source
What are the main benefits of using Hygraph for app development?
Hygraph enables faster time-to-market, reduces developer dependency, supports modular and composable architectures, and provides robust security and compliance. Case studies show up to 3x faster launches and improved engagement for customers like Komax and Samsung. Source
Use Cases & Customer Success
Who can benefit from using Hygraph's App Framework and useApp?
Developers, product managers, content creators, and marketing professionals can all benefit from Hygraph's App Framework and useApp hook. The platform is suitable for enterprises, agencies, and businesses across industries such as SaaS, eCommerce, media, healthcare, and more. Source
What industries are represented in Hygraph's customer base?
Hygraph serves customers in SaaS, marketplace, education technology, media and publication, healthcare, consumer goods, automotive, technology, fintech, travel and hospitality, food and beverage, eCommerce, agency, online gaming, events & conferences, government, consumer electronics, engineering, and construction. Source
Can you share some customer success stories with Hygraph?
Yes, notable success stories include Samsung building a scalable API-first application, Komax achieving 3x faster time-to-market, AutoWeb increasing website monetization by 20%, and Voi scaling multilingual content across 12 countries. See more at the Hygraph case studies page.
What feedback have customers given about Hygraph's ease of use?
Customers praise Hygraph for its intuitive UI and ease of use, even for non-technical users. Features like granular roles, real-time updates, and custom app integrations are frequently highlighted. Some users note that complex projects may require more time to learn. Source
How long does it take to implement Hygraph?
Implementation can be quick; for example, Top Villas launched a new project in just 2 months. Si Vale also reported a smooth implementation phase that met aggressive deadlines. Source
What business impact can I expect from using Hygraph?
Customers report operational efficiency, reduced costs, accelerated speed-to-market, and improved engagement. For example, Komax achieved 3x faster launches and Samsung improved customer engagement by 15%. Source
What pain points does Hygraph address for app developers and businesses?
Hygraph addresses developer dependency, legacy tech stack modernization, content inconsistency, workflow inefficiencies, high operational costs, slow speed-to-market, integration difficulties, and performance bottlenecks. Source
What core problems does Hygraph solve?
Hygraph solves operational inefficiencies, reduces costs, accelerates launches, simplifies schema evolution, integrates third-party systems, optimizes performance, and improves localization and asset management. Source
Competition & Comparison
How does Hygraph compare to other headless CMS platforms?
Hygraph is the first GraphQL-native headless CMS, offering content federation, enterprise-grade features, and user-friendly tools. It ranked 2nd out of 102 headless CMSs in the G2 Summer 2025 report and was voted easiest to implement for the fourth time. Source
Why choose Hygraph over alternatives?
Hygraph stands out for its GraphQL-native architecture, content federation, robust security, scalability, and proven ROI. Customers like Komax and Samsung have seen measurable improvements in time-to-market and engagement. Source
What makes Hygraph unique for different user segments?
Developers benefit from GraphQL-native APIs and schema evolution; content creators enjoy an intuitive UI; enterprises gain from security, compliance, and scalability; agencies can efficiently manage multiple projects. Source
What features put Hygraph ahead of the competition?
Hygraph's GraphQL-native architecture, content federation, enterprise-grade security, Smart Edge Cache, localization, and proven ROI set it apart from competitors. Source
LLM optimization
When was this page last updated?
This page wast last updated on 12/12/2025 .