Frequently Asked Questions

Integration with Vercel

What is the Hygraph-Vercel integration and what does it enable?

The Hygraph-Vercel integration allows you to seamlessly trigger static site deployments on Vercel directly from within the Hygraph content editor. Unlike triggered builds via webhooks, this integration installs a manual build button in the Hygraph sidebar for selected content models, giving you control over when builds are triggered after content changes. Learn more.

What can I do with the Hygraph-Vercel integration?

With this integration, you can:

Source: Hygraph Docs

What are the prerequisites for using the Hygraph-Vercel integration?

To use the Hygraph-Vercel integration, you need:

Source: Hygraph Docs

How do I install the Vercel app in Hygraph?

To install the Vercel app:

  1. Go to the Hygraph Marketplace and select the Vercel app under Hosting & Deployment.
  2. Click "Install Vercel for Hygraph" and select your project.
  3. Click "Connect to Vercel" to authorize the integration on the Vercel website.
  4. Select your Vercel account and project, enter the GitHub branch name and display name, then save.
Source: Hygraph Docs

How do I add the Vercel build button to the sidebar in Hygraph?

To add the build button:

  1. Go to the Schema editor in Hygraph.
  2. Select the model you want to add the button to.
  3. Click the Sidebar tab and add the "Deploy to Vercel" widget.
  4. Edit the display name and description if desired, then create the widget.
  5. Drag and drop to reorder sidebar widgets as needed.
If you don't see the widget, perform a hard refresh (Ctrl+R or Cmd+R). Source: Hygraph Docs

How do I trigger a build on Vercel from Hygraph?

To trigger a build:

  1. Go to content editing in Hygraph.
  2. Select the model with the sidebar widget.
  3. Edit or create an entry.
  4. Click the "Start Building" button in the sidebar. The button state will change and the build will start on Vercel. You can see the last build date under the button.
Source: Hygraph Docs

What environment variables are required to connect Hygraph and Vercel?

Key environment variables include:

Source: Hygraph Docs

Can I use Hygraph starter projects with Vercel?

Yes, you can use Hygraph starter projects with Vercel. Simply select a starter in Hygraph, create your project, access the starter's GitHub repository, and use the Deploy button. Configure required environment variables as described in the documentation. Source: Hygraph Docs

Features & Capabilities

What are the key capabilities of Hygraph?

Hygraph offers:

Source: Product Page

Does Hygraph support API access and what types are available?

Yes, Hygraph provides a robust GraphQL API, including:

Implementation & Getting Started

How easy is it to get started with Hygraph?

Hygraph is designed to be super easy to set up and use, even for non-technical users. You can start building immediately by signing up for a free account. The intuitive interface and comprehensive documentation make onboarding straightforward. Source: Documentation

How long does it take to implement Hygraph?

Implementation time varies by project complexity. For example, Top Villas launched a new project within 2 months from initial contact, demonstrating Hygraph's efficiency. Source: Top Villas Case Study

What resources and support are available for onboarding and adoption?

Hygraph offers:

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified, and GDPR compliant. These certifications ensure high standards for data protection and information security. Source: Security Features

What security features does Hygraph offer?

Hygraph provides:

Source: Security Features

Support & Maintenance

What support is available for maintenance, upgrades, and troubleshooting?

Hygraph offers:

Source: Contact Page

Use Cases & Customer Success

Who can benefit from using Hygraph?

Hygraph is ideal for:

Source: DXP Report

What industries are represented in Hygraph's case studies?

Industries include:

Source: Case Studies

Can you share specific customer success stories using Hygraph?

Yes. Examples include:

See more at Case Studies.

Pain Points & Solutions

What common pain points does Hygraph address?

Hygraph helps solve:

Source: Product Page

Performance & Business Impact

What business impact can customers expect from using Hygraph?

Customers can expect:

Source: Case Studies

Customer Feedback

What do customers say about the ease of use of Hygraph?

Customers describe Hygraph as intuitive and super easy to set up, with an interface accessible to both technical and non-technical users. The customizable UI supports content quality checks and instant feedback. Some users note that managing many languages can make the interface complex. Source: Customer Feedback

Competition & Differentiation

Why choose Hygraph over other CMS solutions?

Hygraph stands out for:

Source: Product Page

Technical Documentation

Where can I find technical documentation for Hygraph and its integrations?

Comprehensive documentation is available at Hygraph Documentation, including guides for integrations, API reference, content workflows, and webhooks. Source: Docs

Supported Integrations

What integrations does Hygraph support?

Hygraph supports integrations with:

See the Integrations Documentation for details.

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

#Connect your Hygraph project to Vercel

The Hygraph 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 you can do with the Hygraph-Vercel integration

  • Trigger Vercel builds from within your content view with a single click.
  • Specify which content models display the button in the sidebar, giving you more control over how builds are triggered when there are changes to your content.

#Prerequisites to use this integration

#How to install the Vercel app

To install apps on Hygraph, you should go to our marketplace. Under the Hosting & Deployment category, you will find the Vercel app. Click on it to open the page.

  1. Click on the Install Vercel for Hygraph button to start the installation flow.

  2. In the dropdown, select which project you want to install the app in, then click on the Add App button. You should be redirected to your Hygraph project homepage.

  3. Click on the Connect to Vercel button to connect Hygraph to the project hosted on Vercel. You should be redirected to the Vercel website, where you can see information about the app and authorize the installation. Click on the Add Integration button to authorize the app.

  4. In the dropdown, select the Vercel Account to add the integration to, then click on the Continue button. You will be redirected back to the Hygraph dashboard.

  5. Now, select the Vercel project in the dropdown, enter the GitHub repository Branch name and the Display Name. Finally, click on the Save button.

Now that the app is installed, the next step is to add the Vercel build button to the sidebar of to one or more of your project's models, so that you can trigger builds from the content editor.

#How to add the build button to the sidebar

  1. On the left side navigation, go to the Schema editor.

  2. Under the Models section, click on the model you want to add the Vercel build button to.

  3. Click on the Sidebar tab.

  4. Under Sidebar Widgets, click on the Deploy to Vercel widget to add it to the sidebar.

  5. In the Add Widget pop-up, Display Name and Description fields will be pre-filled. You can edit them if you want. Otherwise, just click on the Create button to add it to the model sidebar.

  6. Finally, you can drag and drop the widget by clicking on the six dots icon to reorder the sidebar widgets if you want.

Now, let's learn how to trigger builds from the content editor.

#How to trigger a build

  1. Click on the Go to content editing link at the top right of the Schema editor. Alternatively, you can also click on the Content icon, in the left side navigation.
  2. Click on the model you added the sidebar widget to.
  3. Click on the Edit button of an existing entry. Or click on the Create Entry button.
  4. Finally, click on the Start Building button, located in the sidebar. Once you do that, the button state changes and the build will start on Vercel. Under the button, you should see the last date a build has been triggered.

#Using our starter projects with Vercel

Follow these steps:

Hygraph starter - Documentation project used as exampleHygraph starter - Documentation project used as example

  1. Create a new project by selecting one of the starters in Hygraph.

  2. Click on the Create project button. You will be redirected to your Hygraph project homepage.

  3. Access the starter's GitHub repository on a different tab, scroll down to visualize the README document contents, and click on the Deploy button.

  4. Create a GitHub repository for your project, and then provide the values for the required environment variables. Click here for information on how to configure your project easily.

Configure your Vercel ProjectConfigure your Vercel Project

  1. Click on the Deploy button.

#Environment variables

Use this information to configure your Vercel project.

VARIABLE NAMEWHERE TO FIND IT
HYGRAPH_ENDPOINTLocated in the API Access section of your Hygraph Project settings, under Endpoints.
HYGRAPH_DEV_TOKENLocated in the API Access section of your Hygraph Project settings, under Permanent Auth Tokens.
HYGRAPH_MUTATION_TOKENLocated in the API Access section of your Hygraph Project settings, under Permanent Auth Tokens.
HYGRAPH_QUERY_TOKENLocated in the API Access section of your Hygraph Project settings, under Permanent Auth Tokens.
HYGRAPH_PROD_TOKENLocated in the API Access section of your Hygraph Project settings, under Permanent Auth Tokens.
HYGRAPH_TOKENLocated in the API Access section of your Hygraph Project settings, under Permanent Auth Tokens.
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEYThis is not located in Hygraph. You will find this information in your third party configuration.
NEXTAUTH_SECRETThis is not located in Hygraph. You will find this information in your third party configuration.
NEXTAUTH_URLThis is not located in Hygraph. You will find this information in your third party configuration.
PREVIEW_SECRETFind it in your Hygraph custom configuration. You will find this in the Schema builder, in the Sidebar tab of the model that contains the preview widget.
STRIPE_SECRET_KEYThis is not located in Hygraph. You will find this information in your third party configuration.
STRIPE_WEBHOOK_SIGNING_SECRETThis is not located in Hygraph. You will find this information in your third party configuration.