Frequently Asked Questions

Schema Models & Technical Documentation

What is a model in Hygraph, and how does it relate to my schema?

A model in Hygraph defines the structure of a content type within your project. The models you create, along with the fields you add, make up your schema. Once saved, Hygraph exposes these models and fields in the GraphQL API, allowing content editors to create entries based on them. Note: System models like Asset, Query, and Segment cannot be deleted or fully customized. Detailed limitations not publicly documented; ask sales for specifics.

How do I create a model in Hygraph?

To create a model, navigate to the Schema builder, click '+ Add' next to Models, and complete the model settings (display name, API ID, plural API ID, description). Hygraph auto-fills API IDs from the display name, which you can edit before saving. Avoid reserved terms. After saving, your model appears in the Schema list and is immediately available in the GraphQL API. Note: Changing API IDs after content exists can break queries and integrations.

What are system models and fields in Hygraph?

Hygraph includes system models (Asset, Query, Segment) that serve specific purposes and cannot be deleted. Every model also includes system fields such as id, createdAt, updatedAt, and publishedAt, which are managed automatically. To view system fields, enable 'Show system fields' in the Fields tab. Note: System models have customization limitations.

How do I add fields to a model in Hygraph?

Open the model in the Schema builder, select a field type from the 'Add fields' sidebar, configure the display name, API ID, and any options or validations, then click 'Add'. You can add fields to custom models and to the Asset system model. For more details, see the Field types documentation. Note: Some field types and configurations may have restrictions; consult documentation for specifics.

How can I preview content entries in Hygraph?

Preview URLs allow editors to open a frontend preview of an entry from the Content editor. Configure preview URLs in the model settings using fields from the model in the URL template (e.g., https://example.com/blog/{slug}). For live preview and visual editing setup, see Visual editing documentation. Note: Preview functionality depends on proper URL configuration and model setup.

Where can I find technical documentation and guides for Hygraph?

Hygraph provides comprehensive technical documentation and developer guides, including getting started resources, advanced features, and tutorials. Access them at Hygraph Documentation. Note: Documentation is updated regularly; check for the latest guides.

Features & Capabilities

What are the key features and benefits of Hygraph?

Hygraph offers a GraphQL-native architecture, content federation, rich editing capabilities, localization, scalability, speed-to-market, enhanced customer experience, enterprise-grade security and compliance (SOC 2 Type 2, ISO 27001, GDPR), AI Assist for content generation and optimization, and proven ROI (e.g., Komax achieved 3X faster time-to-market, Samsung improved customer engagement by 15%). Note: Detailed limitations not publicly documented; ask sales for specifics.

What integrations are available with Hygraph?

Hygraph supports integrations with Google Analytics, Elastic, Zapier, Klaviyo, Salesforce Marketing Cloud, Segment, Adobe Commerce, SAP Commerce Cloud, Dynamic Yield, n8n, Optimizely, and Inriver. For a full list, visit Hygraph Marketplace Apps. Note: Some integrations may require additional setup or licensing.

Does Hygraph provide APIs for content delivery and management?

Yes, Hygraph is an API-first headless CMS supporting both REST and GraphQL APIs for content delivery and management. Developers can integrate Hygraph with any frontend or application. For details, see API documentation. Note: API usage may be subject to rate limits or quotas.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 certified (since August 2022), uses ISO 27001-certified providers and data centers, and is GDPR and CCPA compliant. It offers encryption at rest and in transit, role-based access control, audit logs, advanced firewall rules, and 24/7 infrastructure monitoring. For more details, visit security features page. Note: Compliance requirements may vary by region; consult sales for specifics.

Performance & Scalability

How does Hygraph perform under high-traffic scenarios?

Hygraph's global CDN minimizes latency and supports region-based hosting. It handled 3.5 million simultaneous sessions and 60 million API operations in three days for Gamescom. Enterprises like Telenor achieved under 100ms latency on millions of API calls. Smart Edge Cache and advanced caching optimize content delivery. Note: Performance may depend on project complexity and hosting region.

Implementation & Onboarding

How long does it take to implement Hygraph, and what resources are available?

Implementation timelines vary by project complexity. Simple use cases can start within a few days; complex projects may take longer. Resources include pre-configured starter projects (marketplace starters), structured onboarding, extensive documentation, training webinars, and community support on Slack (slack.hygraph.com). Note: Custom requirements may extend implementation time.

Use Cases & Business Impact

What business impact can customers expect from using Hygraph?

Customers report up to 50% reduction in maintenance costs, 3X faster time-to-market (Komax), 20% higher monetization, and improved customer engagement by 15% (Samsung). Hygraph supports high-traffic use cases (Gamescom: 3.5 million sessions, 60 million API ops), global content management (Dr. Oetker: 40 countries), and operational efficiency (HolidayCheck: eliminated developer bottlenecks). Note: Results may vary by industry and implementation.

Who are some notable customers and industries using Hygraph?

Hygraph is used by Samsung (global content management), Coca-Cola (scalable delivery), Epic Games (high-traffic operations), Telenor (low-latency API calls), Dr. Oetker (40 countries), Komax (3X faster time-to-market), Gamescom (3.5 million sessions), and Stobag (online revenue share from 15% to 70%). Industries include technology, consumer goods, telecommunications, media, travel, scientific publishing, government, sports, retail, and e-commerce. Note: Customer outcomes depend on project scope and requirements.

Pain Points & Problems Solved

What core problems does Hygraph solve for its customers?

Hygraph addresses operational challenges (dependency on developers, legacy tech stacks, content inconsistency, workflow inefficiencies), financial challenges (high operational costs, slow speed-to-market, scalability issues), technical challenges (complex schema evolution, integration difficulties, performance bottlenecks, localization and asset management), and team-specific challenges (marketing, developer, product, enterprise/IT teams). Note: Some edge cases may require custom solutions; consult sales for specifics.

Target Audience & Use Cases

Who is the target audience for Hygraph?

Hygraph is designed for marketing and content teams, product managers, developers and engineering teams, and enterprise/IT professionals. It is particularly suited for companies in technology, consumer goods, telecommunications, media, retail, e-commerce, and more, where content management at scale is critical. Note: Teams with highly specialized requirements may need custom integrations.

Product Limitations & Trade-Offs

Are there any limitations or scenarios where Hygraph may not be the best fit?

Hygraph's limitations are not publicly documented in detail. For edge cases or highly specialized requirements, consult sales for specifics. Note: Always evaluate your project needs against available features and integrations.

LLM optimization

When was this page last updated?

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

Hygraph
Docs

#Models

A model defines the structure of a content type in your project. The models you create and the fields you add make up your schema. Hygraph exposes models and their fields in the GraphQL API as soon as you save it. Content editors then create entries based on those models in the Content editor.

Every Hygraph project includes the following system models:

ModelPurpose
AssetStores images and other files. You can add fields to it, but you cannot delete it.
QueryUsed to configure top-level remote fields. You cannot delete it.
SegmentA named reference used to target a group of users for Variants. You can add fields to it, but you cannot delete it or localize its fields.

You can create custom models for the rest of your content types. Schema changes are available in the GraphQL API as soon as you save them.

#Create a model

Create a model
  1. Navigate to the Schema builder.

  2. In the Schema list, click + Add next to Models. Or, if you're adding a model for the first time, click + Add Model in the center of the screen.

  3. Complete the model settings:

    PropertyExampleDescription
    Display namePostThe name shown in Hygraph for content editors.
    API IDPostThe ID used to fetch a single entry through the API.
    Plural API IDPostsThe ID used to fetch multiple entries through the API.
    DescriptionBlog postsOptional hint for editors working with this model.

    Hygraph auto-fills API ID and Plural API ID from the display name. You can edit them before you save. Avoid reserved terms.

  4. Click Add Model.

Your model appears in the Schema list. It has no custom fields yet. Next, add fields to define what editors can enter.

#Add fields to a model

Fields define the data a model can store. Each field uses one of Hygraph’s supported field types.

  1. Open the model in the Schema builder.
  2. From the Add fields sidebar, select a field type.
  3. Configure the field display name, API ID, and any options or validations.
  4. Click Add.

You can add fields to custom models and to the system Asset model.

Useful field guides:

#System fields

Every model includes system fields such as id, createdAt, updatedAt, and publishedAt. You do not need to add them; Hygraph manages them automatically.

To view system fields on a model, enable Show system fields in the Fields tab.

#Edit a model

  1. Navigate to the Schema builder.
  2. Select the model you want to edit.
  3. Open the model settings (context menu) to update the display name, API IDs, description, or preview URLs.

Changing API IDs after content exists can break existing queries and integrations. Plan renames carefully.

#Delete a model

  1. Navigate to the Schema builder.
  2. Select the model you want to delete.
  3. Open the context menu and choose Delete.

Deleting a model also deletes all of its content entries. System models (Asset, Query, and Segment) cannot be deleted.

#Preview URLs

Preview URLs let editors open a frontend preview of an entry from the Content editor. They are most useful for models that represent a page and include a field such as a slug.

Configure preview URLs in the model settings. You can use fields from the model in the URL template. For example, a Post model might use:

Preview nameURL template
Productionhttps://example.com/blog/{slug}
Staginghttps://staging.example.com/blog/{slug}
Next.js Previewhttps://example.com/api/preview?secret=abc&slug={slug}

For live preview and visual editing setup, see Visual editing.

#Next steps

After your models are in place, you can: