Contentful integration

What is Contentful?

Contentful is a headless content management system (CMS) that provides a content infrastructure for digital experiences. It allows developers to create, manage, and distribute content across multiple platforms and channels through APIs.

You can configure a pipeline in Buddy to automate tasks such as content migrations, space management, or content synchronization whenever changes are pushed to your Git repository.

The integration also lets you run any commands supported by the Contentful CLI, and e.g. manage spaces, content types, and entries, as well as parameterize the commands with environment variables.

Image loading...Example pipeline for Contentful CLI with export to S3 backup and Slack notification

Setting up Contentful integration

Contentful integration supports two authentication methods: OAuth and Personal Access Token.

OAuth Authentication

  1. Navigate to the Integrations tab and click New integration.

  2. Look up and click Contentful (it can be found in the PaaS category):

Image loading...Selecting Contentful from integrations list in PaaS category

  1. Once the configuration window shows up, provide integration name and click Start OAuth authorization:

Image loading...Contentful integration configuration window with OAuth authorization option

  1. You will be redirected to Contentful's login page. Log in using your GitHub account or Google account:

Image loading...Contentful login page with GitHub and Google authentication options

  1. Click Authorize to grant Buddy access to your Contentful spaces:

Image loading...Contentful authorization confirmation page asking to authorize Buddy

Personal Access Token Authentication

Alternatively, you can use a Personal Access Token for authentication:

Image loading...Contentful integration configuration with Personal Access Token option selected

  1. Log in to the Contentful web app.
  2. Open the space that you want to access using the space selector in the top left.
  3. Click Settings and select CMA tokens from the drop-down list.
  4. Click Create personal access token. The Create personal access token window is displayed. Image loading...Contentful CMA tokens page with Create personal access token button
  5. Enter a custom name for your personal access token, select the expiration date (default is 30 days), and click Generate. Your personal access token is created. Image loading...Contentful Create personal access token modal with token name and expiration date fields

  6. Copy your personal access token to clipboard and paste it into the Personal Access Token field in Buddy.

Warning
Copy the token immediately as it won't be available after closing the window.

Last modified on Sep 17, 2025