Frequently Asked Questions

Webhooks & Static Build Deployment

How can I automatically deploy my Vercel project when content changes in Hygraph?

You can use Hygraph webhooks to trigger automatic deployments of your Vercel project whenever content changes. By configuring a webhook in Hygraph with your Vercel deploy hook URL, deployments are initiated based on specified content model, stage, and actions. Learn more in the official guide.

What steps are required to set up a deploy hook in Vercel for Hygraph?

Inside your Vercel project Git settings, go to the "Deploy Hooks" section. Specify a name and the Git branch for deployment. After creating the hook, copy the URL for use in Hygraph. See step-by-step instructions.

How do I configure a webhook in Hygraph to trigger Vercel deployments?

In your Hygraph project, create a new webhook and paste your Vercel deploy hook URL into the URL field. Configure triggers by selecting content models, stages (e.g., Published), and actions that should initiate the deployment. Read the configuration guide.

Can I trigger deployments for specific content models or stages in Hygraph?

Yes, you can specify one or more content models and stages (such as Published or Draft) in your webhook configuration. This allows you to control which changes trigger deployments. See details.

What happens after I publish content in Hygraph with a Vercel webhook configured?

When you publish content in Hygraph, the configured webhook triggers a new deployment in your Vercel project. You will see a new build appear in your Vercel deployments list. Learn more.

Are Hygraph webhooks environment specific?

Yes, Hygraph webhooks are configured per environment. If your project uses multiple environments, you need to set up webhooks for each one individually. Read more.

Should I share my Vercel deploy hook URLs?

No, you should never share your Vercel deploy hook URLs, as they are public and do not require authentication to call. Keep them private to prevent unauthorized deployments. See security note.

Can I deploy different content stages (e.g., Draft) to separate environments?

Yes, you can deploy custom content stages such as Draft to separate environments by duplicating your Vercel project and connecting it to the same repository. Repeat the webhook setup for each environment. Learn how.

What actions can trigger a Vercel build via Hygraph webhooks?

You can configure Hygraph webhooks to trigger Vercel builds on actions such as content being published or unpublished. Leaving the action field empty will trigger deployments for any action. See configuration options.

How do I verify that my webhook-triggered deployment was successful?

After publishing content in Hygraph, check your Vercel deployments list for a new build. This confirms that the webhook successfully triggered the deployment. See verification steps.

Can I disable the payload in Hygraph webhook configuration?

Yes, when configuring your webhook in Hygraph, you can choose to disable including the payload if it is not needed for your deployment process. Read more.

What is the recommended workflow for deploying content changes using Hygraph and Vercel?

The recommended workflow is to set up a Vercel deploy hook, configure a Hygraph webhook with the deploy hook URL, specify triggers, and publish content in Hygraph to initiate deployments automatically. See workflow details.

Where can I find the official documentation for deploying Vercel projects with Hygraph webhooks?

The official documentation is available at Hygraph Docs: Deploy your Vercel project.

Is it possible to deploy Gatsby projects using Hygraph webhooks?

Yes, Hygraph supports deploying Gatsby projects via webhooks. You can find the guide at Deploy your Gatsby project.

What is the purpose of the 'Save and publish' button in Hygraph?

The 'Save and publish' button in Hygraph allows you to finalize content changes and trigger webhook-based deployments, such as initiating a new build in Vercel.

Can I use Hygraph webhooks for other deployment platforms besides Vercel?

Yes, Hygraph webhooks can be configured to trigger deployments on other platforms that support webhook-based deployment, such as Gatsby. Refer to the relevant guides for each platform.

What should I do if my webhook deployment fails?

If your webhook deployment fails, review your webhook configuration in Hygraph and your deploy hook settings in Vercel. Ensure URLs are correct and triggers are properly set. Consult the documentation for troubleshooting steps.

Can I automate deployments for multiple branches in Vercel using Hygraph webhooks?

Yes, you can create multiple deploy hooks in Vercel for different branches and configure corresponding webhooks in Hygraph to automate deployments for each branch.

How do I manage webhooks for projects with multiple environments in Hygraph?

For projects with multiple environments, set up individual webhooks for each environment in Hygraph to ensure deployments are triggered appropriately for each context.

Features & Capabilities

What are webhooks and how do they work in Hygraph?

Webhooks in Hygraph are user-defined HTTP requests triggered by specific events, such as content publication. They send payload data to another application (e.g., Vercel) in real-time, automating tasks like deployments and notifications. Read more about webhooks.

How do webhooks improve efficiency in web development?

Webhooks streamline workflows by triggering real-time updates when specific events occur, improving the efficiency of data exchange between applications and automating deployment processes. Learn more.

What are the benefits of using webhooks over APIs for deployments?

Webhooks offer real-time updating capabilities and a push-based approach, which can be more efficient for triggering deployments compared to the pull-based nature of APIs. See comparison.

What is the purpose of a webhook URL in Hygraph?

A webhook URL is used to send data from Hygraph to another application (such as Vercel) when a specific event occurs, acting as the endpoint for receiving deployment triggers. Learn more.

How can webhooks be used to automate communication between applications?

Webhooks automate communication by sending a data payload to another application when a specific event occurs in Hygraph, facilitating real-time interaction and deployment automation. Read more.

What are the components of a webhook in Hygraph?

A webhook consists of three parts: the event (action that triggers the webhook), the payload (data sent), and the endpoint (application URL that receives the webhook). See breakdown.

Why are webhooks important in modern web development?

Webhooks are crucial for automating workflows and improving integration between systems, ensuring efficient communication and real-time deployments. Learn more.

What are the benefits of using webhooks in web development?

Webhooks provide real-time updates, automate tasks, improve integration, and reduce complexity by eliminating the need for constant polling or manual data requests. See benefits.

How do webhooks work in Hygraph?

Webhooks in Hygraph work by triggering an HTTP POST request to a predefined URL whenever a specified event occurs, enabling seamless communication and automation between Hygraph and other systems. Read more.

How can webhooks improve integration between systems?

Webhooks enable real-time communication between systems, automating tasks and ensuring seamless integration for deployments and notifications. Learn more.

How do webhooks streamline workflows in Hygraph?

Webhooks streamline workflows by triggering real-time updates and automating deployment processes, reducing manual intervention and improving efficiency. See workflow benefits.

What is the difference between webhooks and APIs in Hygraph?

Webhooks use a push-based approach for real-time updates, while APIs typically require polling for changes. Webhooks are more efficient for triggering deployments and notifications. See comparison.

How do I set up webhooks for automated deployments in Hygraph?

To set up webhooks for automated deployments, create a webhook in Hygraph, specify the endpoint URL (e.g., Vercel deploy hook), configure triggers, and publish content to initiate deployments. See setup guide.

Can webhooks be used for notifications and alerts in Hygraph?

Yes, webhooks can be configured to send notifications and alerts to other systems when specific events occur in Hygraph, automating communication and workflow management. Learn more.

What are some common use cases for webhooks in Hygraph?

Common use cases include triggering deployments, sending notifications, updating records, and automating workflows between Hygraph and other applications. See use cases.

How do I secure my webhook endpoints in Hygraph?

To secure webhook endpoints, avoid sharing deploy hook URLs publicly, use authentication where possible, and restrict access to trusted systems. See security recommendations.

Can I customize the payload sent by Hygraph webhooks?

Yes, you can choose to include or disable the payload in your Hygraph webhook configuration, depending on your deployment requirements. See customization options.

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

#Deploy your Vercel project with Hygraph webhooks

If you are using Vercel for your deployments, you should check our official integration for a one-click build button. Alternatively, if you want a hands off approach, you can use Hygraph webhooks to automatically deploy when content changes.

#1. Create your deploy hook

Inside your Vercel project Git settings, scroll to the "Deploy Hooks" section. You'll want to specify the name of your hook, and the Git branch name you want to trigger a deployment for.

The name is only a reference to you, and you should never share these deployment URLs, as they're public, and don't require any authentication to call.

Vercel Deploy Hooks formVercel Deploy Hooks form

Once you've configured your hook, create it, and copy the URL.

Deploy published content on masterDeploy published content on master

#2. Configure Hygraph

Now navigate to Project Settings > AI & Automation > Webhooks in your Hygraph project, and click Add webhook.

Give your webhook a name, and paste your Vercel deploy hook URL inside the URL input. You can disable including the payload. Hygraph webhook configHygraph webhook config

Next you will want to configure the triggers which call the Vercel deploy hook. You can specify:

Content Model

You can specify one or more content models within your project that causes this webhook to trigger. If you don't specify any, then any content model will be linked to this webhook.

Stage

In some cases you may want to deploy a custom content stage such as DRAFT to a staging environment. When you need to do this, you'll most likely want to duplicate your project inside Vercel, connected to the same repo, and repeat step 1.

In this example, we'll select Published as the stage we're watching for content to be published to. This means if someone is drafting a post inside Hygraph, then our Vercel deploy hook will not be called.

Action

You can specify one or more actions to watch to trigger your Vercel build hook. In this example, we want to redeploy our Vercel project whenever content is published, or unpublished, so we'll opt to leave this field empty.

Hygraph webhook triggersHygraph webhook triggers

#3. Publish content and deploy

Now head to your content editor, make a change, and click "Save and publish". You'll then notice inside your Vercel deployments list there is a new build.

Save and publish buttonSave and publish button

That's it!