Integrations /

Contentful Integration

Contentful is a headless Content Management System (CMS) built with an API-first architecture. You can upload content to Contentful, then organize and edit it on the Contentful web app interface.

Connect your Netlify site with a Contentful space using the Contentful Integration to streamline the way you work with your CMS and Netlify. With this integration, the Netlify app on your Contentful space installs once you connect your Netlify site to Contentful, so you can redeploy updated content in fewer steps, and without having to manually create webhooks.

Contentful Integration versus Netlify Connect

This Contentful Integration connects your site directly with Contentful and is separate from Netlify Connect. Netlify Connect is an Enterprise-only product that’s best for those who have data spread across multiple data sources. If you only need to connect your site to a single Contentful instance, we recommend that you use this Contentful Integration instead.

# Before you begin

To get started integrating Contentful with your Netlify site, make sure you have the following prerequisites:

  • an account with Contentful
  • a Contentful space to connect with a site
  • a site on Netlify that pulls content from Contentful

To use the features of the integration, your Contentful space needs content type and content already populated.

# Connect to Contentful on Netlify

Once you have your Contentful space and your Netlify site ready, you can connect to Contentful in the Netlify UI:

  1. Select your site, then select Integrations.
  2. Search integrations for Contentful to access the Contentful Integration.
  3. Select Enable.
  4. Once enabled, follow the prompts to log in to your Contentful account through OAuth. Successfully logging in to Contentful will redirect you back to the Netlify UI. Then you can complete your configuration by connecting a space as described below.

You connect the Contentful Integration at the site level. If you want to enable it on multiple sites, you’ll need to follow the steps above for each site.

# Connect a space

When you connect a space to your Netlify site, the Netlify app installs in the sidebar of your Contentful space. This enables you to redeploy your site from the Contentful UI when you update content.

To configure your connection in the Netlify UI:

  1. If you haven’t already been redirected here after logging in to Contentful, select Integrations > CMS > Contentful > View.

  2. In the Select a space menu, choose your desired Contentful space.

  3. In the Select a trigger menu, choose how you want to redeploy your site for updates:

    • When entry published only

    • When entry published, unpublished, or deleted

  4. Select Configure.

In addition to installing the Netlify app on your Contentful space, a successful connection generates a webhook linked to your Netlify site.

You can edit the settings for the webhook at any time from the Netlify UI by selecting Integrations > CMS > Contentful > View, then following the webhook link under Connected to Contentful to navigate to the webhook settings in Contentful.

# Test your connection

Navigate to your Contentful space and select Content to access your entries. Select the content name to open more details. Find the Netlify app on your Contentful space in the sidebar if your connection is successful.

If you add a new content type after enabling the integration, you’ll need to manually install the Netlify app on your Contentful space for that content type.

# More resources