Announcing the Official Hygraph Integration for Gatsby Cloud!

We've just rolled out the native Hygraph - Gatsby Cloud integration!

Ronak Ganatra
Jonathan Steele
Gatsby Cloud Integration with Headless CMS

For all our users building their projects on Gatsby Cloud, we're thrilled to announce our official native integration for Gatsby Cloud!

About the IntegrationAnchor

The Gatsby Cloud integration allows you to seamlessly update your static deployments at the push of a button from within Hygraph itself! Not to be confused with triggered builds via webhooks, this integration allows you to install a button in the Hygraph sidebar of a content model for manual redeploys.

What can you do with the Gatsby Cloud integrationAnchor

  • Preview content changes using lightning fast CMS Preview builds. Any content changes on the Draft stage will automatically be updated and ready to preview in seconds.
  • Incremental production builds that only rebuild the required changes. This results in faster builds and deployments for Hygraph content on your Published stage.

Requirements to use the Hygraph-Gatsby Cloud IntegrationAnchor

  • You have a Hygraph project. If not, create a free project!
  • You have a pre-existing Gatsby project that uses gatsby-source-hygraph on GitHub or GitLab.
  • You are familiar with creating a Gatsby Cloud site from an existing GitHub or GitLab repository. Read this guide for instructions on how to do this.

Give it a spinAnchor

Step 1: Create a new Gatsby Cloud siteAnchor

If you have a pre-existing Hygraph powered Gatsby site in Gatsby Cloud, you can skip to step 2.

Create a new site by importing your pre-existing Gatsby project from a GitHub repository. Follow along for instructions on how to do this.

You will be asked to provide your environment variables required for your Gatsby site to build. This includes:

  • Your Hygraph project URL (required).
  • If configured, a PAT (Permanent Auth Token) for the project. We recommend using PATs.

After configuring this, your new Gatsby Cloud site will build for the first time, and be accessible in your dashboard.

Step 2: Adding required Gatsby Cloud site valuesAnchor

To enable the integration within Hygraph, you'll need some details from your initialized Gatbsy Cloud project.

Form the Gatsby Cloud dashboard, go to the site you want to work with, click Site Settings.

Make note of your project’s Prefix as that will be needed for the Hygraph setup.

Gatsby Cloud project fields.png

Now navigate to the Webhook section. In order to trigger new Gatsby Cloud builds for both the production and Preview instances, we need both the Preview Webhook and Builds Webhook URLs. These will be required during the Gatsby Cloud integration setup.

Be sure to check that CMS Preview builds are enabled for your Gatsby Site project. This can be done in the Preview section of the Site Settings page. This is required!

Gatsby Cloud enable CMS Previews.png

Step 3: Configure Gatsby Cloud for HygraphAnchor

Hygraph Gatsby Cloud integration.png

In your Hygraph project dashboard, navigate to Settings and then Integrations. From here click Gatsby Cloud and then Enable.

Hygraph Gatsby Cloud enable.png

Populate the form fields with the values from your Gatsby Cloud site and click Enable.

Hygraph Gatsby Cloud configuration.png

Step 4: You're set!Anchor

Enjoy automated Preview builds and incremental deploys! Once successfully enabled, your project will:

  • Trigger a Gatsby Cloud CMS Preview build whenever you save Draft content changes.
  • Trigger a Gatsby Cloud incremental build deployment whenever you push content changes to the Published stage.

Hygraph Gatsby Cloud preview button.png

Your content editing experience will now include a preview button direct to your Gatsby Cloud CMS Preview instance. CMS Preview builds are fast and the instance should automatically update in seconds.

  • Ronak Ganatra
  • Jonathan Steele
  • Carlos Rufo
  • Previous
  • Next

Related articles