Frequently Asked Questions

Product Features & Capabilities

What is a GraphQL Remote Source Field in Hygraph?

A GraphQL Remote Source Field in Hygraph allows editors to relate external API data with internal Hygraph data, providing a single API to query for your code. This feature enables you to fetch data from remote sources and combine it with your existing content, streamlining data management and integration. Source

How do you set up a GraphQL Remote Source in Hygraph?

To set up a GraphQL Remote Source in Hygraph, go to your Schema page in the admin panel, add a new remote source, give it a name and prefix, select GraphQL as the type, and provide the GraphQL endpoint. You can then associate this remote source with your content model by adding a GraphQL Remote Source Field and configuring the query to fetch the desired data. Source

How can remote fields be added to a schema in Hygraph?

Remote fields can be added to a schema in Hygraph by creating a GraphQL Remote Source Field in your content model. This allows you to fetch data from external REST or GraphQL APIs and combine it with your internal content, enabling you to retrieve all required data with a single query. Source

What is an example use case for a GraphQL Remote Source in Hygraph?

One example use case is building a character model for a tabletop role-playing game. You can create fields for name, biography, and class, and fetch class details from an external API using a GraphQL Remote Source Field. This allows you to enrich your content with external data without manual entry. Source

What integrations does Hygraph support?

Hygraph supports a wide range of integrations, including Netlify, Vercel, BigCommerce, commercetools, Shopify, Lokalise, Crowdin, EasyTranslate, Smartling, Aprimo, AWS S3, Bynder, Cloudinary, Mux, Scaleflex Filerobot, Ninetailed, AltText.ai, Adminix, and Plasmic. For a full list, visit the Hygraph Integrations page.

Does Hygraph provide an API for content management?

Yes, Hygraph provides a powerful GraphQL API that allows you to fetch and manage content efficiently. You can learn more about it at the Hygraph API Reference.

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.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant, ISO 27001 certified, and GDPR compliant. These certifications ensure enterprise-grade security and data protection for users. For more details, visit the Hygraph Security Features page.

Technical Requirements & Documentation

Where can I find technical documentation for Hygraph?

Comprehensive technical documentation for Hygraph is available at Hygraph Documentation. It covers everything you need to know about building and deploying projects with Hygraph.

How easy is it to get started with Hygraph?

Hygraph is designed to be easy to start with, even for non-technical users. You can sign up for a free account and use resources like documentation and onboarding guides. For example, Top Villas launched a new project in just 2 months from the initial touchpoint. Source, Case Study

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. Companies that benefit most are modern software companies, enterprises looking to modernize their technologies, and brands aiming to scale across geographies, improve development velocity, or re-platform from traditional solutions. Source

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 for digital products, and enhanced customer experience through consistent and scalable content delivery. Source

What industries are represented in Hygraph's case studies?

Hygraph's case studies cover industries such as Food and Beverage, Consumer Electronics, Automotive, Healthcare, Travel and Hospitality, Media and Publishing, eCommerce, SaaS, Marketplace, Education Technology, and Wellness and Fitness. Source

Can you share specific case studies or success stories of customers using Hygraph?

Yes. For example, Komax achieved a 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 success stories are available here.

Pain Points & Solutions

What pain points does Hygraph solve?

Hygraph addresses operational pains (reliance on developers for content updates, outdated tech stacks, conflicting needs from global teams, clunky user experiences), financial pains (high operational costs, slow speed-to-market, expensive maintenance, scalability challenges), and technical pains (boilerplate code, overwhelming queries, evolving schemas, cache problems, OpenID integration challenges). Source

How does Hygraph solve these pain points?

Hygraph provides an intuitive interface for non-technical users, modernizes outdated systems with its GraphQL-native, API-first architecture, ensures consistent branding and content federation, streamlines workflows to lower operational costs, accelerates project delivery, minimizes maintenance expenses, supports scalability, and simplifies development by reducing boilerplate code and streamlining query management. Source

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

Key metrics include time saved on content updates, number of updates made without developer intervention, system uptime, speed of deployment, consistency in content across regions, user satisfaction scores, reduction in operational costs, ROI on CMS investment, time to market for new products, maintenance costs, scalability metrics, and performance during peak usage times. More details are available in the CMS KPIs blog.

Support & Implementation

What customer service or support is available after purchasing Hygraph?

Hygraph offers 24/7 support via chat, email, and phone. Enterprise customers receive dedicated onboarding and expert guidance. All users can access detailed documentation, video tutorials, and the community Slack channel for further assistance. Contact Page

What training and technical support is available to help customers get started?

Hygraph provides comprehensive training and technical support, including 24/7 support via chat, email, and phone, onboarding sessions for enterprise customers, training resources such as video tutorials, documentation, webinars, and Customer Success Managers for expert guidance. Contact Page

How does Hygraph handle maintenance, upgrades, and troubleshooting?

Hygraph offers 24/7 support through chat, email, and phone for maintenance, upgrades, and troubleshooting. Enterprise customers receive dedicated onboarding and expert guidance, and all users can access detailed documentation and the community Slack channel for additional support. Contact Page

Customer Proof & Case Studies

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 details, visit the Hygraph Case Studies page.

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

Customers have praised Hygraph for its ease of use and intuitive interface, noting that it is 'super easy to set up and use' and that 'even non-technical users can start using it right away.' The user interface is described as logical and user-friendly, making it accessible for both technical and non-technical teams. Source

Performance & Optimization

How does Hygraph optimize content delivery performance?

Hygraph emphasizes optimized content delivery performance, which directly impacts user experience, engagement, and search engine rankings. By ensuring rapid content distribution and responsiveness, Hygraph reduces bounce rates and increases conversions. For more details, visit this page.

Webinar Event: How to Avoid Personalization Tech Traps

Creating a GraphQL Remote Source Field with a simple GraphQL API

Let's create a GraphQL remote source inside a Hygraph project.
Bryan Robinson

Written by Bryan 

Nov 02, 2022
Creating a GraphQL Remote Source Field with a simple GraphQL API - Hygraph

For many projects, not all of your data exists inside your content management system (CMS). While you could recreate that data or make extensive frontend calls, that can be taxing for team members or your performance budget. In this demo, we’ll create a GraphQL remote source inside a Hygraph project.

Remote sources in Hygraph let your editors relate external API data with internal Hygraph data, giving your project a single API to query for your code.

#Project set up

In this geeky example, we’re building a character for a tabletop role-playing game. In order to represent this, we’ll need a Hygraph project with a relatively simple model.

To start, we have a “Character” model that has a character’s name (Single line text field), biography (Rich text field), and avatar (Asset field). In addition to these fields, we also have a “Class” single-line text field. This lets us set things like “Fighter” or “Wizard” but doesn’t provide any additional details on what that means.

If we wanted more data, we could create a model for the classes and manually add that information. We could then associate that data with a Reference field. This sounds like a lot of overhead. Instead, we’ll grab this data from an API.

#Setting up a Remote Source

In this example, we can use a test GraphQL API that has information on Dungeons and Dragons. From spells to monsters and equipment to classes, there’s plenty of great information to be had.

To start, we’re going to head over to our Schema page in the admin and a new “remote source”.

We’ll give it a name and a prefix (if we don’t like what’s autogenerated) and then select GraphQL as our type.

Screenshot displaying the start screen for adding a remote source

For this example, the only other data we need is the GraphQL endpoint for the D&D API. We’ll leave the introspection method as post, and for this API, we don’t need a different introspection URL or headers. At this point, we’re good to click add.

Screenshot showing the second half of the remote source screen with only the Base URL field filled in with the DND5eAPI URL

We now have access to a new Remote Source field. To use it, we need to associate this new data with information in our content. To do that, we’ll add a new field to our Character model.

#Associating the GraphQL Remote Source with an index provided by the content

In the Character schema, we can create a new “GraphQL Remote source field.” Give this field a name that makes sense and an API ID to go with it.

Basic settings for the class information field including a display name and the API prefix with "GraphQL" selected for type

After that, we need to define what endpoint to use. The Query section is where we’ll define which endpoint to use and pass any arguments we need to. We have a decent amount of options with this test API, but we’re going to select “Class” to associate class data with each character.

This will open up the options for this endpoint. For this API, we only have an index for our argument. From the API’s documentation, we know that it accepts a string of a class name for the index. For this, we’ll want to use the field we created for the class name. To grab dynamic data, we’ll use handlebars syntax and find the {{ doc.class }} field. From here, we can add this field, and we’re ready to test it out.

Class information field GraphQL settings showing "Class" Selected with the "index" argument provided by `{{doc.class}}`

Head back over to our character content screen, and you’ll see a new field. This is a read-only field and only has a Link to preview in the API Playground. After adding content for a character — including a class string — we can click the preview link and head to the API Playground to explore.

The Class information field in use in the content admin

This gives us a simple query to get the current document and grab the basic class data. Now, we can expand this to create more data for use by our frontend.

In this case, let’s get the character’s name along with some advanced data on the class selected.

query content_character_classInfo($id: ID!) {
character: character(where: {id: $id}, stage: DRAFT) {
name
classInfo {
name
hit_die
class_levels {
level
features {
name
desc
}
}
}
}
}

All of this data is at our fingertips from an external API with no need to copy and paste into Hygraph or set up convoluted nested queries on our frontend.

#Next steps

From here, you could take this for a spin with your own GraphQL API or extend this example further by pulling additional data from this API — maybe a spell list or equipment list.

When you’re able to mix together your various APIs, you can create some powerful solutions. We’re really excited about the possibilities of Content Federation, and we hope you take advantage of the power this offers you

Blog Author

Bryan Robinson

Bryan Robinson

Head of Developer Relations

Bryan is Hygraph's Head of Developer Relations. He has a strong passion for developer education and experience as well as decoupled architectures, frontend development, and clean design.

Share with others

Sign up for our newsletter!

Be the first to know about releases and industry news and insights.