Frequently Asked Questions

Product Overview & Navigation

What is the Hygraph app walkthrough and what does it cover?

The Hygraph app walkthrough is a comprehensive guide that explains how to navigate the Hygraph Studio interface. It covers the main sections of the app, including the project directory, projects, your apps, analytics, schema builder, content editor, assets manager, API Playground, endpoints & permissions, and other features. The walkthrough also provides step-by-step instructions and video tutorials for each section. Read the full walkthrough.

What are the main sections of the Hygraph Studio app?

The main sections of Hygraph Studio include:

For a detailed breakdown, see the official documentation.

How do I access support and account settings in Hygraph Studio?

In Hygraph Studio, you can access support and account settings from the top right of the screen. There are direct links to contact support and manage your account settings, ensuring you can quickly resolve issues or update your profile as needed.

Features & Capabilities

What features does the Hygraph Studio app offer for content management?

Hygraph Studio offers a range of features for content management, including:

For more details, see the app walkthrough.

What actions can I perform in the Schema Builder?

In the Schema Builder, you can:

Learn more in the Schema Builder guide.

How does the Content Editor work in Hygraph Studio?

The Content Editor allows you to create, edit, publish, unpublish, duplicate, and delete content entries based on your schema. It supports default and custom content views, content scheduling, and previewing entries in the API Playground. You can also reload content, manage notifications, and collaborate with your team. Learn more.

What is the API Playground and how can I use it?

The API Playground is an interactive environment where you can test GraphQL queries and mutations against your Hygraph project. It helps you experiment with data retrieval and manipulation before integrating with your application. Read more.

How do I manage assets in Hygraph Studio?

You can upload, store, and manage digital assets (such as images and documents) in the Assets Manager. Assets can be organized with metadata fields and accessed via default or custom views. For more, see the Assets Manager section.

What is the purpose of the Analytics dashboard in Hygraph Studio?

The Analytics dashboard provides an overview of all your projects, allowing you to monitor usage, plan details, and API call statistics across multiple projects. You can customize which columns to display, such as owner, plan, region, billing period, API calls, asset traffic, content models, components, remote sources, taxonomies, content entries, locales, seats, and workflows.

What is the AI Assist feature in Hygraph Studio?

AI Assist is available for enabled projects and helps editors generate, improve, and localize content directly within the content entry experience, without leaving the editor. This streamlines content creation and localization workflows. Learn more.

Technical Requirements & Security

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for its hosting infrastructure, and GDPR compliant. These certifications ensure enhanced security and compliance standards for all users. See security details.

What security features are available in Hygraph Studio?

Hygraph provides granular permissions, SSO integrations, audit logs, encryption (at rest and in transit), and regular backups. Enterprise-grade compliance features include dedicated hosting, custom SLAs, and support for GDPR and CCPA. For more, see the security features page.

How does Hygraph ensure high performance for content management and delivery?

Hygraph delivers high performance through features like Smart Edge Cache for faster content delivery, high-performance endpoints, and continuous improvements to its GraphQL API. Developers can monitor and optimize API usage for best results. Read about performance improvements.

Support & Implementation

What support options are available for Hygraph users?

Hygraph offers 24/7 support via chat, email, and phone. Users can also access real-time troubleshooting through Intercom chat, join the community Slack channel, and consult extensive documentation and training resources. Enterprise customers receive a dedicated Customer Success Manager (CSM) and structured onboarding. See documentation.

How easy is it to get started with Hygraph Studio?

Hygraph is designed for easy onboarding. Users can start immediately with the free API Playground and a free developer account. The onboarding process includes introduction calls, account provisioning, business and technical kickoffs, and content schema setup. Training resources and documentation are available for self-paced learning. Learn more.

How long does it take to implement Hygraph?

Implementation time varies by project scope. For example, Top Villas launched a new project within 2 months, and Si Vale met aggressive deadlines during their initial implementation. The platform's structured onboarding and training resources help accelerate adoption. See case studies.

What training resources are available for new users?

Hygraph provides webinars, live streams, how-to videos, and extensive documentation for onboarding and ongoing training. Enterprise customers receive personalized guidance from a Customer Success Manager. Access documentation.

How does Hygraph handle maintenance, upgrades, and troubleshooting?

Hygraph is a cloud-based platform, so all deployment, updates, security, and infrastructure maintenance are managed by Hygraph. Upgrades are seamless and require no manual intervention. Troubleshooting is supported by 24/7 support, Intercom chat, community Slack, and detailed documentation. Learn more.

Use Cases & Benefits

Who can benefit from using Hygraph Studio?

Hygraph is ideal for developers, product managers, and marketing teams in industries such as ecommerce, automotive, technology, food and beverage, and manufacturing. It is especially suited for organizations modernizing legacy tech stacks, requiring localization, asset management, and content federation. Try Hygraph.

What problems does Hygraph solve for its users?

Hygraph addresses operational inefficiencies (eliminating developer dependency, modernizing legacy stacks), financial challenges (reducing costs, accelerating speed-to-market), and technical issues (simplifying schema evolution, integration, and performance). It also improves localization, asset management, and content consistency for global teams. See more on KPIs.

What are some customer success stories with Hygraph?

Customers like Komax achieved a 3X faster time-to-market, Autoweb saw a 20% increase in website monetization, Samsung improved customer engagement by 15%, and Stobag increased online revenue share from 15% to 70%. Explore more customer stories.

What KPIs and metrics are associated with Hygraph's solutions?

Key KPIs include time saved on content updates, system uptime, speed of deployment, content consistency, user satisfaction scores, reduction in operational costs, time-to-market, maintenance costs, and scalability metrics. See the CMS KPI blog.

Project Management & Actions

How do I create and manage models, fields, and components in Hygraph?

You can create models and add fields in the Schema Builder. Components can be added as reusable templates. For step-by-step instructions, see the guides on creating models, adding fields, and using components.

How do I manage roles, permissions, and team members?

Roles and permissions can be managed in Project Settings, allowing you to create efficient workflows and build independent teams. You can also add team members and assign roles. See the roles and permissions guide and team management guide.

How do I clone, share, or delete a project in Hygraph?

You can clone your project, enable public cloning for sharing, or delete your project from Project Settings. For instructions, see the guides on cloning projects, sharing projects, and deleting projects.

How do I manage environments, locales, and billing information?

Project Settings allow you to manage multiple environments, add locales for multilingual content, and update billing information. See the guides on environments, locales, and billing.

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

#App walkthrough

Welcome to our Hygraph app walkthrough. This document explains how you can navigate through the app. At the end of the document, you'll find a section that lists and describes actions and where they are located in the app.

#Overview

As soon as you log in to your Hygraph Account, you land in your project directory. Here you can find the following tabs at the top:

  • Projects
  • Your apps
  • Analytics

At the top right of the screen, you will find a link to contact support and your account settings.

Contact support & Account settingsContact support & Account settings

#Projects

The Projects tab contains the following:

  • Project invites: If you have any invites pending acceptance, you will find them at the top of the page. Project inviteProject invite
  • Projects: If you have any projects, you will find a card for each here.
  • Starters: Scroll down the screen to find our starter projects. Project directoryProject directory

#Your apps

If you have created any apps, you will find them in the Your apps tab.

Your appsYour apps

#Analytics

On the Analytics tab, you can get a quick overview of all the projects that you have access to. The dashboard lets you monitor usage, plan details, and API call statistics across multiple projects in the master environment in a single view.

You can perform the following tasks on this dashboard:

  • Click Open next to the project name to access the project.

  • Customize the list of projects that you want to display.

  • Select Adjust columns to customize which columns you want to display. The following columns are available:

    • Owner of the project
    • Plan
    • Region
    • Billing period
    • API calls
    • Asset traffic
    • Content models
    • Components
    • Remote sources
    • Taxonomies
    • Content entries
    • Locales
    • Seats
    • Workflows

AnalyticsAnalytics

#Project homepage

The homepage is the section of a project you land on when you first create it, and every time you access it after that. It contains widgets that help you easily navigate to your recently updated schema elements, find useful documentation, or access our video content.

#Top bar

Hygraph Studio - Top barHygraph Studio - Top bar

Top Bar sectionWhat you can do
1. Project & EnvironmentSee the current project and environment you are working in. Hover over to view the plan information and use the dropdown to switch projects or environments.
2. Trial indicatorView plan details, such as Hobby or 30-day trial. Click here to open the plan picker and upgrade seamlessly within the app.
3. Command menuDisplays a set of actions depending on where you are in Studio.
4. Content finderSearch for content across all entries in your environment.
5. Recently viewedCheck out your recently viewed entries here.
6. AI Assist (Available for enabled projects only)Helps editors generate, improve, and localize content seamlessly within the content entry experience, without needing to leave the editor.
7. HelpDocumentation on concepts, code examples, reference apps, features etc, a link to join Hygraph's Slack community.
8. Contact SupportContact our Support teams to resolve any issues you might have.
9. NotificationsView system notifications, updates, and alerts related to your project and environment.
10. ProfileView your account settings and log out of Hygraph Studio.

#App sections

Hygraph Studio - App sectionsHygraph Studio - App sections

App sectionWhat you can do
1. Hygraph StudioSee a list of projects, your apps, and an overview of your projects.
2. HomeYour project homepage.
3. SchemaSetup of the content models as required by your project.
4. ContentAccess existing content, create custom content views, create/ edit content, review content, and publish content.
5. AssetsTab to manage and upload your assets.
6. API PlaygroundAn API playground where you can test out API calls.
7. AppsA section to manage apps.
8. WebhooksA section to manage webhooks.
9. Project SettingsDetails about project information, API access, billing, environments, locales and members

#Schema builder

Your schema is defined by the models you create, and fields you add. It is the backbone of your Hygraph project. In the Schema builder, you'll define the structure of your content by adding fields, creating relationships between models, and much more.

#Content editor

The Content editor is where you create, edit, publish and unpublish content using the structure of the schema you previously created.

The Content editor presents default and custom views for you to access your project's contents. It also allows the possibility of reloading your content, previewing it in the API Playground, or viewing the model.

#Assets manager

Assets is where you upload and store documents to be used in your content entries. The Assets tab presents default and custom views for you to access your uploaded assets.

#API Playground

You can use the API Playground to test out API calls, by experimenting with querying and mutating data.

#Mutations

Look into mutating data in our API Playground.

#Endpoints & permissions

Find your endpoints in the UI by navigating to your project settings and learn about permissions.

#Other features

FeatureDescription
NotificationsThe Notifications section informs you of comments assigned to you in content entries. If you have unread comments, a red mark will appear on the bell icon. This section picks up notifications from all your Hygraph projects.
AppsThe Apps section is where you can configure or uninstall apps from your project. Each installed app will display in a card, where you will have the option of editing its configuration by clicking on the pencil icon, or uninstalling it by clicking on the trash icon. The configuration options depend on the app, they are the ones you initially set up during installation. You can also find a link to our Marketplace at the top, where you can browse the apps you can install.
WebhooksIn the Webhooks section, you can add webhooks to your project's deployment according to triggers you can configure. This section displays each webhook in a card, with options to edit its configuration, view its logs, and delete it.
Project settingsThis is where you can access your project's global information, and manage its settings. This screen contains both, general and access settings.

#Where do I...?

ActionWhere in HygraphDescription
Create a modelSchema BuilderYour schema is the content structure of your project. You can define your schema by creating models and adding fields to them.
Add fields to my modelSchema BuilderYou can add fields to your models to define your project schema.
Customize my sidebarSchema BuilderYou can configure schema sidebar adding and/or removing system and custom widgets.
Add componentsSchema BuilderYou can create components to use them as flexible, reusable templates where you define the fields once - in the Schema - and then fill them with different content every time you use the component in a content entry.
Add remote sourcesSchema BuilderYou can use remote sources to add content from other systems and sources to the Hygraph API without having to migrate the content itself.
Add enumerationsSchema BuilderYou can use enumerations to group values within a type, or to create a list of values, which can then be used when adding a dropdown field to your models.
Schedule publishingContent EditorYou can schedule content publishing, and unpublishing as single entries, or group them as part of a release.
Create contentContent EditorYou can create content entries based on the models you created in your schema.
Publish contentContent EditorYou can publish content so it can be consumed by others.
Update contentContent EditorYou can update content you've already created, whether it's been published or not.
Duplicate contentContent EditorYou can easily duplicate content, which saves time during content creation of similar entries.
Delete contentContent EditorYou can delete content entries individually or in bulk, and you can also delete related content.
Access created contentContent EditorYou can navigate to the content editor to access your content. This experience can be customized.
Add an asset entryDigital Assets ManagerYou can upload assets and add metadata to them, providing you've added metadata fields to the Assets model.
Upload assetsDigital Assets ManagerYou can quickly upload assets from different sources into the CMS.
Work with assetsDigital Assets ManagerYou can work with your assets table in a similar way as you would with content entries in the Content editor.
Manage notificationsNotificationsYou can use our commenting feature to manage notifications and work collaboratively with your team.
Install integrated appsAppsYou can install apps from our Marketplace in your Hygraph project to enhance its capabilities.
Configure webhooksWebhooksYou can configure webhooks to trigger actions in your project.
Manage my project's global informationProject settingsYou can access your project settings to edit your project details, clone your project, enable public cloning and even delete your project.
Clone my projectProject settingsYou can create a copy of your project's master environment by cloning it.
Delete my projectProject settingsYou can delete your project from project settings.
Share my projectProject settingsYou can enable public cloning to share a link that other people can use to clone your project.
Manage my project environmentsProject settingsYou can use different environments to safely work on isolated instances of your project.
Manage audit logsProject settingsYou can access audit logs to see all changes inside of your project. They contain both changes in the schema and content.
Manage my project's content stagesProject settingsYou can manage your content stages to create custom workflows.
Manage my project's localesProject settingsYou can add locales to include content in different languages.
Manage your billing informationProject settingsYou can update your billing information by accessing your project settings.
Manage API accessProject settingsYou can manage API access from your project settings. Manage your endpoints, content API permissions, and permanent auth tokens.
Manage roles and permissionsProject settingsYou can manage roles and permissions to create efficient workflows and build independent teams.
Manage team membersProject settingsYou can add members to your Hygraph project and overview the roles they have been assigned to.