Frequently Asked Questions

Deploying Gatsby Cloud Projects with Hygraph Webhooks

How do I deploy my Gatsby Cloud project using Hygraph webhooks?

To deploy your Gatsby Cloud project with Hygraph webhooks, first ensure you have both a Hygraph and a Gatsby Cloud account and project. In Gatsby Cloud, obtain your Builds Webhook URL from Settings > Webhook. In your Hygraph project, navigate to Project Settings > AI & Automation > Webhooks and add a new webhook, pasting the Builds Webhook URL. Configure triggers, headers, and (optionally) a secret key for payload signing. When configured, publishing or unpublishing content in Hygraph will trigger a build in Gatsby Cloud. Note: The Gatsby integration is deprecated; migration to webhooks is required. Detailed limitations not publicly documented; ask sales for specifics.

What are the prerequisites for connecting Hygraph to Gatsby Cloud?

You need a Hygraph account and project, and a Gatsby Cloud account and site. For Hygraph, sign up at the signup page. For Gatsby Cloud, sign up at the Gatsby signup page. You must also have a Gatsby project (either new or imported from GitHub). Note: Webhooks are environment-specific; configuration must be repeated for each environment. Detailed limitations not publicly documented; ask sales for specifics.

How do I configure environment variables for my Gatsby Cloud site with Hygraph?

During setup, Gatsby Cloud will prompt you for environment variables. In Hygraph, go to Project settings > API access to find your Content API URL (set as HYGRAPH_ENDPOINT) and Permanent Auth Tokens (set as HYGRAPH_TOKEN). These variables are required for both build and preview environments in Gatsby Cloud. Note: If you use multiple environments, repeat this process for each. Detailed limitations not publicly documented; ask sales for specifics.

How do I migrate from the deprecated Gatsby integration to webhooks in Hygraph?

To migrate, first delete your existing Gatsby integration in the Hygraph project under Apps. Then, follow the webhook configuration process: add a new webhook in Project Settings > AI & Automation > Webhooks, and use your Gatsby Cloud Builds Webhook URL. This ensures continued deployment automation, as the Gatsby integration is no longer supported. Note: Migration steps are manual and require attention to environment-specific settings. Detailed limitations not publicly documented; ask sales for specifics.

What actions in Hygraph trigger a Gatsby Cloud build via webhooks?

Any action configured as a trigger in your webhook setup—such as PUBLISH or UNPUBLISH in the Hygraph Content Editor—will trigger a build in Gatsby Cloud. You can monitor triggered builds in Hygraph's webhook logs or in Gatsby Cloud under Master > Build history. Note: Only configured triggers will initiate builds; ensure your webhook is set up for the desired actions. Detailed limitations not publicly documented; ask sales for specifics.

Features & Capabilities

What APIs does Hygraph provide for developers?

Hygraph offers several APIs: the GraphQL Content API for querying and manipulating content, the Management API for handling project structure, the Asset Upload API for uploading files, and the MCP Server API for secure AI assistant communication. Each API is documented in detail in the API Reference documentation. Note: Some advanced features may require specific permissions or project types. Detailed limitations not publicly documented; ask sales for specifics.

What integrations are available with Hygraph?

Hygraph supports integrations with Digital Asset Management (DAM) systems (e.g., Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot), hosting and deployment platforms (Netlify, Vercel), Product Information Management (Akeneo), commerce solutions (BigCommerce), translation/localization (EasyTranslate), and more. For a full list, visit the Hygraph Marketplace. Note: Integration availability may depend on your plan or project type. Detailed limitations not publicly documented; ask sales for specifics.

What performance optimizations does Hygraph offer for content delivery?

Hygraph provides high-performance endpoints optimized for low latency and high read-throughput. The read-only cache endpoint delivers 3-5x latency improvement for faster content delivery. Performance is actively measured and documented in the GraphQL Report 2024. Note: Performance may vary based on project complexity and usage patterns. Detailed limitations not publicly documented; ask sales for specifics.

Security & Compliance

What security and compliance certifications does Hygraph hold?

Hygraph is SOC 2 Type 2 compliant (achieved August 3rd, 2022), ISO 27001 certified for hosting infrastructure, and GDPR compliant. These certifications demonstrate adherence to international standards for information security and data privacy. Note: For more details, visit the Hygraph Secure Features page. Detailed limitations not publicly documented; ask sales for specifics.

What security features are available in Hygraph?

Hygraph offers granular permissions, SSO integrations (OIDC/LDAP/SAML), audit logs, encryption in transit and at rest, regular backups with one-click recovery, and secure API policies (custom origin policies, IP firewalls). All endpoints use SSL certificates. Note: Some features may be limited to enterprise plans. Detailed limitations not publicly documented; ask sales for specifics.

Implementation & Onboarding

How long does it take to implement Hygraph and start deploying projects?

Implementation timelines vary by project complexity. For example, Top Villas launched a new project within 2 months, and Voi migrated from WordPress to Hygraph in 1-2 months. Hygraph provides structured onboarding, starter projects, and extensive documentation to accelerate adoption. Note: Large-scale or highly customized projects may require additional time. Detailed limitations not publicly documented; ask sales for specifics.

What resources are available to help new users get started with Hygraph?

Hygraph offers a Getting Started guide, structured onboarding (including intro calls and technical kickoffs), starter projects, community Slack, webinars, and comprehensive documentation. These resources support both developers and non-technical users. Note: Some resources may require registration or specific plan access. Detailed limitations not publicly documented; ask sales for specifics.

Use Cases & Business Impact

What business impact can customers expect from using Hygraph?

Customers have achieved measurable results, such as Komax realizing a 3X faster time-to-market and Samsung improving customer engagement by 15%. AutoWeb saw a 20% increase in website monetization, and Voi scaled multilingual content across 12 countries and 10 languages. Note: Results may vary by implementation and industry. Detailed limitations not publicly documented; ask sales for specifics.

What types of companies and industries use Hygraph?

Hygraph is used by enterprises and high-growth companies in SaaS, marketplace, education technology, media, healthcare, consumer goods, automotive, fintech, travel, eCommerce, government, and more. Notable customers include Samsung, Dr. Oetker, Komax, AutoWeb, BioCentury, Voi, HolidayCheck, and Lindex Group. For more, see the case studies page. Note: Suitability may depend on specific industry requirements. Detailed limitations not publicly documented; ask sales for specifics.

Customer Experience & Feedback

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

Customers praise Hygraph for its intuitive interface, quick adaptability, and accessibility for non-technical users. For example, Sigurður G. (CTO) noted the UI is intuitive, and Anastasija S. (Product Content Coordinator) highlighted instant front-end updates. Charissa K. (Senior CMS Specialist) described the UI as fast to comprehend and localizable. Note: Some advanced features may require technical expertise. Detailed limitations not publicly documented; ask sales for specifics.

Pain Points & Problems Solved

What common pain points does Hygraph address for content teams?

Hygraph addresses developer dependency, legacy tech stack modernization, content inconsistency, workflow inefficiencies, high operational costs, slow speed-to-market, scalability issues, complex schema evolution, integration difficulties, performance bottlenecks, and localization/asset management challenges. Note: Some pain points may persist depending on organizational processes or legacy system complexity. Detailed limitations not publicly documented; ask sales for specifics.

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Help teams manage content creation and approval in a clear and structured way
Hygraph
Docs
You are currently reading the Studio Docs. If you were looking for the Classic Docs check here

#Deploy your Gatsby Cloud project with Hygraph webhooks

If you are using Gatsby Cloud for your deployments, you can use Hygraph webhooks to automatically deploy when content changes.

#Prerequisites

  • You must have a Hygraph account. If you don't have one, you can create one here.
  • You must have a Hygraph project. Read this document to access further information on how to create Hygraph projects.
  • You must have an Gatsby Cloud account. If you don't have one, you can create one here.
  • You must have a Gatsby Cloud site. Read this document to access further information on how to get started with Gatsby Cloud.

#Your Gatsby Cloud site

You can use your pre-existing Hygraph powered Gatsby site in Gatsby Cloud - if you have one - or you can create a new site by importing your pre-existing Gatsby project from a GitHub repository. You can follow this guide for instructions on how to do this.

During the setup process, you will be asked to provide the necessary environment variables for your Gatsby site to build:

Environment variables in Gatsby CloudEnvironment variables in Gatsby Cloud

You will find this information in your Hygraph project by navigating to Project settings > API access.

In HygraphIn Gatsby Cloud
Content APIHYGRAPH_ENDPOINT
Permanent Auth TokensHYGRAPH_TOKEN

You will find the Content API URL under Endpoints. Scroll down to the bottom of the screen to find the Permanent Auth Tokens.

#Configure webhooks

The first thing you need to do is navigate to your Gatsby Site, go to Settings > Webhook, and copy your Builds Webhook. Follow these steps afterwards:

Configure a webhook for your Gatsby Cloud site
  1. In Your Hygraph Project, navigate to Project Settings > AI & Automation > Webhooks in your Hygraph project, and click Add webhook.
  2. The Add webhook screen will display. Complete the following information:
    • Name: Name for your webhook.
    • Description: Description for your webhook. Optional field.
    • Include payload: Switch. True by default. If true, data will be sent via the webhook.
    • Method: Dropdown menu that allows you to select an HTTP method from a list. The default value is POST, but you can also select DELETE, GET or PUT.
    • URL: Webhook URL. This is where you paste the Builds Webhook that you copied from your Gatsby Site settings.
    • Secret key: You can optionally add a secret key to sign the payload of your webhook. The secret key allows the other end to check that the source is genuine. This can be used to verify requests and, for instance, avoid triggering deploys from unknown sources.
    • Triggers: This is where you select which Models, Stages, Actions and Sources should trigger your webhook. Each item has a dropdown menu, where you can select one or more options. Selecting none acts as a wildcard, then all models will trigger the webhook. If you're a developer, this document contains some more information on triggers that might be useful to you.
    • Headers: Here you can configure your headers by adding additional Key and Value data, then clicking on the Add button. You can add multiple key-value sets, and you can delete the ones you added by clicking on the trash icon. Some endpoints require authentication using API Keys, which could be set here.

Gatsby webhook example - HeadersGatsby webhook example - Headers

#Trigger a Gatsby Cloud build from Hygraph

Once the webhook has been configured, performing one of the trigger actions will trigger a build in Gatsby Cloud.

For instance, if the trigger actions you configured for the webhook are PUBLISH and UNPUBLISH, doing either of those actions in the Content editor will trigger a new build in Gatsby Cloud.

You will be able to check the new build in your Hygraph project by checking the logs. You can also see this in your in your Gatsby Site, under Master > Build history.

#Migrate from Gatsby integration to webhooks

Follow these steps to migrate from your Gatsby integration to webhooks:

  1. In your Hygraph project, navigate to Apps and locate your Gatsby integration card.
  2. Click on the trash icon to delete.
  3. Finally, navigate to Webhooks and follow the configuration process.

#Resources