Integrating GraphCMS with Vercel

Seamlessly trigger Headless CMS builds and deploy GraphCMS projects with the integration for Vercel.

GraphCMS is a GraphQL native Headless CMS used to power websites, applications, portals, and other digital platforms with content from a single GraphQL API endpoint. In this guide, you will learn how to use the Vercel integration for GraphCMS.

GraphCMS Vercel Integration

About the Integration

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

  • 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

Setting Up The Integration

Each GraphCMS project can support up to 3 concurrent Vercel projects. This integration uses explicit OAuth2.

Step One: Activate the Vercel Integration in GraphCMS

Step 1 - Select Vercel from Integrations

Log in to your GraphCMS project, and select integrations from the settings sidebar.

Step 2 - Enable the Vercel Integration for GraphCMS

Select Vercel and enable the integration.

Step 3 - Authorize your Vercel Account to be used with GraphCMS

Connect to your Vercel account to allow the integration to work.

Step 4 - Authorize GraphCMS in Vercel

Authorize the GraphCMS integration for your Vercel account.

Step Two: Configure the Content Models

Step 5 - Select the projects and content models

Select the Vercel projects you want to connect to your GraphCMS project. They must support continuous deployment.

Step 6 - Confirm your integration

Select which content models show the deploy button in the GraphCMS sidebar.

Note: Only content models selected will display the deploy button.

Step Three: Update and deploy

Step 7 - You’re all set!

When creating, publishing, unpublishing, or editing content, simply click on Start Building to trigger a new Vercel build.

Note: The GraphCMS team recommends setting up Preview URLs to support your workflows and preview your content before pushing it to Production.



Written By
Written by leerobleerob
Last Edited on January 8th 2021