Frequently Asked Questions

Webhooks & Technical Configuration

What is a webhook in Hygraph and how does it work?

A webhook in Hygraph is a feature that sends a signal whenever a specific event occurs, such as publishing content. It acts as a notification that can trigger actions like rebuilding your frontend or deploying updates. For example, when you publish a product entry, the webhook can automatically trigger a rebuild of your storefront on platforms like Netlify or Vercel. Learn more.

How do I configure a webhook in Hygraph?

To configure a webhook in Hygraph, navigate to the Webhooks section of your project and click Add. Fill in the required fields such as Name, Description, Method (usually POST), URL (your build hook from Netlify or Vercel), and optionally a secret key for payload signing. Select the triggers (Models, Stages, Actions, Sources) that should activate the webhook. For example, you might select the Product model and PUBLISHED stage. Optionally, configure headers. Save the webhook to activate it. See step-by-step instructions.

How do I set up a build hook in Netlify for Hygraph webhooks?

To set up a build hook in Netlify: Go to your site in Netlify, navigate to Site configuration > Build & deploy > Continuous deployment > Build hooks, and click Add a build hook. Name your hook (e.g., "Deploy from Hygraph"), select the branch to build (usually main), and click Save. Copy the generated URL and paste it into the Hygraph Webhook modal's URL field. Full instructions here.

How do I configure a webhook in Hygraph for Hugo or Vercel site deployment?

For Hugo or Vercel deployments, create a webhook in Hygraph and paste the Vercel deploy hook URL into the URL input field. Configure triggers with the content model and stage that should initiate a re-deploy. For Hugo, this ensures the site rebuilds automatically whenever new content is published or updated in Hygraph. For Vercel, follow the step-by-step guide.

How can I configure webhooks for workflows in Hygraph?

To configure webhooks for workflows, select the Include payload checkbox to deliver detailed payloads, including the workflow step (workflowStep). Under Actions, select Transition Step to trigger the webhook whenever the workflow transitions to a new step. See the workflow configuration guide.

Features & Capabilities

What integrations does Hygraph support?

Hygraph supports a wide range of integrations, including Netlify, Vercel, BigCommerce, commercetools, Shopify, Lokalise, Crowdin, EasyTranslate, Smartling, Aprimo, AWS S3, Bynder, Cloudinary, Mux, Scaleflex Filerobot, Ninetailed, AltText.ai, Adminix, and Plasmic. See the full list of integrations.

Does Hygraph provide an API?

Yes, Hygraph provides a powerful GraphQL API for efficient content fetching and management. Learn more about the API.

What are the key capabilities and benefits of Hygraph?

Hygraph offers GraphQL-native architecture, content federation, scalability, and rapid content delivery. Benefits include faster speed-to-market, control at scale, lower total cost of ownership, and improved user experience. See more features.

How does Hygraph optimize content delivery performance?

Hygraph emphasizes optimized content delivery performance, ensuring rapid content distribution and responsiveness. This leads to improved user experience, higher engagement, and better search engine rankings by reducing bounce rates and increasing conversions. Read more about performance.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant, ISO 27001 certified, and GDPR compliant. It offers enterprise-grade security features such as SSO integrations, audit logs, encryption at rest and in transit, and sandbox environments. See security features.

Pricing & Plans

What is Hygraph's pricing model?

Hygraph offers a free forever Hobby plan, a Growth plan starting at $199/month, and custom Enterprise plans. See pricing details.

Use Cases & Customer Success

Who can benefit from using Hygraph?

Hygraph is ideal for developers, IT decision-makers, content creators, project/program managers, agencies, solution partners, and technology partners. It serves modern software companies, enterprises seeking to modernize, and brands aiming to scale across geographies or re-platform from traditional solutions. See case studies.

What industries are represented in Hygraph's case studies?

Hygraph's case studies span industries such as food and beverage, consumer electronics, automotive, healthcare, travel and hospitality, media and publishing, eCommerce, SaaS, marketplace, education technology, and wellness and fitness. Explore case studies.

Can you share specific customer success stories using Hygraph?

Yes. Komax achieved a 3X faster time to market, Autoweb saw a 20% increase in website monetization, Samsung improved customer engagement with a scalable platform, and Dr. Oetker enhanced their digital experience using MACH architecture. See more success stories.

Who are some of Hygraph's customers?

Hygraph is trusted by companies such as Sennheiser, Holidaycheck, Ancestry, Samsung, Dr. Oetker, Epic Games, Bandai Namco, Gamescom, Leo Vegas, and Clayton Homes. See customer logos and stories.

Getting Started & Implementation

How easy is it to get started with Hygraph?

Hygraph is designed for easy onboarding, even for non-technical users. You can sign up for a free account and use resources like documentation, video tutorials, and onboarding guides. For example, Top Villas launched a new project in just 2 months. Get started here.

What training and technical support does Hygraph offer?

Hygraph provides 24/7 support via chat, email, and phone. Enterprise customers receive dedicated onboarding and expert guidance. All users have access to documentation, video tutorials, webinars, and a community Slack channel. Contact support.

How long does it take to implement Hygraph?

Implementation is fast and straightforward. For instance, Top Villas launched a new project in just 2 months from initial contact. The platform is praised for its ease of use and intuitive interface. Read the Top Villas case study.

Pain Points & Solutions

What problems does Hygraph solve?

Hygraph addresses operational pains (reliance on developers, outdated tech stacks, global team conflicts, clunky content creation), financial pains (high costs, slow speed-to-market, expensive maintenance, scalability challenges), and technical pains (boilerplate code, overwhelming queries, evolving schemas, cache and OpenID integration issues). See detailed solutions.

How does Hygraph solve pain points for different personas?

For developers, Hygraph reduces boilerplate code and streamlines query management. For content creators and project managers, it offers an intuitive interface for independent content updates. For business stakeholders, it lowers operational costs, accelerates speed-to-market, and supports scalability. See persona-specific solutions.

What KPIs and metrics are associated with the pain points Hygraph solves?

Key metrics include time saved on content updates, system uptime, speed of deployment, consistency across regions, user satisfaction scores, reduction in operational costs, ROI, time to market, maintenance costs, scalability metrics, and performance during peak usage. See more on CMS KPIs.

Documentation & Learning Resources

Where can I find technical documentation for Hygraph?

Comprehensive technical documentation is available at Hygraph Documentation, covering everything from setup to advanced integrations.

What improvements have been made to Hygraph's documentation?

Hygraph's documentation has been revamped for a cleaner look, better organization, and consolidated API references and guides, enhancing usability and user experience. Read about documentation updates.

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

#8.1 Webhooks

#Overview

A webhook is a feature that sends a signal whenever a specific event occurs. Think of it as a notification that triggers actions. We are going to configure a webhook that will trigger published content displaying in our frontend.

#Configure a webhook

First, we're going to navigate to the Webhooks section of our project, and click on the Add button.

A screen will pop up, let's complete it using the following information:

FieldInput
NameThis is the name of our webhook, we'll call it “Deploy to Storefront”.
DescriptionThis is the description for our webhook. We'll write “Trigger published”.
Include payloadThis enabled switch means that data will be sent via the webhook. We'll leave it as it is.
MethodWe'll use the dropdown to select the POST method.
URLThis is our webhook URL or build hook. Right below this table, you'll find an explanation of how to generate this in your Netlify account right under this table.
Secret keyAdd an optional secret key to sign the payload of our webhook, to allow the other end to check that the source is genuine.
TriggersThis is where we select which Models, Stages, Actions and Sources should trigger your webhook. Since we want to be able to preview our product entry drafts, we'll use the Content model dropdown to select the Product model, and the Stage dropdown to select PUBLISHED.
We won't select anything under Actions and Sources, because we don't want to limit them.
HeadersOptionally configure headers by adding additional Key and Value data, we will leave this blank.

Click Add at the top of the screen to save your webhook. Your saved webhook should look something like this:

Webhook detailsWebhook details

Once saved, you should see your webhook on the main screen.

Webhook on the main screenWebhook on the main screen

You can test your new webhook by adding a new product content entry and publishing. When you click Publish, the webhook will automatically trigger Netlify rebuild your storefront!

To setup a deployment to Vercel, follow our step-by-step guide on how to deploy to Vercel using Hygraph Webhooks.

 

You've reached the end of the tutorial! Let's look into our wrap-up lesson:

Getting Started project wrap-up