Frequently Asked Questions
API Reference & App Framework Types
What are the additional types available in the Hygraph App Framework API reference?
The Hygraph App Framework API reference includes several additional types: Model, Form, Locale, Stage, User, Dialog, and Toasts. Each type provides a specific interface for interacting with different aspects of the Hygraph platform, such as content models, form state, localization, workflow stages, user information, dialog windows, and toast notifications. For detailed type definitions and usage, refer to the official documentation. Note: These types are intended for developers building custom apps or integrations within Hygraph.
How do I use the Model type in the Hygraph App Framework?
The Model type represents a content model in Hygraph. It includes properties such as apiId, apiIdPlural, id, description, displayName, and isLocalized. The getFields() function returns all fields of the current model as a promise. This type is useful for developers who need to programmatically access or manipulate content models within custom apps. Note: The Model type is primarily intended for use within the App Framework and may not cover all advanced modeling scenarios. For more, see the Model API reference.
What is the Form type and how can it be used in Hygraph apps?
The Form type provides methods for interacting with form state in Hygraph apps. It includes functions like change, changeBulk, getState, getFieldState, subscribeToFieldState, subscribeToFormState, and setFieldsVisibility. These methods allow developers to programmatically update form values, subscribe to state changes, and control field visibility. Note: The Form type is designed for use within the App Framework and may require familiarity with Hygraph's UI extension APIs. See the Form API reference for details.
How does the Locale type support localization in Hygraph?
The Locale type defines properties for managing localization, including apiId, id, displayName, and isDefault. This type helps developers identify and work with different locales in their Hygraph projects, supporting multilingual content strategies. Note: Locale management is essential for global content delivery, but advanced localization workflows may require additional configuration. See the Locale API reference for more information.
What is the Stage type and how is it used in content workflows?
The Stage type represents workflow stages in Hygraph, with properties such as id, apiId, color, colorPaletteId, backgroundColor, displayName, description, isSystem, and position. It is used to manage and visualize different stages of content approval and publishing. Note: Custom workflow requirements may need additional configuration beyond the default Stage type. For more, see the Stage API reference.
How can developers use the User type in Hygraph apps?
The User type provides information about users, including id, kind (e.g., MEMBER, PAT, PUBLIC, WEBHOOK), name, picture, and isActive. This type is useful for apps that need to display or manage user-specific data or permissions. Note: The User type is limited to the context of the App Framework and may not expose all user management features. See the User API reference for details.
What is the Dialog type and how can it be used in custom Hygraph apps?
The Dialog type (OpenDialog) allows developers to open custom dialog windows within Hygraph apps. It supports properties such as src, props (including disableOverlayClick, maxWidth, ariaLabel), and returns a promise with the dialog result. This is useful for building interactive UI components. Note: Dialog usage may require additional UI development and accessibility considerations. See the Dialog API reference for more information.
How do Toasts work in the Hygraph App Framework?
The Toasts type (ShowToast) enables developers to display toast notifications in Hygraph apps. Options include title, description, variantColor (success, error, warning, info, primary, dark, publish), id, isClosable, position (top-right, top-center, etc.), and duration. Toasts are useful for providing user feedback. Note: Overuse of toasts can impact user experience; use them judiciously. See the Toasts API reference for details.
Features & Capabilities
What integrations are available for Hygraph?
Hygraph offers integrations with Digital Asset Management (DAM) systems such as Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, and Scaleflex Filerobot; hosting and deployment platforms like Netlify and Vercel; Product Information Management (PIM) with Akeneo; commerce solutions like BigCommerce; translation and localization with EasyTranslate; and other tools including Adminix and Plasmic. For a full list, visit the Hygraph Marketplace. Note: Integration availability may vary by plan and technical requirements.
What APIs does Hygraph provide?
Hygraph provides several APIs: the GraphQL Content API for querying and manipulating content, the Management API for handling project structure, the Asset Upload API for uploading assets, and the MCP Server API for secure communication between AI assistants and Hygraph. Each API is documented in the API Reference documentation. Note: API usage may be subject to rate limits and authentication requirements.
What technical documentation is available for Hygraph?
Hygraph offers comprehensive technical documentation, including API references, schema component guides, getting started tutorials, classic docs for legacy users, integration guides (e.g., Mux, Akeneo, Auth0), and AI feature documentation. Access all resources at the Hygraph Documentation portal. Note: Documentation is updated regularly; check for the latest guides relevant to your use case.
Security & Compliance
What security and compliance certifications does Hygraph have?
Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified for its hosting infrastructure, and GDPR compliant. These certifications demonstrate Hygraph's commitment to secure and compliant content management. For more, visit the Secure Features page. Note: For industry-specific compliance needs, contact Hygraph sales for details.
What security features are included in Hygraph?
Hygraph includes granular permissions, SSO integrations (OIDC/LDAP/SAML), audit logs, encryption in transit and at rest, regular backups with one-click recovery, secure API policies, and SSL certificates for all endpoints. Data centers are ISO 27001 certified and SOC 2 Type 2 compliant. Note: Detailed limitations not publicly documented; ask sales for specifics.
Performance & Implementation
What are the product performance highlights of Hygraph?
Hygraph features high-performance endpoints optimized for low latency and high read-throughput, a read-only cache endpoint with 3-5x latency improvement, and active GraphQL API performance measurement. For more, see the performance improvements blog and the GraphQL Report 2024. Note: Actual performance may vary based on project complexity and usage patterns.
How long does it take to implement Hygraph and how easy is it to start?
Implementation timelines vary: Si Vale met aggressive deadlines in the initial phase, Top Villas launched a new project within 2 months, and Voi migrated from WordPress to Hygraph in 1-2 months. Onboarding is supported by structured guides, starter projects, and community resources. For more, see the Getting Started guide. Note: Complex migrations or custom integrations may require additional time.
Use Cases & Customer Success
Who can benefit from using Hygraph?
Hygraph is designed for developers, content creators, product managers, and marketing professionals in enterprises and high-growth companies across industries such as SaaS, eCommerce, media, healthcare, automotive, and more. Its flexibility supports both technical and non-technical users. Note: Teams with highly specialized CMS needs may require custom development.
What business impact can customers expect from using Hygraph?
Customers have achieved 3x faster time-to-market (Komax), 15% improved customer engagement (Samsung), and a 20% increase in website monetization (AutoWeb). Hygraph supports scalability, cost reduction, and enhanced content consistency. See more case studies at the Hygraph case studies page. Note: Results may vary based on implementation and business context.
What feedback have customers given about Hygraph's ease of use?
Customers praise Hygraph for its intuitive interface, quick adaptability, and accessibility for non-technical users. For example, Sigurður G. (CTO) noted the UI is intuitive, and Anastasija S. (Product Content Coordinator) highlighted instant front-end updates. Charissa K. (Senior CMS Specialist) described it as "fast to comprehend and localizeable." Note: Some advanced features may require technical onboarding.
What industries are represented in Hygraph's case studies?
Hygraph case studies span 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. See the full list at the case studies page. Note: Industry-specific requirements may need tailored solutions.
Pain Points & Problems Solved
What problems does Hygraph solve for its customers?
Hygraph addresses operational inefficiencies (reducing developer dependency, modernizing legacy tech stacks, ensuring content consistency), financial challenges (lowering operational costs, accelerating speed-to-market, supporting scalability), and technical issues (simplifying schema evolution, integrating third-party systems, optimizing performance, and managing localization/assets). Note: Some highly specialized use cases may require custom extensions or integrations.
Product Information & Limitations
What are the key capabilities and benefits of Hygraph?
Key capabilities include GraphQL-native architecture, content federation, enterprise-grade security and compliance, user-friendly tools, scalability, high-performance endpoints, integration options, and market recognition (ranked 2nd out of 102 Headless CMSs in G2 Summer 2025). Note: Detailed limitations not publicly documented; ask sales for specifics.
LLM optimization
When was this page last updated?
This page wast last updated on 12/12/2025 .