Connecting Contentful as an external knowledge source

<body>
<p id="docs-hc-snippet" style="display: none;">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.</p>
<div class="article-banners">
<div id="docs-wmp-link">
<a href="https://support.zendesk.com/hc/en-us/articles/5411234991258-plan" rel="noopener" target="_blank">What's my plan?</a>
</div>

<div class="article-banner" id="suite_all">
<table>
<tbody>
<tr>
<td>
<strong>All Suites</strong>
</td>
<td>Team, Growth, Professional, Enterprise, or Enterprise Plus</td>
</tr>
</tbody>
</table>
</div>

<div class="article-banner" id="support_with_guide_all">
<table>
<tbody>
<tr>
<td>
<strong>Support with</strong>
</td>
<td>Knowledge Professional or Enterprise</td>
</tr>
</tbody>
</table>
</div>

</div>
<div id="docs-ai-summary">
<p id="docs-ai-summary-toggle">Summary: <span id="up-triangle">◀</span><span id="down-triangle">▼</span></p>
<p id="docs-ai-summary-content">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.</p>
</div>

<div class="body">

<p class="p">You can connect Contentful to your Zendesk account to make the content available <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9822956298010#topic_cwq_c2s_ygc" target="_blank">wherever external content is used</a>. You must be
a Knowledge admin to set up and manage external content connections. </p>
<div class="p">This article contains the following topics:<ul class="ul" id="topic_c3s_fft_wgc__ul_kbk_dsh_xgc">
<li class="li"><a class="xref" href="#topic_ftg_xjt_wgc">Setting up a Contentful connection</a></li>
<li class="li"><a class="xref" href="#topic_t1w_vps_ygc">Adding or removing content from your Contentful connection</a></li>
</ul>
</div>
<div class="p">
<strong class="ph b">Related articles</strong>:<ul class="ul" id="topic_c3s_fft_wgc__ul_npx_2r1_xgc">
<li class="li"><a class="xref" href="https://support.zendesk.com/hc/en-us/articles/10933554246938" target="_blank">Managing external knowledge
connections</a></li>
<li class="li"><a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9822956298010" target="_blank">About connecting external content to Zendesk
for use across knowledge experiences</a></li>
</ul>
</div>
</div>
<div aria-labelledby="ariaid-title2" class="topic nested1" id="topic_ftg_xjt_wgc">
<h2 class="title topictitle2" id="ariaid-title2">Setting up a Contentful connection</h2>
<div class="body">
<p class="p">You can set up a Contentful connection to connect and sync content from your
Contentful spaces. After you connect a Contentful space, you can <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9822956298010#topic_opg_phs_ygc" target="_blank">configure workflows to use this external
content</a> or <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/10933554246938" target="_blank">manage the external knowledge
connection</a>.</p>
<div class="p">
<strong class="ph b">To set up a Contentful connection</strong><ol class="ol" id="topic_ftg_xjt_wgc__ol_ik3_ckt_wgc">
<li class="li"><span class="ph">In <a class="xref" href="https://support.zendesk.com/hc/en-us/articles/9041943683354#topic_b5q_nwn_s2c" target="_blank">Knowledge admin</a>, click <strong class="ph b">Manage articles</strong>
(<img class="image" id="topic_ftg_xjt_wgc__d8e24" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/guide_icon_manage_articles.png">) in the sidebar.</span></li>
<li class="li">Click <strong class="ph b">External content &gt; Connections</strong>.</li>
<li class="li">Under the Available sources section, click <strong class="ph b">Connect</strong> on the Contentful
card.</li>
<li class="li">Click <strong class="ph b">Continue</strong>.<p class="p"><img class="image img-screenshot" id="topic_ftg_xjt_wgc__image_s2p_bcl_y3c" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/knw-contentful-connectmodal.png" width="350"></p>
</li>
<li class="li">On the <strong class="ph b">Authenticate</strong> tab, enter the following information:<ul class="ul" id="topic_ftg_xjt_wgc__ul_k33_byd_vjc">
<li class="li">
<strong class="ph b">Contentful Space ID:</strong> Identifier for the Contentful space that
you want to connect to Zendesk. For more information about finding
the Contentful Space ID see the <a class="xref" href="https://www.contentful.com/help/spaces/find-space-id/" target="_blank">Contentful help
center</a>.</li>
<li class="li">
<strong class="ph b">API key</strong>: (<a class="xref" href="https://www.contentful.com/developers/docs/references/content-delivery-api/overview/" target="_blank">Content Delivery API - access
token</a> in Contentful) Credential that grants programmatic
access to read content stored in your Contentful space.</li>
</ul>
<img class="image img-screenshot" id="topic_ftg_xjt_wgc__image_xqg_cyd_vjc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/knw-contentful-connect-0726.jpg" width="600">
</li>
<li class="li">On the <strong class="ph b">Add public URL</strong> tab, specify the URL format for the public page
that hosts your Contentful content. The URL format can be:<ul class="ul" id="topic_ftg_xjt_wgc__ul_gyv_5v2_wjc">
<li class="li">a field containing the full URL, such
as<code class="ph codeph">fields.url</code>
</li>
<li class="li">a URL string with one or more placeholders, such
as<code class="ph codeph">https://zendesk.com/{fields.slug}</code>
</li>
</ul>
Placeholders can reference entry fields
(<code class="ph codeph">fields.&lt;fieldId&gt;</code>) and entry metadata
(<code class="ph codeph">sys.&lt;key&gt;</code>), such as <code class="ph codeph">sys.id</code>.<div class="note" id="topic_ftg_xjt_wgc__note_zs4_412_vjc">
<span class="notetitle">Note:</span> 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.</div>
<p class="p"><img class="image img-screenshot" id="topic_ftg_xjt_wgc__image_zkl_m12_vjc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/knw-contentful-connect-URL-0726.jpg" width="600"></p>
</li>
<li class="li">Click <strong class="ph b">Sync</strong>.<p class="p">Contentful is added to your Connections page and your
space begins syncing.</p>
<p class="p"><img class="image img-screenshot" id="topic_ftg_xjt_wgc__image_j2m_jcp_xjc" src="https://zen-marketing-documentation.s3.amazonaws.com/docs/en/knw-cnctr-contentful-sync.png" width="800"></p>
</li>
</ol>
</div>
</div>
</div>
<div aria-labelledby="ariaid-title3" class="topic nested1" id="topic_t1w_vps_ygc">
<h2 class="title topictitle2" id="ariaid-title3">Adding or removing content from your Contentful connection</h2>
<div class="body">
<p class="p">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.</p>
<p class="p">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.</p>
</div>
</div>
<script id="docs-schema-markup" type="application/ld+json">{
"@context": "https://schema.org",
"@type": "TechArticle",
"@id": "https://support.zendesk.com/hc/en-us/articles/10589998021402",
"url": "https://support.zendesk.com/hc/en-us/articles/10589998021402",
"headline": "Connecting Contentful as an external knowledge source",
"description": "You connect a Contentful space as an external knowledge source, authenticate it, set a public URL format, and sync content so it is ingested or removed during updates.",
"articleSection": "Using help center search",
"datePublished": "2026-04-23T19:30:13+00:00",
"dateModified": "2026-07-15T12:05:40.916272+00:00",
"inLanguage": "en",
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "https://support.zendesk.com/hc/en-us/articles/10589998021402"
},
"author": {
"@type": "Organization",
"name": "Zendesk",
"@id": "https://www.zendesk.com"
},
"publisher": {
"@type": "Organization",
"name": "Zendesk",
"@id": "https://www.zendesk.com"
},
"isPartOf": {
"@type": "WebSite",
"name": "Zendesk Help",
"@id": "https://support.zendesk.com/hc/"
},
"about": {
"@type": "SoftwareApplication",
"name": "Zendesk",
"@id": "https://www.zendesk.com",
"softwareAddOn": {
"@type": "SoftwareApplication",
"name": "Knowledge",
"@id": "https://support.zendesk.com/hc/en-us/sections/4405298860954"
}
}
}</script><script id="ai-summary-script">
//<![CDATA[
const ai_summary_style = document.createElement('style');
ai_summary_style.innerHTML = `#styled-article-body{padding:0 0 0}#article-body #docs-ai-summary{background-color:#f3f3f3;border:1px solid #d3d3d3;padding:10px 10px 6px;margin-bottom:16px}#article-body #docs-ai-summary #docs-ai-summary-toggle{font-size:.9em;font-weight:700;margin-bottom:4px;cursor:pointer;display:flex;justify-content:space-between;align-items:center}#article-body #docs-ai-summary #docs-ai-summary-toggle #up-triangle{margin-left:auto;padding-right:10px;display:none}#article-body #docs-ai-summary #docs-ai-summary-toggle #down-triangle{margin-left:auto;padding-right:10px}#article-body #docs-ai-summary #docs-ai-summary-content{font-size:.9em;padding-left:25px;padding-right:25px;margin-bottom:12px}`;
document.head.appendChild(ai_summary_style);

const toggleAISummary = () => {
const summary = document.getElementById("docs-ai-summary-content");
const upTriangle = document.getElementById("up-triangle");
const downTriangle = document.getElementById("down-triangle");
if (summary.style.display === "none") {
summary.style.display = "block";
upTriangle.style.display = "none";
downTriangle.style.display = "inline";
} else {
summary.style.display = "none";
upTriangle.style.display = "inline";
downTriangle.style.display = "none";
}
};

document.getElementById("docs-ai-summary-toggle").addEventListener("click", toggleAISummary);
//]]>
</script>
</body>