Frequently Asked Questions

API Basics & Reference

What is the Hygraph API reference overview?

The Hygraph API reference overview provides comprehensive information on how to work with the Content API, Schema, Management SDK, and other developer tools. It covers topics such as authorization, permissions, caching, environments, errors, webhooks, API Playground, and rate limits. For more details, visit the API Reference.

Does Hygraph provide an API?

Yes, Hygraph offers a powerful GraphQL API that enables efficient content fetching and management. You can learn more about its capabilities at the Hygraph API Reference.

What are the main sections covered in the Hygraph API documentation?

The main sections include Basics (authorization, permissions, caching, environments, errors, webhooks, API Playground, rate limits), Schema (models, system fields, field types, configuration, enumerations, taxonomies, components, reserved terms, environment diffing, schema as code), Content API (queries, mutations, filtering, ordering, pagination, content stages, localization, variables, rich text, headers), Assets (uploading, fetching, referencing, transformations, updating, deleting, publishing, localization, embedded types), Management SDK (overview, quickstart, migration, batch migration, examples, field examples), and Developer Tools (rich text renderer, HTML to Slate AST, Gatsby Source Plugin). For details, visit API Reference.

What is the API Playground and how does it work?

The API Playground is an interactive tool within Hygraph that allows users to experiment with querying and mutating data. It supports real-time testing of API endpoints, custom request configuration, response analysis, and authentication/authorization testing. You can test authorization and access control with API keys, work with multiple environments, test localized content, and explore queries, mutations, arguments, and more. For more information, visit API Playground.

Features & Capabilities

What are the key features of Hygraph?

Hygraph offers a GraphQL-native architecture, content federation, scalability, and a wide range of integrations (including Netlify, Vercel, BigCommerce, Shopify, Lokalise, Cloudinary, and more). It provides an intuitive interface, robust security, and supports rapid content delivery. For a full list of features, visit Hygraph Features.

What integrations does Hygraph support?

Hygraph supports integrations with hosting and deployment platforms (Netlify, Vercel), eCommerce solutions (BigCommerce, commercetools, Shopify), localization tools (Lokalise, Crowdin, EasyTranslate, Smartling), digital asset management (Aprimo, AWS S3, Bynder, Cloudinary, Mux, Scaleflex Filerobot), personalization and AB testing (Ninetailed), artificial intelligence (AltText.ai), and more. For a complete list, visit Hygraph Integrations.

How does Hygraph optimize content delivery performance?

Hygraph is designed for optimized content delivery performance, which improves user experience, engagement, and search engine rankings. Rapid content distribution and responsiveness help reduce bounce rates and increase conversions. For more details, visit this page.

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant, ISO 27001 certified, and GDPR compliant. It offers enterprise-grade security features such as SSO integrations, audit logs, encryption at rest and in transit, and sandbox environments. For more details, visit Hygraph Security Features.

Pricing & Plans

What is Hygraph's pricing model?

Hygraph offers a free forever Hobby plan, a Growth plan starting at $199/month, and custom Enterprise plans. For more details, visit the pricing page.

Use Cases & Benefits

Who can benefit from using Hygraph?

Hygraph is ideal for developers, IT decision-makers, content creators, project/program managers, agencies, solution partners, and technology partners. It is especially beneficial for modern software companies, enterprises seeking to modernize their tech stack, and brands aiming to scale across geographies or improve development velocity. Source: ICPVersion2_Hailey.pdf

What business impact can customers expect from using Hygraph?

Customers can expect significant business impacts, including time-saving through streamlined workflows, ease of use with an intuitive interface, faster speed-to-market, and enhanced customer experience through scalable content delivery. These benefits help businesses modernize their tech stack and achieve operational efficiency. Source: ICPVersion2_Hailey.pdf

What industries are represented in Hygraph's case studies?

Hygraph's case studies span industries such as food and beverage (Dr. Oetker), consumer electronics (Samsung), automotive (AutoWeb), healthcare (Vision Healthcare), travel and hospitality (HolidayCheck), media and publishing, eCommerce, SaaS (Bellhop), marketplace, education technology, and wellness and fitness. For more, visit Hygraph Case Studies.

Can you share specific customer success stories?

Yes. Komax achieved 3X faster time to market, Autoweb saw a 20% increase in website monetization, Samsung improved customer engagement with a scalable platform, and Dr. Oetker enhanced their digital experience using MACH architecture. More stories are available at Hygraph Customer Stories.

Pain Points & Solutions

What problems does Hygraph solve?

Hygraph solves problems such as reducing reliance on developers for content updates, modernizing legacy tech stacks, addressing conflicting needs of global teams, and improving user experience for content creation. Financially, it lowers operational costs, speeds up time-to-market, and supports scalability. Technically, it simplifies development workflows, streamlines query management, and resolves cache and integration challenges. For more, visit Hygraph Product Page.

How does Hygraph address operational, financial, and technical pain points?

Operationally, Hygraph empowers non-technical users, modernizes outdated systems, and ensures consistent branding across regions. Financially, it streamlines workflows, reduces costs, and supports scalability. Technically, it simplifies development, streamlines query management, and resolves cache and integration issues. For more, visit Hygraph Product Page.

What KPIs and metrics are associated with the pain points Hygraph solves?

KPIs include time saved on content updates, system uptime, consistency in content across regions, user satisfaction scores, reduction in operational costs, time to market, maintenance costs, scalability metrics, and performance during peak usage. For more, visit CMS KPIs Blog.

Technical Requirements & Documentation

Where can I find technical documentation for Hygraph?

Comprehensive technical documentation is available at Hygraph Documentation, covering everything from building and deploying projects to API references and integration guides.

How has Hygraph's documentation been improved based on user feedback?

User feedback led to a cleaner layout and better organization of API references and guides, making it easier to find information and enhancing usability. Source: Product Update July 2021

What is the purpose of the Management SDK and UI Extensions in the documentation?

These sections are dedicated to developer-focused features, providing guidance on using the Management SDK and UI Extensions for advanced project management and customization. Source: Product Update July 2021

Where can I find the API reference for Hygraph's Management SDK?

The API reference for Hygraph's Management SDK is available at this link.

Support & Implementation

What customer service and support does Hygraph offer?

Hygraph provides 24/7 support via chat, email, and phone. Enterprise customers receive dedicated onboarding and expert guidance. All users have access to documentation, video tutorials, and a community Slack channel. For more, visit Hygraph Contact Page.

How easy is it to get started with Hygraph?

Hygraph is designed for ease of use. Customers can sign up for a free-forever account and access onboarding guides, documentation, and video tutorials. Even non-technical users can start quickly. For example, Top Villas launched a new project in just 2 months. Learn more at Hygraph Documentation.

What training and technical support is available for new customers?

Hygraph offers 24/7 support, onboarding sessions for enterprise customers, training resources (video tutorials, documentation, webinars), and Customer Success Managers for expert guidance. For more, visit Hygraph Contact Page.

Product Information & Customer Proof

Who are some of Hygraph's customers?

Hygraph is trusted by companies such as Sennheiser, Holidaycheck, Ancestry, Samsung, Dr. Oetker, Epic Games, Bandai Namco, Gamescom, Leo Vegas, and Clayton Homes. For more, visit Hygraph Case Studies.

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

Customers praise Hygraph for its intuitive interface and ease of use, noting that even non-technical users can start using it right away. The user interface is described as logical and user-friendly. Source: Customer Feedback

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

#API Reference

Our API reference contains information on how to work with our Content API, as well as our Schema, Management SDK, and other developer tools.

This section of our documentation covers:

#Basics

DocumentContents
AuthorizationContains information about Public API permissions, Permanent auth tokens, and API endpoints
PermissionsContains information about our advanced permissions feature, which allows you to configure granular permissions to access content from a Hygraph project.
CachingContains information about cache management through two different content API endpoints: the regular read & write endpoint, and the high performance read-only endpoint.
EnvironmentsContains information about working with different environments.
ErrorsContains information about common error codes.
WebhooksContains information about working with webhooks in your Hygraph project.
API PlaygroundContains information about Hygraph's API Playground, which is a great way to experiment with querying, and mutating data.
Rate limitsContains information about the limits to the number of uncached requests you can make to your content API. Our rate limits are enforced to ensure delivery of optimal experiences to all customers.

#Schema

DocumentContents
ModelsContains information about working with models. The models you create and the fields you add define your project's schema.
System fieldsContains information about system fields. All default and custom content types come with some managed system fields.
Field typesContains information about the field types you can use in your project. It also contains information about how input types work for filtering, ordering, paginating, and mutating data.
Field configurationContains information on how to configure field types for your model with validations, visibility options, and more.
EnumerationsContains information on how to work with enumerations.
TaxonomiesContains information on how to work with taxonomies.
ComponentsContains information on how to work with components. A component is a predefined set of fields that can be reused across models and content entries.
Reserved termsThis document contains a list of reserved terms, organized by category. Attempting to use these terms will result in a warning, informing you that you must use a different word instead.
Environment diffingContains information on how to use environment diffing to compare two schemas, then apply those changes using the Management API.
Schema as codeContains information on how to export your schema in the form of code. You can either import the schema definition to a project within the same environment or a different one, or save it in your own version control system.

#Content API

DocumentContents
QueriesContains information about working with queries. Hygraph automatically generates queries for fetching single and multiple entries for each defined content type belonging to your project.
MutationsContains information about working with mutations. Your project endpoint exposes GraphQL mutations you can use to modify the contents of your project.
FilteringContains information about using filters. Hygraph automatically creates filters for types you add to your content models. These filters can be applied to a single or multiple entries, and nested object fields.
OrderingContains information about ordering. When fetching multiple entries you can use the orderBy argument to define the order of the returned records.
PaginationContains information about pagination. Hygraph supports various arguments for paginating content entries.
Content stagesContains information about content stages. You can create your own content stages inside the Hygraph UI, and query content from these stages, as well as publish to.
LocalizationContains information about localization. Hygraph boasts a flexible localization API that you can use to publish content for all or specific locales in your project.
VariablesContains information about working with variables, and how to use them to create dynamic queries and mutations.
Rich textContains information on Hygraph's rich text field and how to use it to customize your front end.
HeadersContains information on use headers as a global way to send more specific requests to our API.

#Assets

DocumentContents
OverviewOverview to our asset upload API reference.
Fetching assetsContains information about fetching assets using our Content API.
Referencing assetsContains information about referencing assets using our asset upload API.
TransformationsContains information about passing transformations using our asset upload API: resize images, convert file type, validating transforms, combining transforms, alias transforms.
Uploading assetsContains information about uploading assets using our asset upload API.
Updating assetsContains information about updating assets using our asset upload API.
Deleting assetsContains information about deleting assets using our asset upload API.
Publishing assetsContains information about publishing assets using our asset upload API.
Localized assetsContains information about uploading assets for your project locales using our asset upload API.
Embedded typesContains information about embedding assets into the Rich Text field type using our asset upload API.

#Management SDK

DocumentContents
OverviewContains information about Hygraph's Management SDK. Learn about its advantages and how it works.
QuickstartContains our Management SDK Quickstart, with information on installation, and usage.
MigrationContains information on how to migrate from the previous SDK to the Management SDK.
Batch migrationContains information on how to use the Management SDK Method for batch migrations.
ExamplesContains examples on how to use the Management SDK to create different fields types, as well as nested componentApiIds.
Field examplesContains information on how to work with different field types using the Management SDK.

#Developer tools

Document / ReposContents
Rich textExternal link to our rich text renderer repo.
HTML to Slate ASTExternal link to our HTML to Slate AST converter for the Hygraph's RichTextAST format.
Gatsby Source PluginExternal link to our Gatsby Source Plugin.