June 3, 2026

<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="concept-9956" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">June 2026</h1><div class="body"><p class="shortdesc">New versions of <span class="ph">Heretto</span> products are here! Read on to learn what's new. 🚀</p><p class="p"><span class="ph">Heretto</span> product versions released this month:</p><ul class="ul"><li class="li"><p class="p"><span class="ph">Heretto Deploy API</span> 26.06.03</p></li></ul></div><article class="topic nested1" id="concept-2250" aria-labelledby="ariaid-title2" lang="en-us"><h2 class="title topictitle2" id="ariaid-title2">June 3, 2026</h2><div class="body"><p class="shortdesc">A new <span class="ph">Deploy API</span> version with further improvements to deployment stability.</p><p class="p"><span class="ph b"><span class="ph">Heretto Deploy API</span> 26.06.03</span></p><ul class="ul"><li class="li">Fixed. We resolved an issue where a manual deployment could fail for very large content sets. Publishing now processes large content sets more efficiently, and manual deployments complete successfully regardless of how much content they contain.
                
            </li></ul></div></article></article></main></body>

New versions of Heretto products are here! Read on to learn what's new. 🚀

May 2026

Learn what has changed in Heretto products

Release Notes

Defines the core concepts of Audiences and Content Filtering.

Audiences and Content Filtering

June 2026

<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="topic-8515" aria-labelledby="ariaid-title1"><h1 class="title topictitle1 hide-footer-title" id="ariaid-title1">Footer Section</h1><div class="body footer-container"><p class="shortdesc"></p><section class="section footer-item footer-links footer-full"><h2 class="title sectiontitle" id="our-support-team-is-here-to-help-0">Our Support Team is here to help</h2>
            
            <p class="p">Submit a support request or check the status of your existing requests. You can also email us.</p>
            <p class="p"><a class="xref footer-connect-button j-external-link" href="https://support.heretto.com/" target="_blank">Contact Support Team</a></p>
        </section><section class="section footer-bottom-container">

        <div class="div footer-item footer-links footer-bigger">
            <p class="p footer-img-left"><a class="xref j-external-link" href="https://heretto.com/" target="_blank"><img class="image footer-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a69de2b0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2OWRlMmIwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc4MDgzODE3NSwianRpIjoiZjdkOTU0YzgxN2NlNDkyOTljMmZmMmFjMjkwNDc3OTgiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJJOXZBM0tsSzgyMDFJWW1FQ2g1VSJ9.j0tmGHOao8_Hy3qGh63zF9bZpgqFk2ElTfmPxrNb9-4"></a></p>
            <p class="p footer-section-title">Love this help site?</p>
            <p class="p">You can have one, too! Using the Heretto CCMS as a foundation, our team can build a tailored portal that will delight your customers. Meet with our team to learn more.</p>
            <p class="p"><a class="xref footer-connect-button j-external-link" href="https://www.heretto.com/request-demo?utm_medium=direct-traffic&amp;utm_source=direct-traffic&amp;utm_campaign=demo-request&amp;utm_content=helpsite&amp;utm_term=" target="_blank">Connect with us</a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Explore</p>
            <p class="p"></p>
            <p class="p"></p>
            <p class="p"><a class="xref" href="/heretto-ccms/integrations/heretto-ccms-integrations-overview">Integrations</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/video-tutorials/" target="_blank">Video Tutorials</a></p>
            <p class="p"><a class="xref j-external-link" href="https://learningdita.com/" target="_blank">Learning DITA </a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Company</p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/about-heretto/" target="_blank">About Us</a></p>
            <p class="p"><a class="xref j-external-link" href="https://www.heretto.com/contact" target="_blank">Contact Us</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/" target="_blank">heretto.com</a></p>
        </div>
        <div class="div footer-item footer-links">
            <p class="p footer-heading">Legalities</p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/legal/" target="_blank">Legal</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/privacy-policy/" target="_blank">Privacy Policy</a></p>
            <p class="p"><a class="xref j-external-link" href="https://heretto.com/terms-of-use/" target="_blank">Terms of Use</a></p>
        </div>
        <div class="div footer-copyright-container">
            <div class="div copyright-left">
                <p class="p copyright-item">© 2026 Heretto Intellectual Property. All rights reserved.</p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/legal/" target="_blank">Legal</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/privacy-policy/" target="_blank">Privacy Policy</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/terms-of-use/" target="_blank">Terms of Use</a></p>
                <p class="p copyright-item"><a class="xref copyright-link j-external-link" href="https://heretto.com/about-heretto/" target="_blank">About Us</a></p>
            </div>
            <div class="div copyright-right">
                <p class="p copyright-item"><a class="xref j-external-link" href="https://x.com/helloHeretto" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a6b402c0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2YjQwMmMwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc4MDgzODE3NSwianRpIjoiMjk4OTAzOWNlMzQzNDMwYTkxMGIyNDk1YjJjMGY0NzQiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJJOXZBM0tsSzgyMDFJWW1FQ2g1VSJ9.-86Cny4MI33KC_m00QxWNvg7cgUKduCnbTXmqzdCvkU"></a></p>
                <p class="p copyright-item"><a class="xref j-external-link" href="https://www.linkedin.com/company/heretto/" target="_blank"><img class="image social-logo" src="https://heretto.deploy.heretto.com/v4/deployments/I9vA3KlK8201IYmECh5U/object/a6c7b1d0-741e-11ee-a3d9-0242d8e432a4?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJodHRwczovL2pvcnNlay5jb20vZXpkX29yZ2FuaXphdGlvbiI6ImpvcnNlay1kb2NzIiwiaHR0cHM6Ly9qb3JzZWsuY29tL2V6ZC9vYmplY3RfdXVpZCI6ImE2YzdiMWQwLTc0MWUtMTFlZS1hM2Q5LTAyNDJkOGU0MzJhNCIsImV4cCI6MTc4MDgzODE3NSwianRpIjoiYzc2NjQ0NDRhNjA3NDRiMWExMTk3YTY1YTQyYTU0YWYiLCJodHRwczovL2pvcnNlay5jb20vZXpkX2ZpbGVzZXQiOiJJOXZBM0tsSzgyMDFJWW1FQ2g1VSJ9.c6ShBjD4lnFh655uEgv-Qj9uNJ5wWK3tE0Yy2Uu20fo"></a></p>
            </div>
        </div>

</section></div></article></main></body>

Footer Section

<i18n-message>[MISSING CONTENT]</i18n-message>

Etto, the Heretto Copilot, is a generative Artificial Intelligence (AI) tool built for Heretto CCMS. The goal of Etto is to help you create quality structured content in the DITA XML standard, boost productivity by assisting with time-consuming tasks, and improve overall content consistency.

Etto, the Heretto Copilot Overview

Gosia Radymiak <gosia.radymiak@heretto.com>

Deploy API Functions

Deploy API Content Flow

Deploy API Definitions

Gosia Radymiak
            <gosia.radymiak@heretto.com>

Deploy API Operation and Guidelines

<body class="page-break-after"><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="concept-925" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1"><span class="ph">Deploy API</span> Overview</h1><div class="body conbody"><div class="abstract">
        <div class="note note note_note"><span class="note__title">Note:</span> If you are looking for information about how to publish API specifications to <span class="ph">Heretto Portal</span>, see <a class="xref" href="/heretto-portal/heretto-portal-api-docs#concept-603">Heretto Portal API Docs</a>.</div>
        
        <p class="shortdesc"><span class="ph">Heretto Deploy API</span> is the crucial content delivery service that processes content from <span class="ph">Heretto CCMS</span> and transforms it into formats that can be delivered to end-users. The processed content is then delivered through the <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p>
    </div><p class="p">As an example, the documentation you are currently reading was delivered to this help site with <span class="ph">Deploy API</span>. Our help site is powered by both <span class="ph">Deploy API</span> and <span class="ph">Heretto Portal</span>.</p><div class="p"><span class="ph">Deploy API</span> supports: <ul class="ul"><li class="li">
                    <p class="p">Delivering localized content</p>
                </li><li class="li">
                    <p class="p">Managing access through authentication</p>
                </li><li class="li">
                    <p class="p">Tailoring content to different audiences (personalization)</p>
                </li></ul></div><p class="p">Key <span class="ph">Deploy API</span> use cases:</p><dl class="dl"><dt class="dt dlterm">Building Websites</dt><dd class="dd">
                    <p class="p">Transform your <span class="ph">Heretto CCMS</span> content into complete websites such as knowledge bases, support portals, or documentation hubs. Customize branding and design elements to maintain visual consistency with your existing web properties.</p>
                </dd><dt class="dt dlterm">Embedding Content</dt><dd class="dd">
                    <p class="p">Integrate content from <span class="ph">Heretto CCMS</span> directly into existing websites or applications. This enables context-sensitive help, in-app documentation, or targeted information delivery within your digital products.</p>
                    
                </dd><dt class="dt dlterm">Distributing to Multiple Endpoints</dt><dd class="dd">
                    <p class="p">Deploy your DITA source content to diverse delivery channels including IoT devices, embedded systems, and custom applications using <span class="ph">Deploy API</span>. This ensures consistent information across all customer touchpoints.</p>
                </dd></dl><p class="p">This single-source publishing approach ensures content consistency while reducing maintenance overhead. When you update content in <span class="ph">Heretto CCMS</span>, you can easily deliver it to all channels, typically significantly reducing publishing time compared to traditional multi-channel publishing workflows.</p></div><article class="topic concept nested1" id="concept-5440" aria-labelledby="ariaid-title2" lang="en-us"><h2 class="title topictitle2" id="ariaid-title2"><span class="ph">Deploy API</span> Functions</h2><div class="body conbody"><p class="shortdesc"><span class="ph">Heretto Deploy API</span> serves two main functions: it processes content managed in <span class="ph">Heretto CCMS</span>, and serves it to the <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p><dl class="dl"><dt class="dt dlterm">Content Processing</dt><dd class="dd">
                    <p class="p">The <span class="ph">Deploy API</span> processes content managed in <span class="ph">Heretto CCMS</span> and published through a deployment. It captures and snapshots all content involved in a publishing job, performs content rendering, and creates an immutable database of the final content.</p>
                </dd><dt class="dt dlterm">Content Delivery</dt><dd class="dd">
                    <p class="p">The <span class="ph">Deploy API</span> serves the processed content to delivery endpoints such as the <span class="ph">Heretto Portal</span>, websites, applications, machines, and devices. </p>
                </dd></dl><div class="note note note_note"><span class="note__title">Note:</span> 
            <p class="p">In <span class="ph">Deploy API</span>, the functions of processing and serving content are separated to make it resilient and scalable. This change is currently only applicable to manual deployments. <span class="ph">Deploy API</span> conceptually runs in the same infrastructure as Cloud Publishing, with each deployment being treated as a publishing job and processed in an ephemeral container in the cloud.</p>
            
        </div></div></article><article class="topic concept nested1" id="concept-875" aria-labelledby="ariaid-title3" lang="en-us"><h2 class="title topictitle2" id="ariaid-title3"><span class="ph">Deploy API</span> Content Flow</h2><div class="body conbody"><p class="shortdesc"><span class="ph">Heretto Deploy API</span> serves as the processing and delivery engine for <span class="ph">Heretto CCMS</span> content. It transforms content into delivery-ready formats and distributes it to various endpoints including websites, applications, and devices.</p><section class="section"><h3 class="title sectiontitle" id="how-content-is-passed-to-deploy-api-0">How Content is Passed to <span class="ph">Deploy API</span></h3>
            
            <p class="p">Once content is finalized in <span class="ph">Heretto CCMS</span>, it moves to the <span class="ph">Deploy API</span> through  deployments. </p>
            <p class="p">Deployments are essential configuration elements that determine which content is published, where it's published, and under what conditions. Deployments connect specific content in the CCMS with appropriate delivery endpoints such as <span class="ph">Heretto Portal</span> or other delivery endpoints.</p>
            <p class="p"><span class="ph">Deploy API</span> supports two deployment types:</p>
            <dl class="dl"><dt class="dt dlterm"><span class="ph b">Active Sync</span></dt><dd class="dd">
                        <p class="p">Automatically and continually publishes content updates from the CCMS to delivery endpoints. As content creators make changes in the CCMS, their updates are rapidly integrated into the associated deployment and published to a delivery endpoint. </p>
                        <p class="p">Active sync is valuable for preview environments where teams need to see work-in-progress content. Due to its immediate nature and the risk of publishing work-in-progress content, active sync is not available for production portal environments.</p>
                    </dd><dt class="dt dlterm"><span class="ph b">Manual Deploy</span></dt><dd class="dd">
                        <p class="p">Requires deliberate user action to initiate the publishing process. Content updates remain in the CCMS until a user manually publishes a deployment. This deployment type gives teams control over when updates are released, enabling them to work on substantial content updates.</p>
                        <p class="p">Manual deploy is available for all portal environments. It is the standard configuration for publishing official content versions.</p>
                    </dd></dl>
        </section><section class="section"><h3 class="title sectiontitle" id="how-content-becomes-a-deployment-0">How Content Becomes a Deployment</h3>
            
            <p class="p">Once content is passed from <span class="ph">Heretto CCMS</span> through a deployment to <span class="ph">Deploy API</span>, it is processed into a final output and served to the <span class="ph">Heretto Portal</span> or other delivery endpoints.</p>
            <p class="p">Processing a deployment involves evaluating raw DITA content and associated assets and converting them into a final output used to serve the content to its final delivery endpoint for end-user consumption. All deployment processing starts in <span class="ph">Heretto CCMS</span> with the deployment configuration and a DITA map (sitemap). At a high level, the following happens during a deployment processing:</p>
            <ul class="ul"><li class="li">
                    <p class="p">Deployment instructions indicate the audiences and the locales (target languages) that are included.</p>
                </li><li class="li">
                    <p class="p">The map defines the scope of the deployment.</p>
                </li><li class="li">
                    <p class="p">All content files for a tenant are located and made available.</p>
                </li><li class="li">
                    <p class="p">All source content is processed into a normalized structure with all necessary information for output. </p>
                    <p class="p">This process involves steps such as: evaluating document metadata, including or excluding review markup, processing conditional sets, processing keyrefs and xrefs, link correction, and processing tables and figures.</p>
                </li></ul>
            <p class="p">At this point, there is an ephemeral in-memory representation of the full set of content in an intermediate state that is <em class="ph i">nearly</em> final. The content is ready to be rapidly transformed into a final output format, like HTML. This process of building a content set in its <em class="ph i">nearly</em> final state is used by both active sync and manual deploy deployments. How the two deployment types use this process varies, as described below.</p>
            <dl class="dl"><dt class="dt dlterm">Active Sync Processing</dt><dd class="dd">
                        <p class="p">With an active sync deployment, the process is always on, hosting the content in its <em class="ph i">nearly</em> final state. The content in this case is hosted within <span class="ph">Deploy API</span>. </p>
                        <p class="p">There are two reasons it works this way. The content can be quickly returned in the final format to serve content requests. Additionally, the intermediate in-memory state is ideal for quickly integrating content changes from the CCMS.</p>
                        <p class="p">The primary benefit of this structure is the rapid integration of new content. That benefit comes with some expense:</p>
                        <ul class="ul"><li class="li">
                                <p class="p">The representation is ephemeral and must be reprocessed at restart</p>
                            </li><li class="li">
                                <p class="p">All content must fit in memory</p>
                            </li><li class="li">
                                <p class="p">An error in content can impact the APIs ability to respond to content requests</p>
                            </li><li class="li">
                                <p class="p">Auto scaling the API is slow because of the initial processing duration</p>
                            </li></ul>
                    </dd><dt class="dt dlterm">Manual Deploy Processing</dt><dd class="dd">
                        <p class="p">With a manual deployment, the process of building the set of content in its <em class="ph i">nearly</em> final state happens outside of <span class="ph">Deploy API</span>. When deployment publishing is triggered, a publishing job is initiated that performs the processing. At the end of processing the content, a snapshot is generated. The snapshot includes: all the files used for processing, an immutable database with all content in its final form, and search indexes. Upon completion of processing and storage, the <span class="ph">Deploy API</span> switches to serving content from the new immutable database.</p>
                        <p class="p">There are multiple benefits to this mode of operation:</p>
                        <ul class="ul"><li class="li">
                                <p class="p">All content processing happens outside of the production API, reducing the risk that a content error makes the API unavailable</p>
                            </li><li class="li">
                                <p class="p">Rapid auto scaling because all content is pre-processed</p>
                            </li><li class="li">
                                <p class="p">The code base for serving content is 90% smaller, leaving less surface area for issues</p>
                            </li><li class="li">
                                <p class="p">Highly efficient memory and content serving for a great experience</p>
                            </li><li class="li">
                                <p class="p">Content no longer needs to fit directly into memory, greatly increasing safety</p>
                            </li></ul>
                        <p class="p">The main tradeoff of manual deployments is that content updates take longer to become available, as the processing job must finish before new content is deployed.</p>
                    </dd></dl>
        </section></div></article><article class="topic concept nested1" id="concept-4005" aria-labelledby="ariaid-title4" lang="en-us"><h2 class="title topictitle2" id="ariaid-title4"><span class="ph">Deploy API</span> Definitions</h2><div class="body conbody"><p class="shortdesc"></p><dl class="dl"><dt class="dt dlterm">Delivery Endpoint</dt><dd class="dd"><p class="p">A delivery endpoint is any final destination where users consume content that has been processed by <span class="ph">Heretto Deploy API</span>. Delivery endpoints can include <span class="ph">Heretto Portal</span>, websites, applications, devices, and machines.</p><p class="p">Delivery  endpoints receive content that is managed in <span class="ph">Heretto CCMS</span>, processed by <span class="ph">Deploy API</span>, and transformed into appropriate formats for end-user consumption.</p></dd><dt class="dt dlterm">Deployments</dt><dd class="dd"><p class="p">Deployments are configurations that connect content in the CCMS with delivery endpoints via <span class="ph">Deploy API</span>. They enable content publication to the appropriate delivery endpoint, like  <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</p></dd><dt class="dt dlterm"><span class="ph">Heretto Deploy API</span></dt><dd class="dd">
                    <p class="p">A read-only API that enables you to deliver content from <span class="ph">Heretto CCMS</span> to different endpoints. The delivered content includes:</p>
                    <ul class="ul" id="concept-4005__ul_p1y_3lf_sjb"><li class="li">JSON data</li><li class="li">Media files</li><li class="li">Transformed XML content (HTML5) or compiled DITA</li></ul>
                </dd><dt class="dt dlterm">Serving Content</dt><dd class="dd"><p class="p">The process of requesting and receiving a final result from <span class="ph">Deploy API</span>, which may be content on a page or the structure required to serve that content. For example, when users access a page, they're essentially making an API request to <span class="ph">Deploy API</span>, which then delivers the requested content. This technical interaction forms the foundation of content delivery within the system.</p></dd><dt class="dt dlterm">Sitemaps</dt><dd class="dd">
                    <p class="p">Sitemaps are specialized DITA maps that determine the structure of your content. Depending on the environment you publish to, you may need to use different <span class="ph">sitemap</span> structures.</p>
                    <p class="p"><span class="ph">Deploy API</span> supports different <span class="ph">sitemap</span> structures.</p>
                </dd></dl></div></article><article class="topic concept nested1" id="concept-4780" aria-labelledby="ariaid-title5" lang="en-us"><h2 class="title topictitle2" id="ariaid-title5"><span class="ph">Deploy API</span> Operation and Guidelines</h2><div class="body conbody"><p class="shortdesc">Before you start using <span class="ph">Heretto Deploy API</span>, familiarize yourself with important facts and guidelines about working with it.</p><dl class="dl"><dt class="dt dlterm">General</dt><dd class="dd"><ul class="ul"><li class="li"><p class="p"><span class="ph">Deploy API</span> processes content from <span class="ph">Heretto CCMS</span> and serves it to an endpoint like <span class="ph">Heretto Portal</span> or a third-party endpoint, like a device or machine.</p></li><li class="li"><p class="p">Content that <span class="ph">Deploy API</span> uses must be organized into a sitemap, a specialized DITA map that lives in <span class="ph">Heretto CCMS</span>. It can contain other sitemaps, maps, bookmaps, topics, and other files. It can also contain elements that enable you to organize and present all components of your content. For example, <code class="ph codeph">sitesection</code>, <code class="ph codeph">topichead</code>, and <code class="ph codeph">topicgroup</code>.</p></li><li class="li"><p class="p">Content in <span class="ph">Heretto CCMS</span> is published with <span class="ph">Deploy API</span> through a deployment. A deployment is a configuration in the CCMS that defines which sitemap is published to which endpoint. Deployments carry information like the deployment type, audience, locales (target languages), or metadata.</p></li><li class="li"><p class="p">Each deployment must have a sitemap associated with it. One deployment can use only one sitemap. One sitemap can be used in multiple deployments.</p></li><li class="li"><p class="p">Once a sitemap is added to a deployment and changes are saved,  it cannot be replaced by a different sitemap. Instead, a new deployment must be configured.</p></li></ul></dd></dl></div></article></article></main></body>

Rafał Karoń <rafal.karon@jorsek.com>

Heretto Deploy API ensures secure processing and delivery of your content for end-user consumption. Deploy API employs two API authentication methods to securely distribute content from Heretto CCMS to various delivery endpoints: Simple API Keys and JSON Web Tokens (JWTs). Both methods are managed as API keys within Heretto CCMS. API keys are also known as secret keys or secrets.

Deploy API Authentication

Read the Deploy API specification and related resources

Heretto Deploy API

Get releases

Heretto Deploy API is the crucial content delivery service that processes content from Heretto CCMS and transforms it into formats that can be delivered to end-users. The processed content is then delivered through the Heretto Portal or other delivery endpoints such as websites, applications, devices, or machines.

Deploy API Overview

Use Heretto API Docs to publish API documentation for public and internal consumption within Heretto Portal.

API Docs Overview

<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="topic-9225" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Heretto Deploy Portal Overview</h1><div class="body"><p class="shortdesc"></p><iframe class="object iframe" controls="controls" src="https://www.youtube.com/embed/45CFJ3YhByI?list=PL4ZeW5ujwMiG-qroejPZ7DDYRf-potbdf" referrerpolicy="strict-origin-when-cross-origin" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" oallowfullscreen="true" msallowfullscreen="true" width="100%" height="270"></iframe><section class="section"><h2 class="title sectiontitle" id="heretto-deploy-portal-overview-0">Heretto Deploy Portal Overview</h2>
            
            <p class="p">Real-time content delivery anywhere</p>
        </section></div></article></main></body>

Heretto Deploy Portal Overview

<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="topic-2626" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">Heretto UX Overview</h1><div class="body"><p class="shortdesc"></p><iframe class="object iframe" controls="controls" src="https://www.youtube.com/embed/qJNtVI2cKTA" referrerpolicy="strict-origin-when-cross-origin" allowtransparency="true" frameborder="0" scrolling="no" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" oallowfullscreen="true" msallowfullscreen="true" width="100%" height="270"></iframe><section class="section"><h2 class="title sectiontitle" id="heretto-ux-overview-0">Heretto UX Overview</h2>
            
            <p class="p"><a class="xref external-video-link j-external-link" href="https://heretto.com/product-pulse/" target="_blank">View more videos</a></p>
        </section></div></article></main></body>

Heretto UX Overview

A new Deploy API version with further improvements to deployment stability.

Metadata Types in Heretto

Metadata Flow in Heretto

Metadata Operation and Guidelines

Configure metadata in an existing  deployment to decide which custom metadata should be passed to Heretto Portal or a third-party endpoint like a machine or device. The custom metadata that can be configured is taxonomy, label, text, and date metadata. Before it can be configured in a deployment, this metadata must be configured and enabled in the CCMS Metadata interface, and added to files.

Configure Metadata in a Deployment

heretto-portal/heretto-portal-metadata/metadata-governance-in-heretto-portal

Heretto Portal Metadata

Metadata governance gives your team intentional control over what information accompanies your content at each stage of the delivery pipeline. Rather than accepting default behavior, you can make deliberate choices about exactly which metadata reaches each endpoint.

Metadata Governance in Heretto Portal

<body><main xmlns:jcm-link-man="http://jorsek.com/content-management/modules/linkmanagement" role="main"><article role="article" id="concept-8026" aria-labelledby="ariaid-title1"><h1 class="title topictitle1" id="ariaid-title1">CCMS API Overview</h1><div class="body conbody"><div class="abstract">
        <div class="note note note_note"><span class="note__title">Note:</span> 
            <p class="p">This is an Alpha release of the CCMS API v2 that can be used alongside CCMS API v1. This release is part of the CCMS API v2 effort that aims at providing a complete set of CCMS APIs and currently focuses on publishing with deployments as well as <span class="ph">PDF Generator</span> and <span class="ph">DITA Open Toolkit (DITA-OT)</span>. The API is now available to all <span class="ph">Heretto</span> customers. No upgrades or configurations are required.</p> 
            <p class="p">To access CCMS API v1 documentation, contact your <span class="ph">Customer Success Manager</span>.</p>
        </div>
        <p class="shortdesc">The <span class="ph">Heretto CCMS</span> API (v2) enables programmatic access to publishing and deployment operations within the <span class="ph">Heretto</span> Component Content Management System (CCMS). This REST API enables you to automate publishing workflows, manage deployments, retrieve publishing outputs, and configure publishing scenarios.</p>
    </div><p class="p">The <span class="ph">Heretto CCMS</span> API is designed to support various automation and integration scenarios:</p><dl class="dl"><dt class="dt dlterm">CI/CD pipeline integration</dt><dd class="dd">Automate content publishing as part of your continuous integration and deployment workflows.</dd><dt class="dt dlterm">Custom publishing dashboards</dt><dd class="dd">Build internal tools to monitor publishing operations and deployment status.</dd><dt class="dt dlterm">Scheduled publishing</dt><dd class="dd">Trigger publishing jobs automatically based on schedules or external events.</dd><dt class="dt dlterm">Multi-locale management</dt><dd class="dd">Programmatically manage content deployments across multiple languages and regions.</dd><dt class="dt dlterm">Audit and compliance</dt><dd class="dd">Track and report on publishing history for regulatory requirements.</dd></dl><p class="p">This API enables you to work with these CCMS interfaces:</p><dl class="dl"><dt class="dt dlterm">Deployments</dt><dd class="dd">Work with preconfigured deployments in the CCMS to manage content publishing from the CCMS to <span class="ph">Heretto Portal</span> or other delivery endpoints such as websites, applications, devices, or machines.</dd><dt class="dt dlterm">Publishing jobs</dt><dd class="dd">Manage CCMS content publishing to static outputs, like PDF or HTML, by using publishing engines like <span class="ph">PDF Generator</span> or <span class="ph">DITA Open Toolkit (DITA-OT)</span>.</dd><dt class="dt dlterm">Publishing scenarios</dt><dd class="dd">Retrieve available scenarios and their configurable parameters, which you can then use when creating publishing jobs.</dd><dt class="dt dlterm">Releases</dt><dd class="dd">Retrieve information about existing releases (snapshots of content).</dd></dl><section class="section"><h2 class="title sectiontitle" id="authentication-0">Authentication</h2>
            
            <p class="p">The <span class="ph">Heretto CCMS</span> API supports two authentication methods:</p>
            <dl class="dl"><dt class="dt dlterm">Basic Authentication</dt><dd class="dd">
                        <p class="p">Include an <code class="ph codeph">Authorization</code> header with the value <code class="ph codeph">Basic &lt;base64(username:password)&gt;</code> in your API requests. You can use your CCMS username and either your password or an API token generated in the CCMS.</p>
                    </dd><dt class="dt dlterm">SSO Cookie Authentication </dt><dd class="dd">
                        <p class="p">Include the <code class="ph codeph">JSESSIONID</code> cookie from your authenticated browser session. This method is useful when testing the API from this documentation site or integrating with browser-based tools that maintain SSO sessions.</p>
                    </dd></dl>
            <p class="p">For more information, see <a class="xref" href="/heretto-ccms/api/ccms-api-authentication">CCMS API Authentication</a>.</p>
        </section><section class="section" id="concept-8026__base-url"><h2 class="title sectiontitle" id="base-url-0">Base URL</h2>
            
            <p class="p">All API requests use this base URL structure:</p>
            <pre class="pre codeblock lang-http"><code>https://{organizationId}.heretto.com/ezdnxtgen/api</code></pre>
            <p class="p" id="concept-8026__where-organizationId-is">Where <code class="ph codeph">{organizationId}</code> is the subdomain you use to access <span class="ph">Heretto CCMS</span>. For example, if you access <span class="ph">Heretto CCMS</span> at <code class="ph codeph">https://thunderbird.heretto.com</code>, use <code class="ph codeph">thunderbird</code> as the <code class="ph codeph">organizationId</code>.</p>
        </section><section class="section"><h2 class="title sectiontitle" id="important-considerations-0">Important Considerations</h2>
            
            <ul class="ul"><li class="li">
                    <p class="p">The <span class="ph">Heretto CCMS</span> API doesn't support bulk updates. You can work on only one object per request.</p>
                </li><li class="li">
                    <p class="p">The API supports pagination for endpoints that return large result sets, such as publishing history and scenario listings. Use the <span class="keyword parmname">page</span>(zero-indexed) and <span class="keyword parmname">size</span>(default: 20, maximum: 100) query parameters to navigate through results. Responses include metadata such as <code class="ph codeph">totalPages</code>, <code class="ph codeph">totalElements</code>, and<code class="ph codeph">numberOfElements</code>to help you implement pagination controls.</p>
                </li></ul>
        </section></div></article></main></body>

The CCMS API supports Basic Authentication and SSO Cookie Authentication for secure access.

CCMS API Authentication

The Heretto CCMS API (v2) enables programmatic access to publishing and deployment operations within the Heretto Component Content Management System (CCMS). This REST API enables you to automate publishing workflows, manage deployments, retrieve publishing outputs, and configure publishing scenarios.

CCMS API Overview

Content Operations Platform For Knowledge Management | Heretto

Learn how to author, review, manage, translate, and publish to multiple channels

Heretto CCMS

Learn how to dynamically distribute your content to any audience, anytime

Heretto Portal

April 2026

March 2026

February 2026

Welcome to 2026! Read on to learn what's changed in   Heretto products.

January 2026

New versions of Heretto products are here! Read on to learn what has changed. 🚀

December 2025

November 2025

October 2025

New versions of  Heretto products are here! Read on to learn what has changed. 🚀

September 2025

August 2025

June 2025

July 2025

May 2025

Explore the new updates and improvements in new Heretto  products versions!

April 2025

March 2025

February 2025

2025 is here and so are  new versions of Heretto products! 🎉

January 2025

December 2024

Explore the new updates and improvements in new  Heretto products versions!

November 2024

October is here and so are new versions of Heretto software!  Read on to learn what's new.

October 2024

Welcome September! We continue to improve and enhance our product lines. Read on to learn what's new with Heretto.

September 2024

August 2024

Welcome to the second half of 2024! We're continuing to make performance enhancements and other updates to improve your Heretto experience. Read on to learn what has changed. 🚀

July 2024

June 2024

May 2024

April 2024

March 2024

February 2024

New versions of Heretto products are here! Read on to learn what has changed. ✨

January 2024

December 2023

New versions of Heretto products are here! Read on to learn what has changed! ✨

Under maintenance

Heretto Help

June 2026

June 3, 2026

Footer Section

Our Support Team is here to help