You can connect Contentful to your Zendesk account to make the content availablewherever external content is used. You must be a Knowledge admin to set up and manage external content connections.

What's my plan?
All Suites Team, Growth, Professional, Enterprise, or Enterprise Plus
Support with Knowledge Professional or Enterprise

Summary: ◀▼

You can connect Contentful as an external knowledge source to sync content from a Contentful space into Knowledge for use across knowledge experiences. As a Knowledge admin, you enter the space ID, API key, and public URL format, then start syncing. Added content is ingested on the next sync, removed content is deleted, and new spaces require a new connection.

You can connect Contentful to your Zendesk account to make the content available wherever external content is used. You must be a Knowledge admin to set up and manage external content connections.

This article contains the following topics:
  • Setting up a Contentful connection
  • Adding or removing content from your Contentful connection
Related articles:
  • Managing external knowledge connections
  • About connecting external content to Zendesk for use across knowledge experiences

Setting up a Contentful connection

You can set up a Contentful connection to connect and sync content from your Contentful spaces. After you connect a Contentful space, you can configure workflows to use this external content or manage the external knowledge connection.

To set up a Contentful connection
  1. In Knowledge admin, click Manage articles () in the sidebar.
  2. Click External content > Connections.
  3. Under the Available sources section, click Connect on the Contentful card.
  4. Click Continue.

  5. On the Authenticate tab, enter the following information:
    • Contentful Space ID: Identifier for the Contentful space that you want to connect to Zendesk. For more information about finding the Contentful Space ID see the Contentful help center.
    • API key: (Content Delivery API - access token in Contentful) Credential that grants programmatic access to read content stored in your Contentful space.
  6. On the Add public URL tab, specify the URL format for the public page that hosts your Contentful content. The URL format can be:
    • a field containing the full URL, such asfields.url
    • a URL string with one or more placeholders, such ashttps://zendesk.com/{fields.slug}
    Placeholders can reference entry fields (fields.<fieldId>) and entry metadata (sys.<key>), such as sys.id.
    Note: The knowledge connector only ingests content that can be associated with a URL. If the URL cannot be constructed from the URL format because required fields are missing, the record is skipped during content syncing.

  7. Click Sync.

    Contentful is added to your Connections page and your space begins syncing.

Adding or removing content from your Contentful connection

When you add or remove content in Contentful for a space that's connected to Knowledge, that content is automatically ingested to or removed from Knowledge during the next sync.

However, if you want to add a new space to your existing Contentful connection, you must remove the connection entirely and set up a new connection.

Powered by Zendesk