Get the latest insights, best practices, and tips from power users

Hygraph
Docs

Working with Hygraph

Hygraph is the Headless CMS allowing you to build digital experiences the way you envisioned them - with all your backends, frontends, and services, working together in harmony.

Hygraph gives you instant GraphQL Content APIs to create, enrich, unify, and deliver your content across platforms.

#Getting started basics

You can get started with Hygraph by following the Getting Started Basics which will walk you through:

#Content modeling

At the core of every project is the schema. It's important your schema is carefully structured, and designed modelled around the content you will be storing.

We've got a guide on the basics of content modeling, and how Hygraph gives you all the tools to structure your content.

Learn more about content modeling

#Going beyond the basics

Once you've completed our getting started tutorial, you will want to explore our growing list of code examples, tutorials, and more.

#What is a headless CMS?

If you're new to the concept of Headless CMS then you should read our academy article. It'll take less than 5 minutes.

#Section contents

This section offers a contents map to help you readily find what you're looking for.

#Project guides

DocumentContents
Project informationContains information about managing your project's global information. In this document you will find information about your project details, how to clone a project, share it or delete it.
EnvironmentsContains information about managing your project's environments. In this document you will find information about creating, switching and deleting environments, as well as promoting an environment to master.
Multiple environmentsContains information about working with multiple environments, such as the reasons to do this, setting up a development environment, maintaining changes that happened while in development, and promoting an environment to master.
Roles and permissionsContains information about managing the roles and permissions of your project. In this document you will find information about system and custom roles, adding and removing users to roles, and examples on different setups for your project.
Audit logsContains information about working with audit logs, which allow you to see all changes inside your project. In this document you will find information about accessing audit logs, event fields, logged resources, logged actions, and filtering logs.
Display settingsContains information about the display settings that editors can use to alter the width of the fields when editing content, as well as collapse, or expand all fields for focusing viewing.
Update your passwordContains information about how to update your password.
Update billingContains information about how to update your billing information.
Clone your projectContains information about how to clone your project. In this document you will also find some additional information on cloning limitations.
Share your projectContains information about how to share your existing project's master environment as a template with others.
LocalesContains information about managing your project's locales.
Team membersContains information about managing team members in a project.
CommentingContains information about our commenting feature. In this document you will find information about notifications and comments.
WorkflowsContains information on how to set up approval workflows using 2 and 3 content stages.

#Schema guides

DocumentContents
ComponentsContains information about components, which are a pre-defined set of fields that can be reused across models and content entries. In this document you will find information on how to create and add components to a field, how to use components in content entries, how to query components, how to create and use nested components, and how to decide between components and relations.
ReferencesContains information about the configuration of reference fields, and the different types available.
Components or referencesContains information that can help you decide whether to use a component or a reference in your project schema.
EnumerationsContains information about working with enumerations, which can be used to group values within a type. In this document you will find information on creating, adding, deleting, and using enumerations.
Field validationsContains information about field validations.
Preview URLsContains information about working with preview URLs, which are automatically generated links that allow you to preview content in your frontend before it's published. In this document you will find information on how to create, define, and delete a preview URL.
Remote sourcesContains information about Remote Sources, which is our content federation utility. With Remote sources, it's possible to add content from other systems and sources to the Hygraph API without having to migrate the content itself.
Remote content & dataContains information about using remote fields to fetch external data. Use this document to learn about remote fields in the context of a regular model, and top level remote fields, which fetch data unrelated to Hygraph.
Reserved termsContains a list of reserved terms. Attempting to use these terms will result in a warning, informing you that you must use a different word instead.
Slug fieldContains information about working with the slug field. In this document you will find information on how to configure the slug field to be generated from other field values in your model.

#Content guides

DocumentContents
Accessing contentContains information about accessing created content.
Configuring columnsContains information about configuring columns in order to declutter your content dashboard by hiding information that is not relevant to you.
Searching for contentContains information about using the search feature in our content dashboard.
Using filtersContains information about using filters in order to restrict the content shown by specific parameters.
Content viewsContains information about default and custom content views. In this document you will find information on how to update default views, how to create/edit/delete/organise custom views, and how to create/edit/delete view groups.
Creating contentContains information about creating content as well as connecting related content.
Updating contentContains information about updating content as well as sorting related content.
Deleting contentContains information about deleting content as well as removing related content.
Duplicating contentContains information about duplicating content and relations.
Publishing contentContains information about publishing content. You will also find information on outdated content and on editing published content.
Content stagesContains information about Hygraph's default content stages and about creating custom content stages.
Versioning contentContains information about versioning content, which allows you to view the evolution of the project's published content.
Content localizationContains information about content localization, which is supported as a core feature in Hygraph. In this document you will find information on adding translations and showing/hiding fields.
Scheduled publishingContains information about scheduling content to be published or unpublished. In this document you will find information on how to schedule items or releases, how to create a release, and scheduling limitations.
Customize sidebarContains information about customizing your sidebar by adding, removing or reordering widgets.
Rich Text editorContains information about Hygraph's Rich Text editor, which provides great flexibility when it comes to creating, editing, and manipulating content entries showcasing text and images.

#Asset guides

DocumentContents
Add asset entryContains information about adding asset entries, which allows adding metadata to your asset.
Upload assetContains step by step information about the asset upload process.
Work with assetsContains information about working with assets.

#Webhooks

DocumentContents
OverviewContains general information about the use of webhooks with Hygraph, such as configuring webhooks, viewing logs, and editing or deleting webhooks.
Deploy your Vercel projectContains all the necessary information to deploy your Vercel project using webhooks.
Deploy your Gatsby projectContains all the necessary information to deploy your Gatsby project using webhooks.