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:
- Creating your first project
- Creating a model
- Adding fields to a model
- Creating content
- Publishing content
- Querying content
- Mutating content
- Enabling API access
#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
| Document | Contents |
|---|---|
| Project information | Contains 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. |
| Environments | Contains 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 envrironment to master. |
| Multiple environments | Contains 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 permissions | Contains 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 logs | Contains 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 settings | Contains 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 password | Contains information about how to update your password. |
| Update billing | Contains information about how to update your billing information. |
| Clone your project | Contains information about how to clone your project. In this document you will also find some additional information on cloning limitations. |
| Share your project | Contains information about how to share your existing project's master environment as a template with others. |
| Locales | Contains information about managing your project's locales. |
| Team members | Contains information about managing team members in a project. |
| Commenting | Contains information about our commenting feature. In this document you will find information about notifications and comments. |
#Schema guides
| Document | Contents |
|---|---|
| Components | Contains 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. |
| Enumerations | Contains 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 validations | Contains information about field validations. |
| Preview URLs | Contains 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. |
| References | Contains information about the configuration of reference fields, and the different types available. |
| Remote content & data | Contains 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. |
| Remote sources | Contains 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. |
| Reserved terms | Contains 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 field | Contains 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
| Document | Contents |
|---|---|
| Accessing content | Contains information about accessing created content. |
| Configuring columns | Contains information about configuring columns in order to declutter your content dashboard by hiding information that is not relevant to you. |
| Searching for content | Contains information about using the search feature in our content dashboard. |
| Using filters | Contains information about using filters in order to restrict the content shown by specific parameters. |
| Content views | Contains 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 content | Contains information about creating content as well as connecting related content. |
| Updating content | Contains information about updating content as well as sorting related content. |
| Deleting content | Contains information about deleting content as well as removing related content. |
| Duplicating content | Contains information about duplicating content and relations. |
| Publishing content | Contains information about publishing content. You will also find information on outdated content and on editing published content. |
| Content stages | Contains information about Hygraph's default content stages and about creating custom content stages. |
| Versioning content | Contains information about versioning content, which allows you to view the evolution of the project's published content. |
| Content localization | Contains 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 publishing | Contains 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 sidebar | Contains information about customizing your sidebar by adding, removing or reordering widgets. |
| Rich Text editor | Contains 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
| Document | Contents |
|---|---|
| Add asset entry | Contains information about adding asset entries, which allows adding metadata to your asset. |
| Upload asset | Contains step by step information about the asset upload process. |
| Work with assets | Contains information about working with assets. |
#Webhooks
| Document | Contents |
|---|---|
| Overview | Contains general information about the use of webhooks with Hygraph, such as configuring webhooks, viewing logs, and editing or deleting webhooks. |
| Deploy your Vercel project | Contains all the necessary information to deploy your Vercel project using webhooks. |
| Deploy your Gatsby project | Contains all the necessary information to deploy your Gatsby project using webhooks. |