sebastian-rodrigues.jpg

Sebastian Rodrigues

<p>In 2022, the name of the game when it comes to enterprise success is innovation. Not only did an impressive 95% of people say they <a href="https://newsroom.accenture.com/news/covid-19-has-sparked-a-new-wave-of-innovation-across-consumer-industries-according-to-accenture-research.htm" target="_blank">changed their lives in a permanent way over the last year</a>—an equally remarkable <a href="https://www.contentstack.com/blog/all-about-headless/commerce-meet-consumer-demands-with-ai-and-omnichannel-cms/" target="_self">88% now expect brands to change and innovate in a similar way</a>, specifically when it comes to their digital initiatives. </p>
<p></p>
<p>It has never been more important to experiment with and release innovative new online experiences. And, ​​with Contentstack Branches, it has never been easier or faster to do confidently. </p><h2>Innovation's New Safe Place: Contentstack Branches</h2>
<p>Similar to Git’s branching methodology with which many developers are familiar, Contentstack Branches enables developers to create branches, or “versions,” of code and content.</p>
<p></p>
<p>These separate branches both accelerate and remove risk from the innovation process by creating safe spaces where your business can build out “experience variations” without worrying about breaking the functionality you already have in place.</p>
<p></p>
<p>What makes our Branches feature so unique is that Contentstack is the only headless content management system (CMS) where businesses can work with branches in production environments. Unlike other CMSs that only support experimentation in development and QA environments, with Contentstack Branches you can build and test each experience variation on key segments of your audience to make sure it’s perfected before being rolled out to your entire customer base.</p>
<p></p>
<p>This is how Contentstack Branches empowers even the biggest enterprises to employ cross-functional growth-hacking methodologies that will accelerate development and increase the returns from your innovative digital initiatives. </p><h2>How Your Business Can Use Contentstack Branches</h2>
<p>There are many ways that Branches can be applied across the enterprise business, including:  </p><ul><li>One of the most important benefits of Contentstack Branches is that it enables businesses to test — including A/B test — the effectiveness of innovative new changes quickly and on small audience segments before committing to rolling them out on a large scale. </li><li>In addition to user testing, with Contentstack Branches, innovative new developments can be “QA’d” (Quality Assurance tested) in a realistic environment to make sure they’re in tip-top functional shape.</li><li>The Contentstack Branches functionality allows for different teams to innovate on dedicated aspects of the experience in tandem, with none “overlapping” in a way that affects each other’s projects  — or the live experience.</li><li>Branches doesn’t just support developers. It also supports key Contentstack functionality like roles and workflows so business teams and technical teams can collaborate on the same playing field.</li><li>For situations where you’re launching a large update or managing multiple brands, Contentstack Branches allows businesses to run development teams in parallel to accelerate delivery without taking any rushed shortcuts.  </li><li>Branches makes it easy for development teams to enact continuous integration and continuous delivery (CI/CD), a modern best practice in the IT world. </li><li>Whether you’re rolling out cutting-edge innovations or just keeping up with changing world events, Contentstack Branches enables robust new campaigns to be designed, developed, and launched quickly. And these campaigns can just as easily live on permanently or be rolled back as needed. </li><li>Current customers will be able to save incalculable effort by <a href="https://www.contentstack.com/docs/developers/set-up-stack/about-stack/" target="_self">replacing a large number of their stacks</a> with Contentstack Branches, which can be easier to sync, faster to spin up, and help take the load off your system.</li></ul><h2>See for Yourself How Contentstack Can Empower Innovation Across Your Whole Business</h2>
<p>At Contentstack, we continue to invest equally in both business and technology stakeholders. And it’s because of this uniquely close and thoughtful relationship with our customers that we uncovered a need that most modern enterprises have—the need for a feature-rich CMS that doesn’t just support developers, but also empowers the entire business to collaborate on digital innovation.</p>
<p></p>
<p>Are you ready to differentiate your brand, enable powerful cross-departmental collaboration, and remove risk from your digital operations all with a single platform? </p>
<p></p>
<p><a href="https://www.contentstack.com/company/contact-us/" target="_self">Get in touch with our team today</a> or <a href="https://www.contentstack.com/request-demo/" target="_self">schedule a free demo</a> to “Next Your CMS” and take advantage of our innovative Contenstack Branches feature. </p>

In 2022, the name of the game when it comes to enterprise success is innovation. Not only did an impressive 95% of people say they 

, specifically when it comes to their digital initiatives.

It has never been more important to experiment with and release innovative new online experiences. And, ​​with Contentstack Branches, it has never been easier or faster to do confidently.

Innovation's New Safe Place: Contentstack Branches

Similar to Git’s branching methodology with which many developers are familiar, Contentstack Branches enables developers to create branches, or “versions,” of code and content.

These separate branches both accelerate and remove risk from the innovation process by creating safe spaces where your business can build out “experience variations” without worrying about breaking the functionality you already have in place.

What makes our Branches feature so unique is that Contentstack is the only headless content management system (CMS) where businesses can work with branches in production environments. Unlike other CMSs that only support experimentation in development and QA environments, with Contentstack Branches you can build and test each experience variation on key segments of your audience to make sure it’s perfected before being rolled out to your entire customer base.

This is how Contentstack Branches empowers even the biggest enterprises to employ cross-functional growth-hacking methodologies that will accelerate development and increase the returns from your innovative digital initiatives.

How Your Business Can Use Contentstack Branches

There are many ways that Branches can be applied across the enterprise business, including:

See for Yourself How Contentstack Can Empower Innovation Across Your Whole Business

At Contentstack, we continue to invest equally in both business and technology stakeholders. And it’s because of this uniquely close and thoughtful relationship with our customers that we uncovered a need that most modern enterprises have—the need for a feature-rich CMS that doesn’t just support developers, but also empowers the entire business to collaborate on digital innovation.

Are you ready to differentiate your brand, enable powerful cross-departmental collaboration, and remove risk from your digital operations all with a single platform?

 to “Next Your CMS” and take advantage of our innovative Contenstack Branches feature.

branches-tree.png

Contentstack Branches Empower Business and Development Teams to Innovate in Tandem

<p>If you have worked with Git, Mercurial or other software with version or source control capabilities, you’re familiar with the concept of branching. Branches allow you to create copies of content-type structures (schemas) to make changes and iterate without the risk of affecting what’s live on the production server. Working with branches makes life extremely easy for developers.</p>
<p></p>
<p>To that end, we are excited to announce that Contentstack now offers branches.</p>
<p></p>
<p>Branching capabilities support roles and workflows for better collaboration between developers and business users. Branches make it easier for developers to work concurrently on multiple releases without affecting content creation. Branches are covered by your plan’s production SLAs, allowing you to test the effectiveness of experience variations against live audience segments. Let’s look at how this feature works and the benefits it offers.</p><h2>How Branches Work in Contentstack</h2>
<p>If you have used any CMS as a developer, you know how risky it is to make changes to the content type or structure of a page that’s already live. Any unintentional error may cause data loss or even take your application down.</p>
<p></p>
<p>Thankfully, you now have branches in Contentstack. If you want to change an existing content type, you can create a new branch, even on the production server. Adding a branch creates a copy of all the current content types, entries, assets, languages, extensions and releases of the source branch. Any subsequent changes that you make to the content of this new branch will have no impact on the content of the source branch (or any other branch that your production server uses). It will start an independent line of development and content changes.</p>
<p></p><figure style="margin: auto; text-align: center;width: autopx;"><img alt="Diagram of Branches content structure" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/blt116d7ca2da813a15/62192a05c645370e582d4673/branches-diagram.jpeg" data-image="a1cp4uukazdf"></figure>
<p></p>
<p>You can try new changes, iterate and publish in a testing environment with this new branch. Branches can have separate tokens, webhooks and audit logs, so developers can try out changes and track all activities. It’s like having a separate space for your development work.</p>
<p></p>
<p>Each branch has a dedicated publish queue, content trash and workflows, enabling cross-functional collaboration with content managers who are modifying content.</p>
<p></p>
<p>Once you are sure that changes are correct, you can make this new branch your main branch for an environment.</p>
<p></p>
<p>In a multi-environment setting, changing the main branch often would mean making frequent changes to the branch configuration in your front-end code. To make mapping in multi-environments easier, we have aliases.</p><h2>What Are Aliases?</h2>
<p>An alias acts as a pointer to a particular branch. You need to use the alias ID in your front-end code. Once changes in your branch are ready to go, you can set that branch as the target branch for an alias. You are not required to make changes to your code every time. In other words, when you point a branch to an alias, that branch acts as the main branch for the corresponding environment. You can read our <a href="https://www.contentstack.com/docs/developers/branches/about-aliases/" target="_self">documentation on aliases</a> to learn more about them.</p><h2>Why Do You Need Branches?</h2>
<p>Here are some reasons why branches are helpful to you and your company:</p><ul><li>Branches allow you to easily manage your “in-progress” work, which can be separate from your live and stable work in the production environment.</li><li>For companies targeting higher release velocity, branches allow teams to work in parallel instead of one after the other.</li><li>With separate roles and workflows set up for each branch, development teams can work together with business and marketing in a more collaborative, organized and structured manner.</li><li>Should something go wrong, branches make rolling back changes incredibly easy.</li></ul><h2>Breaking Changes to Keep in Mind</h2>
<p>This feature release will introduce a change in the API responses returned for several <a href="https://www.contentstack.com/docs/developers/apis/content-delivery-api/" target="_self">Content Delivery API (CDA) / CDN</a> and <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/" target="_self">Content Management API (CMA)</a> requests. To ensure a smooth transition when you start using branches, we have listed below a few breaking changes in the API that you might need to update within your back-end code.</p>
<p>[Breaking] Additional "branch" Key in Webhook-related API Responses</p>
<p>If the "Branches'' feature is part of your plan, all webhook-related API requests that hit the Content Management API (CMA) will return the branch key in the response body. This key specifies the unique ID of the branch on which the concerned webhook was triggered.</p>
<p></p>
<p>Here's a sample of the webhook data with the branch key:</p>
<pre>{
   "module":"entry",
   "api_key":"blt38776c9acaae33b3",
   "event":"update",
   "triggered_at":"2020-10-14T14:40:54.157Z",
   "data":{
      "entry":{
         "uid":"blt36952eb1aa651010",
         "title":"Sample Entry",
         "locale":"en-us",
         "_version":7
      },
      "content_type":{
         "uid":"footer",
         "title":"Footer"
      },
      "branch":{
         "uid":"main"
      }
   }
}
</pre>
<p></p>
<p>Additional "branches" and "branch_aliases" Keys to Specify Branch/Alias Scope in Responses</p>
<p>If the Branches feature is part of your plan, you will see additional keys named branches and branch_aliases in the API responses in some of the Contentstack modules (listed below). These keys specify the unique IDs of the branches and aliases selected within the scope for the concerned modules.</p><ul><li>Webhooks, Workflows and Publish Rules-related API requests that hit the Content Management API (CMA) will return a top-level branches key in the response body. This key specifies the unique IDs of the branches to which these modules are applicable. For instance, here’s the response that you will get for the <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-webhooks/" target="_self">get all webhooks</a> API request:</li></ul>
<pre>{
   "webhooks":[
      {
         "uid":"blt789920f4d2650336",
         "branches":[
            "main"
         ],
         "channels":[
            "content_types.update"
         ],
         "disabled":false,
         "concise_payload":true,
         "Name":"Sample Webhook",
         "destinations":[
            {
               "target_url":"https://example-site.com",
               "http_basic_auth":"",
               "http_basic_password":"",
               "custom_header":[
                  {
                     "value":"",
                     "header_name":""
                  }
               ]
            }
         ],
         "retry_policy":"manual",
         "org_uid":"bltd1cd127c7b51f410",
         "updated_by":"blt1fd0057b90905592",
         "created_by":"blt1fd0057b90905592",
         "created_at":"2021-08-26T19:38:29.596Z",
         "updated_at":"2021-08-26T19:38:29.596Z"
      }
   ]
}
</pre>
<p></p><ul><li>Delivery Token and Management Token-related API requests that hit the Content Management API (CMA) will return the branches and branch_aliases keys under the scope section in the response body. These keys specify the unique IDs of the branches and branch aliases for which a delivery or management token is applicable. For instance, here’s the response that you will get for the <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-delivery-tokens/" target="_self">get all delivery tokens</a> API request:</li></ul>
<pre>{
    "tokens": [
        {
            "description": "Sample token to fetch content.",
            "name": "Sample Delivery Token",
            "scope": [
                {
                    "environments": [
                        ...
                    ],
                    "module": "environment",
                    "acl": {
                        "read": true
                    },
                    "_metadata": {
                        "uid": "cs48231eccb8125898"
                    }
                },
                {
                    "module": "branch",
                    "acl": {
                        "read": true
                    },
                    "branches": [
                        "main",
                        "development"
                    ],
                    "_metadata": {
                        "uid": "cs81f7766198897700"
                    }
                },
                {
                    "module": "branch_alias",
                    "acl": {
                        "read": true
                    },
                    "branch_aliases": [
                        "demo",
                        "release"
                    ],
                    "_metadata": {
                        "uid": "cs7e7ee9b555e9f021"
                    }
                }
            ],
            ...
            }
        }
    ]
}
</pre>
<p></p><ul><li>Organization User-related API requests that hit the Content Management API (CMA) will return the branches and branch_aliases keys under the rules section in the response body. These keys specify the unique IDs of the branches and branch aliases of which a particular user role can access data. If a user has access to the content present in all the stack branches, then the branches or branch_aliases keys return the $all value. For instance, here’s how the "rules" section would look in the response for the <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-user/" target="_self">get user</a> API request:</li></ul>
<pre>{
   "uid":"blt969408c7c448a4d5",
   "name":"Content Manager",
   "description":"Content Manager Role.",
   "users":[
      "blt1fd0057b90905592"
   ],
   "roles":[

   ],
   "created_at":"2021-07-26T10:04:20.765Z",
   "updated_at":"2021-07-27T07:22:08.875Z",
   "api_key":"bltadd6b6032484ce86",
   "rules":[
      {
         "module":"branch",
         "branches":[
            "main"
         ]
      },
      {
         "module":"branch_alias",
         "branch_aliases":[
            "$all"
         ]
      },
      {
         "module":"locale",
         "locales":[
            "$all"
         ]
      },
      {
         "module":"environment",
         "environments":[
            "$all"
         ]
      },
      {
         "module":"asset",
         "assets":[
            "$all"
         ],
         "acl":{
            ...
         }
      }
   ]
}
</pre><h2>[Breaking] Updated Asset Download URL Format as per Branch</h2>
<p>If the Branches feature is part of your plan, you will see an updated download URL format for all assets part of any branch, except the default main branch. The branch={branch_UID} query parameter is attached to the download URL.</p>
<p></p>
<p>For instance, if you upload an asset to the development branch, Contentstack generates the following asset download URL:</p>
<p>https://assets.contentstack.com/v3/assets/blt252b550c5ccdae26/bltc56f275260214c0b/61280d9625aca65092ce7f15/Sample_Image.jpg?branch=development</p>
<p></p>
<p>For any asset that you upload to the main branch, Contentstack will continue to generate asset download URLs in the earlier format:</p>
<p>https://assets.contentstack.com/v3/assets/blt252b550c5ccdae26/bltc56f275260214c0b/61280d9625aca65092ce7f15/Sample_Image.jpg</p><h3>Support "include_branch" as Query Parameter in CMA and CDA API Requests</h3>
<p>If the Branches feature is part of your plan, you can pass the include_branch query parameter while running <a href="https://www.contentstack.com/docs/developers/apis/content-delivery-api/" target="_self">Content Delivery API (CDA) / CDN</a> and <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/" target="_self">Content Management API (CMA)</a> requests. Set the include_branch key to true to allow the API to return the _branch key in the response. This key specifies the unique ID of the branch and helps identify where the concerned Contentstack module resides.</p>
<p></p>
<p>Here’s the list of the components that support the include_branch query parameter:</p><ul><li>Content Types [CDA / CMA]</li><li>Global fields [CDA / CMA]</li><li>Assets [CDA / CMA]</li><li>Entries [CDA / CMA]</li><li>Extensions</li><li>Languages</li><li>Releases</li><li>Audit Log</li><li>Publish Queue</li><li>Workflows</li><li>Publish Rules</li><li>Webhooks</li></ul>
<p></p>
<p>Let’s look at an example of how the response would look when you pass the include_branch query parameter. Here’s the response you will get for the <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-content-types/" target="_self">get all content types</a> API request:</p>
<pre>{
    "content_types": [
        {
            ...,
            "schema": [
                {
                    "display_name": "Title",
                    ...
                },
                {
                    "display_name": "URL",
                    ...
                },
            ],
            "last_activity": {},
            "maintain_revisions": true,
            "description": "",
            "DEFAULT_ACL": {
                "others": {
                    "read": false,
                    "create": false
                },
                "users": [
                    {
                        "read": true,
                        "sub_acl": {
                            "read": true
                        },
                        "uid": "blt690a3fed2a593445"
                    }
                ],
                "management_token": {
                    "read": true
                }
            },
            "SYS_ACL": {
                "roles": [
                    {
                        "uid": "bltdc9d89cd41565777",
                        "read": true,
                        "sub_acl": {
                            ...
                        },
                        "update": true,
                        "delete": true
                    },
                    {
                        ... 
                        }
                    },
                    {
                        ...
                        },
                        ...
                    }
                ],
                "others": {
                    ...
                    }
                }
            },
            "_branch": "development",
            "options": {
                "title": "title",
                "publishable": true,
                "is_page": true,
                "singleton": false,
                "sub_title": [
                    "url"
                ],
                "url_pattern": "/:title",
                "url_prefix": "/"
            },
            "abilities": {
                "get_one_object": true,
                "get_all_objects": true,
                "create_object": true,
                "update_object": true,
                "delete_object": true,
                "delete_all_objects": true
            }
        }
    ]
}
</pre><h2>Get Started With Branches</h2>
<p>The Branches feature will be rolled out to all customers gradually over the next few weeks. It is available in Contentstack only for the new interface. All the stacks in your organization will now have a “default” branch, and you can create more branches from there. The number of branches available depends on your plan. You can read our <a href="https://www.contentstack.com/docs/developers/branches/" target="_self">documentation on branches</a> to learn more or reach out to <a href="mailto:support@contentstack.com">support@contentstack.com</a></p>
<p></p>
<p></p>

If you have worked with Git, Mercurial or other software with version or source control capabilities, you’re familiar with the concept of branching. Branches allow you to create copies of content-type structures (schemas) to make changes and iterate without the risk of affecting what’s live on the production server. Working with branches makes life extremely easy for developers.

To that end, we are excited to announce that Contentstack now offers branches.

Branching capabilities support roles and workflows for better collaboration between developers and business users. Branches make it easier for developers to work concurrently on multiple releases without affecting content creation. Branches are covered by your plan’s production SLAs, allowing you to test the effectiveness of experience variations against live audience segments. Let’s look at how this feature works and the benefits it offers.

If you have used any CMS as a developer, you know how risky it is to make changes to the content type or structure of a page that’s already live. Any unintentional error may cause data loss or even take your application down.

Thankfully, you now have branches in Contentstack. If you want to change an existing content type, you can create a new branch, even on the production server. Adding a branch creates a copy of all the current content types, entries, assets, languages, extensions and releases of the source branch. Any subsequent changes that you make to the content of this new branch will have no impact on the content of the source branch (or any other branch that your production server uses). It will start an independent line of development and content changes.

You can try new changes, iterate and publish in a testing environment with this new branch. Branches can have separate tokens, webhooks and audit logs, so developers can try out changes and track all activities. It’s like having a separate space for your development work.

Each branch has a dedicated publish queue, content trash and workflows, enabling cross-functional collaboration with content managers who are modifying content.

Once you are sure that changes are correct, you can make this new branch your main branch for an environment.

In a multi-environment setting, changing the main branch often would mean making frequent changes to the branch configuration in your front-end code. To make mapping in multi-environments easier, we have aliases.

An alias acts as a pointer to a particular branch. You need to use the alias ID in your front-end code. Once changes in your branch are ready to go, you can set that branch as the target branch for an alias. You are not required to make changes to your code every time. In other words, when you point a branch to an alias, that branch acts as the main branch for the corresponding environment. You can read our 

Here are some reasons why branches are helpful to you and your company:

This feature release will introduce a change in the API responses returned for several 

 requests. To ensure a smooth transition when you start using branches, we have listed below a few breaking changes in the API that you might need to update within your back-end code.

[Breaking] Additional "branch" Key in Webhook-related API Responses

If the "Branches'' feature is part of your plan, all webhook-related API requests that hit the Content Management API (CMA) will return the branch key in the response body. This key specifies the unique ID of the branch on which the concerned webhook was triggered.

Here's a sample of the webhook data with the branch key:

Additional "branches" and "branch_aliases" Keys to Specify Branch/Alias Scope in Responses

If the Branches feature is part of your plan, you will see additional keys named branches and branch_aliases in the API responses in some of the Contentstack modules (listed below). These keys specify the unique IDs of the branches and aliases selected within the scope for the concerned modules.

{
    "tokens": [
        {
            "description": "Sample token to fetch content.",
            "name": "Sample Delivery Token",
            "scope": [
                {
                    "environments": [
                        ...
                    ],
                    "module": "environment",
                    "acl": {
                        "read": true
                    },
                    "_metadata": {
                        "uid": "cs48231eccb8125898"
                    }
                },
                {
                    "module": "branch",
                    "acl": {
                        "read": true
                    },
                    "branches": [
                        "main",
                        "development"
                    ],
                    "_metadata": {
                        "uid": "cs81f7766198897700"
                    }
                },
                {
                    "module": "branch_alias",
                    "acl": {
                        "read": true
                    },
                    "branch_aliases": [
                        "demo",
                        "release"
                    ],
                    "_metadata": {
                        "uid": "cs7e7ee9b555e9f021"
                    }
                }
            ],
            ...
            }
        }
    ]
}


{
   "uid":"blt969408c7c448a4d5",
   "name":"Content Manager",
   "description":"Content Manager Role.",
   "users":[
      "blt1fd0057b90905592"
   ],
   "roles":[

   ],
   "created_at":"2021-07-26T10:04:20.765Z",
   "updated_at":"2021-07-27T07:22:08.875Z",
   "api_key":"bltadd6b6032484ce86",
   "rules":[
      {
         "module":"branch",
         "branches":[
            "main"
         ]
      },
      {
         "module":"branch_alias",
         "branch_aliases":[
            "$all"
         ]
      },
      {
         "module":"locale",
         "locales":[
            "$all"
         ]
      },
      {
         "module":"environment",
         "environments":[
            "$all"
         ]
      },
      {
         "module":"asset",
         "assets":[
            "$all"
         ],
         "acl":{
            ...
         }
      }
   ]
}


[Breaking] Updated Asset Download URL Format as per Branch

If the Branches feature is part of your plan, you will see an updated download URL format for all assets part of any branch, except the default main branch. The branch={branch_UID} query parameter is attached to the download URL.

For instance, if you upload an asset to the development branch, Contentstack generates the following asset download URL:

https://assets.contentstack.com/v3/assets/blt252b550c5ccdae26/bltc56f275260214c0b/61280d9625aca65092ce7f15/Sample_Image.jpg?branch=development

For any asset that you upload to the main branch, Contentstack will continue to generate asset download URLs in the earlier format:

https://assets.contentstack.com/v3/assets/blt252b550c5ccdae26/bltc56f275260214c0b/61280d9625aca65092ce7f15/Sample_Image.jpg

Support "include_branch" as Query Parameter in CMA and CDA API Requests

If the Branches feature is part of your plan, you can pass the include_branch query parameter while running 

 requests. Set the include_branch key to true to allow the API to return the _branch key in the response. This key specifies the unique ID of the branch and helps identify where the concerned Contentstack module resides.

Here’s the list of the components that support the include_branch query parameter:

Let’s look at an example of how the response would look when you pass the include_branch query parameter. Here’s the response you will get for the 

{
    "content_types": [
        {
            ...,
            "schema": [
                {
                    "display_name": "Title",
                    ...
                },
                {
                    "display_name": "URL",
                    ...
                },
            ],
            "last_activity": {},
            "maintain_revisions": true,
            "description": "",
            "DEFAULT_ACL": {
                "others": {
                    "read": false,
                    "create": false
                },
                "users": [
                    {
                        "read": true,
                        "sub_acl": {
                            "read": true
                        },
                        "uid": "blt690a3fed2a593445"
                    }
                ],
                "management_token": {
                    "read": true
                }
            },
            "SYS_ACL": {
                "roles": [
                    {
                        "uid": "bltdc9d89cd41565777",
                        "read": true,
                        "sub_acl": {
                            ...
                        },
                        "update": true,
                        "delete": true
                    },
                    {
                        ... 
                        }
                    },
                    {
                        ...
                        },
                        ...
                    }
                ],
                "others": {
                    ...
                    }
                }
            },
            "_branch": "development",
            "options": {
                "title": "title",
                "publishable": true,
                "is_page": true,
                "singleton": false,
                "sub_title": [
                    "url"
                ],
                "url_pattern": "/:title",
                "url_prefix": "/"
            },
            "abilities": {
                "get_one_object": true,
                "get_all_objects": true,
                "create_object": true,
                "update_object": true,
                "delete_object": true,
                "delete_all_objects": true
            }
        }
    ]
}


The Branches feature will be rolled out to all customers gradually over the next few weeks. It is available in Contentstack only for the new interface. All the stacks in your organization will now have a “default” branch, and you can create more branches from there. The number of branches available depends on your plan. You can read our 

web-development-tools-diagrams.png

Manage Development Workflows with ‘Branches’

<p>Using a headless CMS is critical in today’s omnichannel-driven digital world, where content delivery is not limited to websites.</p><p>Equally important is that marketers can see how content appears on various channels before publishing content on the live site. Using a headless system typically meant publishing the content to staging or preview environments after content creation and checking different resolutions or devices. And if there are changes, then save, publish, and check again. In short: too many clicks, too many steps.</p><p>Introducing <strong>Live Preview:</strong> See how your content and pages look on various channels in real-time while creating content without having to save and publish. This preview speeds up content creation and ensures your brand looks precisely like you intended. At the same time, Contentstack retains the power of headless CMS for omnichannel delivery.</p><h2>How Live Preview Works in Contentstack</h2><p>Live Preview is not an add-on or an extension. It is part of the native Contentstack application. Enable it, and all your content editors will see the preview right on the entry editor page, within the sidebar panel, or in full-screen mode.</p><p>Let’s check out what you can do with Live Preview.</p><h3>Preview Content on Different Devices</h3><p>The Live Preview pane allows you to preview content across three default platforms: <strong>Mobile</strong>, <strong>Tablet</strong>, and <strong>Desktop</strong>. Selecting one of these options sets the Live Preview pane to the width of the specified digital platform.</p><p></p><figure style = "margin: auto; text-align: center;width: auto;"><img alt="preview-content-on-different-devices.gif" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/bltfffc46d88d0d53f1/616f4481b685fa1bb5819940/preview-content-on-different-devices.gif" data-image="c2jxnek99e1n" /></figure><h3>Track and Edit Content in Real-Time</h3><p>Marketers can click on a specific content block in the Live Preview window to quickly traverse to the corresponding field and edit and preview the changes side by side. This includes changing the block layout of the page.</p><p></p><figure style = "margin: auto; text-align: center;width: auto;"><img alt="edit-content-in-preview-pane.gif" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/blt7c3c623895477049/616f4516da02001d99f28478/edit-content-in-preview-pane.gif" data-image="3qdlw3oqfjpn" /></figure><h3>Preview Content on Different Environments</h3><p>Within the preview window, you can switch between different environments, e.g., production and development, to check whether your content looks the same throughout.</p><p></p><figure style = "margin: auto; text-align: center;width: auto;"><img alt="preview-content-different-environments.png" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/blt24a4b51a1764cc0f/616f45fd428dce288b072c17/preview-content-different-environments.png" data-image="4rohdovitkk5" /></figure><h3>Varied Preview Window Sizes For Legibility</h3><p>With a simple click of a button, you can instantly maximize or minimize the preview window or preview content in a new browser window.</p><h2>Benefits of Live Preview</h2><h3>For Content Managers and Business Users:</h3><ul><li><strong>Omnichannel preview experience:</strong> Content managers can seamlessly preview content across multiple channels, such as mobile devices, tablets, and desktops.</li><li><strong>Real-time content edits:</strong> Content managers can click on the “Edit” icon beside any content sections in the Live Preview window to navigate to the corresponding field in the editor, where they can edit and watch the changes reflected in real-time.</li><li><strong>Test website content changes instantly:</strong> You can preview content to see how it displays across different digital platforms without publishing or saving the changes. Live Preview lets you test content changes in different website sections to see how it appears on a webpage.</li></ul><h3>For Developers:</h3><ul><li><strong>Scope for innovation and enhancement:</strong> Live Preview is part of the native Contentstack app, rather than an add-on or an extension. This ensures that the feature stays in sync with core development and innovation.</li><li><strong>Content schema remains intact:</strong> The actual content entry remains JSON-structured, so developers can keep modeling content as and when required and deliver it into any frontend framework.</li></ul><h2>How to Set Up Live Preview for Contentstack-powered Websites</h2><p>To allow content managers to use the “Live Preview” option in all of the entries in your stack, you need to perform the following steps:</p><ol><li>Navigate to the <strong>Live Preview</strong> section under stack’s “Settings.”</li><li>Select the <strong>Enable Live Preview</strong> checkbox.</li><li>Select a default URL and environment for previewing live content across all entries of your stack.</li><li><strong>Save</strong> the settings.</li></ol><p>You will now see a live preview of the default environment and URL in all entries. These settings can also be updated when on the entry page to preview content across different scenarios.</p><h2>Try Out Live Preview</h2><p>“Live Preview” is a plan-based feature and is only available in the new Contentstack interface. You can read our documentation on <a href="/docs/content-managers/author-content/#work-with-live-preview" target="_blank">Live Preview</a> to learn more or reach out to our <a href="mailto:support@contentstack.com" target="_blank">Support team</a> if you have any questions.</p>

Using a headless CMS is critical in today’s omnichannel-driven digital world, where content delivery is not limited to websites.

Equally important is that marketers can see how content appears on various channels before publishing content on the live site. Using a headless system typically meant publishing the content to staging or preview environments after content creation and checking different resolutions or devices. And if there are changes, then save, publish, and check again. In short: too many clicks, too many steps.

 See how your content and pages look on various channels in real-time while creating content without having to save and publish. This preview speeds up content creation and ensures your brand looks precisely like you intended. At the same time, Contentstack retains the power of headless CMS for omnichannel delivery.

Live Preview is not an add-on or an extension. It is part of the native Contentstack application. Enable it, and all your content editors will see the preview right on the entry editor page, within the sidebar panel, or in full-screen mode.

Let’s check out what you can do with Live Preview.

The Live Preview pane allows you to preview content across three default platforms: 

. Selecting one of these options sets the Live Preview pane to the width of the specified digital platform.

Marketers can click on a specific content block in the Live Preview window to quickly traverse to the corresponding field and edit and preview the changes side by side. This includes changing the block layout of the page.

Preview Content on Different Environments

Within the preview window, you can switch between different environments, e.g., production and development, to check whether your content looks the same throughout.

Varied Preview Window Sizes For Legibility

With a simple click of a button, you can instantly maximize or minimize the preview window or preview content in a new browser window.

How to Set Up Live Preview for Contentstack-powered Websites

To allow content managers to use the “Live Preview” option in all of the entries in your stack, you need to perform the following steps:

You will now see a live preview of the default environment and URL in all entries. These settings can also be updated when on the entry page to preview content across different scenarios.

“Live Preview” is a plan-based feature and is only available in the new Contentstack interface. You can read our documentation on 

live-preview-hero-image.png

Introducing “Live Preview” – Preview Content Updates on the Go

<p>Among all the components of a modern content editor platform, the rich text editor remains an integral part of the content creation process. And for developers, it continues to be a huge pain. As newer channels of consumption emerge, rendering rich-text content across all digital platforms is becoming harder. </p>
<p>With the introduction of the new JSON Rich Text Editor (RTE), we intend to make life easier for content managers and developers. Editors no longer have to undergo the hassle of handling HTML source code while editing rich text content. And since the editor returns the saved content in JSON format, developers can easily serialize the data in any human-readable format, paving the way for a truly omnichannel experience for customers.  </p>
<p><strong>Note</strong>: The JSON RTE is available only in the new Contentstack interface.</p><h2>A Delightful, Focused Writing Experience for Content Editors</h2>
<p>The new JSON RTE field offers a beautiful editor for content managers with all the formatting options and functionalities of our existing HTML-based RTE, minus the HTML code view. This editor frees the content managers from the hassle of handling HTML source code, so they can focus on creating quality content and nothing else. </p><p style="margin-top: auto;margin-right: auto;margin-bottom: auto;margin-left: auto;text-align: center;"><img data-image="w9mjwgxe4vkj" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/blta33467949ad37d23/60f5a18061f38746a5776d1d/json-rte-formatting.png" data-sys-asset-uid="blta33467949ad37d23" alt="json-rte-formatting.png"></p>
<p>Each element, such as paragraphs, images, lists, etc., is treated as a separate block, so editors can simply drag and drop them within the body text instead of cutting and pasting content. To apply custom styles, editors can choose from the many “properties” that the developer can add to the RTE.</p><p style="margin-top: auto;margin-right: auto;margin-bottom: auto;margin-left: auto;text-align: center;"><img data-image="gjn1n3p3qudh" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/blt5ab44a564ea60b12/60f6f616e2de935fc7e35cb9/json-rte-drag-and-drop-text.gif" data-sys-asset-uid="blt5ab44a564ea60b12" alt="json-rte-drag-and-drop-text.gif"></p>
<p>The rest of the components are the same as our HTML-based RTE, visually.</p><h2>We Love Our HTML Rich-Text Editor, but...</h2>
<p>Our HTML-based RTE field is incredible. There is no doubt about it. It provides a single content-editable element for adding HTML markup, allowing web browsers to consume and render content easily. It serves its purpose well, and it works like a charm… until you want to cater to a variety of platforms; or you want to reuse content for a separate frontend framework; or you want to save the data for what it is, without coupling it with the way it should be presented. </p>
<p>The content of an HTML-based RTE is stored in raw HTML format, which means it stores content data along with markups for content appearance. This may have specific limitations, especially for cases that require quick and easy backend processing, rendering content on different channels, and evolving faster. Data in this format makes it challenging to write code that can transform rich text quickly or display it in different channels. </p><h2>The New JSON RTE Helps Developers Become Future-Ready</h2><h3>Structured Data for Easy Parsing</h3>
<p>The new block-style JSON editor stores and returns data in a structured JSON format. Each element (such as a paragraph) is a block; each block is an array; each array has multiple children, storing the actual text and the different nodes associated with the text. </p>
<p>This format gives developers more control over the information, ease of performing any backend processing, and the ability to serialize the data in any human-readable format. Data in this format enables you to use any frontend of your choice for a true omnichannel experience: HTML for web browsers, render natively for mobile apps, audio versions for voice assistants, and so on, making your rich-text content truly reusable and future proof, especially for cases such as moving to a new presentation layer or redesigning an app. </p>
<p>Let’s look at an example to understand how the new JSON RTE stores and returns rich-text data. </p>
<p>If the JSON RTE contains the following text:</p><p style="margin-top: auto;margin-right: auto;margin-bottom: auto;margin-left: auto;text-align: center;"><img data-image="l2cobs7qch31" src="https://images.contentstack.io/v3/assets/bltc5a09bf374882538/blt5bd86e53b01b2029/60f5a1d8da6f75588bd8fd15/json-rich-text-editor.png" data-sys-asset-uid="blt5bd86e53b01b2029" alt="json-rich-text-editor.png"></p>
<p>The field output in the API response will be as follows:</p>
<pre>{
    "entry": {
        "title": "Entry 1",
        "url": "/entry-1",
        "tags": [
            "first entry"
        ],
        "locale": "en-us",
        "uid": "bltb6ea3a0ab9699748",
        "created_by": "blt702565fb0d35107f",
        "updated_by": "blt702565fb0d35107f",
        "created_at": "2020-11-13T14:15:50.389Z",
        "updated_at": "2021-07-09T11:41:05.883Z",
        "ACL": {},
        "_version": 2,
        "_in_progress": false,
        "json_rte": [
            {
                "uid": "fb1006018d73482aad018eadc8e6818f",
                "_version": 2,
                "attrs": {},
                "children": [
                    {
                        "type": "p",
                        "attrs": {},
                        "uid": "d0efa7610f06413499d09c8f61389d4c",
                        "children": [
                            {
                                "text": "This RTE is "
                            },
                            {
                                "text": "amazing",
                                "bold": true
                            },
                            {
                                "text": "."
                            }
                        ]
                    }
                ],
                "type": "doc"
            }
        ]
    }
}</pre>
<p>While you can convert this data back to HTML, we have a <a href="https://github.com/contentstack/json-rte-serializer" target="_blank">serializer package</a> that can help you do that quickly. </p><h2>Excited? Migrate Content From HTML RTE to JSON RTE</h2>
<p>There are certainly a ton of benefits of moving your content to the new JSON RTE. You can use our <a href="https://www.contentstack.com/docs/developers/cli/" target="_blank">CLI</a> to migrate the content of your existing HTML RTE fields to the new JSON RTE fields for all entries of a content type in just a few minutes. Refer to our <a href="https://www.contentstack.com/docs/developers/cli/migrate-content-from-html-rte-to-json-rte-using-the-cli/" target="_blank">migration guide</a> to perform the steps, understand the different flags you can use, and migrate the content safely without any data loss.</p><h2>Helpful Resources</h2>
<p>This blog only scratches the surface of the endless possibilities available using our new JSON RTE field. Read our documentation to understand how to use, configure, and customize this new field to do more with your content. </p><ul><li><a href="https://www.contentstack.com/docs/developers/json-rich-text-editor/" target="_blank">The new JSON RTE field</a> </li><li><a href="https://www.contentstack.com/docs/developers/cli/migrate-content-from-html-rte-to-json-rte-using-the-cli/" target="_blank">Migrating content from the HTML-based RTE field to the JSON RTE field using CLI</a> </li></ul>

Among all the components of a modern content editor platform, the rich text editor remains an integral part of the content creation process. And for developers, it continues to be a huge pain. As newer channels of consumption emerge, rendering rich-text content across all digital platforms is becoming harder.

With the introduction of the new JSON Rich Text Editor (RTE), we intend to make life easier for content managers and developers. Editors no longer have to undergo the hassle of handling HTML source code while editing rich text content. And since the editor returns the saved content in JSON format, developers can easily serialize the data in any human-readable format, paving the way for a truly omnichannel experience for customers.

: The JSON RTE is available only in the new Contentstack interface.

A Delightful, Focused Writing Experience for Content Editors

The new JSON RTE field offers a beautiful editor for content managers with all the formatting options and functionalities of our existing HTML-based RTE, minus the HTML code view. This editor frees the content managers from the hassle of handling HTML source code, so they can focus on creating quality content and nothing else.

Each element, such as paragraphs, images, lists, etc., is treated as a separate block, so editors can simply drag and drop them within the body text instead of cutting and pasting content. To apply custom styles, editors can choose from the many “properties” that the developer can add to the RTE.

The rest of the components are the same as our HTML-based RTE, visually.

We Love Our HTML Rich-Text Editor, but...

Our HTML-based RTE field is incredible. There is no doubt about it. It provides a single content-editable element for adding HTML markup, allowing web browsers to consume and render content easily. It serves its purpose well, and it works like a charm… until you want to cater to a variety of platforms; or you want to reuse content for a separate frontend framework; or you want to save the data for what it is, without coupling it with the way it should be presented.

The content of an HTML-based RTE is stored in raw HTML format, which means it stores content data along with markups for content appearance. This may have specific limitations, especially for cases that require quick and easy backend processing, rendering content on different channels, and evolving faster. Data in this format makes it challenging to write code that can transform rich text quickly or display it in different channels.

The New JSON RTE Helps Developers Become Future-Ready

The new block-style JSON editor stores and returns data in a structured JSON format. Each element (such as a paragraph) is a block; each block is an array; each array has multiple children, storing the actual text and the different nodes associated with the text.

This format gives developers more control over the information, ease of performing any backend processing, and the ability to serialize the data in any human-readable format. Data in this format enables you to use any frontend of your choice for a true omnichannel experience: HTML for web browsers, render natively for mobile apps, audio versions for voice assistants, and so on, making your rich-text content truly reusable and future proof, especially for cases such as moving to a new presentation layer or redesigning an app.

Let’s look at an example to understand how the new JSON RTE stores and returns rich-text data.

If the JSON RTE contains the following text:

The field output in the API response will be as follows:

While you can convert this data back to HTML, we have a 

Excited? Migrate Content From HTML RTE to JSON RTE

There are certainly a ton of benefits of moving your content to the new JSON RTE. You can use our 

 to migrate the content of your existing HTML RTE fields to the new JSON RTE fields for all entries of a content type in just a few minutes. Refer to our 

 to perform the steps, understand the different flags you can use, and migrate the content safely without any data loss.

This blog only scratches the surface of the endless possibilities available using our new JSON RTE field. Read our documentation to understand how to use, configure, and customize this new field to do more with your content.

json-rIch-text-editor_hero.png

Introducing the New JSON-powered, Block-Style Rich Text Editor

<p>Managing access governance over a composable technology stack is crucial for both security and end-user experience. Contentstack SAML 2.0 support enabled companies to provide seamless user management through Single Sign-On (SSO) since its introduction three years ago. </p>
<p>We are excited to announce support for <strong>SCIM 2.0 </strong>(in Beta), to simplify the automation of user provisioning further. This Beta release includes <strong>SCIM support for OneLogin</strong> and our <strong>SCIM 2.0 API</strong>.  </p><h2>SCIM 2.0 And How It Works</h2>
<p>SCIM (System for Cross-Domain Identity Management) is a proven and secure protocol for exchanging user identity information between various IT systems and services. Major identity providers (IdP), such as OneLogin, support SCIM as a common language to communicate with service providers such as Contentstack or other applications. </p>
<p>SCIM allows administrators to manage all users from a central location, enabling onboarding, offboarding, or changing user access in hundreds of applications from a single IdP. </p>
<p>Here’s an example of how it works: When a new employee joins your organization, your system admin will create a new user in your IdP and add the user to the Contentstack app in the IdP. The IdP then communicates about the new user’s identity to Contentstack (and other apps you use) and automatically adds the user to Contentstack. Likewise, when your system admin removes a user from the IdP, it automatically removes the user from Contentstack.</p><h2>What’s In This Release</h2>
<p>This release includes everything you need to use SCIM (with OneLogin) for your organization. It’s in ‘Beta’ because we are releasing SCIM support for just one IdP (OneLogin) at the moment, and we are in the process of enhancing the performance of some SCIM API requests. But that shouldn’t stop you from using our SCIM integration for your organization. It’s completely secure. The following explains what’s in this release. </p>
<p><strong>SCIM Support for OneLogin</strong></p>
<p>If you have been using OneLogin as your IdP for automatically provisioning or deprovisioning users, you can now manage Contentstack users as well through your IdP.</p>
<p>Here’s a detailed <a href="https://www.contentstack.com/docs/developers/scim/set-up-scim-provisioning-with-onelogin" target="_blank">step-by-step guide</a> on how to set up SCIM with OneLogin and Contentstack.</p>
<p><strong>Contentstack SCIM API</strong></p>
<p>We also provide SCIM API  built using the SCIM 2.0 protocol. You may not need to use these APIs directly if you are using OneLogin as your IdP. However, if you have built a custom IdP client or want to manage user provisioning in Contentstack programmatically, these APIs would be useful. Refer to our <a href="https://www.contentstack.com/docs/developers/apis/scim-api/" target="_blank">SCIM API reference</a> for more details. </p><h2>What This Release Means For You</h2>
<p><strong>Ease in Managing Users </strong></p>
<p>Our SCIM integration ensures that your new employees get access to Contentstack with the right permissions at the right time, without admins having to access the Contentstack app every time. This automation saves considerable time, effort, and headaches for the admins that otherwise have to do this manually.<br></p>
<p><strong>Improved Security and Reduced Human Error</strong> </p>
<p>Your company’s data and resources become safe as SCIM integration eliminates any security threats caused by unauthorized access due to manual errors. <br> </p>
<p><strong>Quick User Onboarding </strong></p>
<p>SCIM support for Contentstack helps your IT department and new employees, so they don’t have to wait to access Contentstack. The relevant access with appropriate permissions is already in place, even before they log in for the first time. </p><h2>Helpful resources </h2><ul><li><a href="https://www.contentstack.com/docs/developers/apis/scim-api/" target="_blank">Contentstack SCIM API reference</a> </li><li><a href="https://www.contentstack.com/docs/developers/scim/set-up-scim-provisioning-with-onelogin" target="_blank">Set up SCIM with OneLogin</a> </li><li><a href="https://www.contentstack.com/docs/developers/scim" target="_blank">More SCIM docs</a> </li></ul>

Managing access governance over a composable technology stack is crucial for both security and end-user experience. Contentstack SAML 2.0 support enabled companies to provide seamless user management through Single Sign-On (SSO) since its introduction three years ago.

(in Beta), to simplify the automation of user provisioning further. This Beta release includes 

SCIM (System for Cross-Domain Identity Management) is a proven and secure protocol for exchanging user identity information between various IT systems and services. Major identity providers (IdP), such as OneLogin, support SCIM as a common language to communicate with service providers such as Contentstack or other applications.

SCIM allows administrators to manage all users from a central location, enabling onboarding, offboarding, or changing user access in hundreds of applications from a single IdP.

Here’s an example of how it works: When a new employee joins your organization, your system admin will create a new user in your IdP and add the user to the Contentstack app in the IdP. The IdP then communicates about the new user’s identity to Contentstack (and other apps you use) and automatically adds the user to Contentstack. Likewise, when your system admin removes a user from the IdP, it automatically removes the user from Contentstack.

This release includes everything you need to use SCIM (with OneLogin) for your organization. It’s in ‘Beta’ because we are releasing SCIM support for just one IdP (OneLogin) at the moment, and we are in the process of enhancing the performance of some SCIM API requests. But that shouldn’t stop you from using our SCIM integration for your organization. It’s completely secure. The following explains what’s in this release.

If you have been using OneLogin as your IdP for automatically provisioning or deprovisioning users, you can now manage Contentstack users as well through your IdP.

 on how to set up SCIM with OneLogin and Contentstack.

We also provide SCIM API built using the SCIM 2.0 protocol. You may not need to use these APIs directly if you are using OneLogin as your IdP. However, if you have built a custom IdP client or want to manage user provisioning in Contentstack programmatically, these APIs would be useful. Refer to our 

Our SCIM integration ensures that your new employees get access to Contentstack with the right permissions at the right time, without admins having to access the Contentstack app every time. This automation saves considerable time, effort, and headaches for the admins that otherwise have to do this manually.

Improved Security and Reduced Human Error

Your company’s data and resources become safe as SCIM integration eliminates any security threats caused by unauthorized access due to manual errors.

SCIM support for Contentstack helps your IT department and new employees, so they don’t have to wait to access Contentstack. The relevant access with appropriate permissions is already in place, even before they log in for the first time.

scim-beta.jpg

Access Governance With SCIM (Beta)

<p>It’s official. Contentstack’s GraphQL Content Delivery API is now available to all customers. </p>
<p>When we first added support for GraphQL about two years ago, we saw it as a natural addition to a developers’ arsenal. We knew that providing more stable support would unlock tremendous value for developers and provide an efficient way to query data, no matter what they plan to build. </p>
<p>In the last two years, we worked hard to achieve that. We brought significant improvements in terms of capability, stability, and performance. Having proven itself over many months with customers using it in production, we are moving our GraphQL Content Delivery API from limited availability to general availability. Additionally, this latest release offers further rate limit increases, better stability, the ability to query multiple content types in a single request, and more.  </p>
<p>Before we dig into what has changed from our Limited Availability version, here are highlights of the capabilities of our GA GraphQL API:<br></p><ul><li>Rate limit of 80 requests per second per organization, <em>in addition</em> to the existing REST rate limit</li><li>Query entries of up to three content types in a single request</li><li>Paginate responses for referenced data and assets</li><li>Use relay specification logic to traverse through Reference field data</li><li>Retrieve data of different types of custom fields</li><li>Paginate introspection schema details</li><li>Use postman collection to test our GraphQL API</li></ul>
<p>Now let’s look at some of the changes we have brought in this GA release from our Limited Availability version.</p><h2>Higher Rate Limits</h2>
<p>Our Limited Availability version had a rate limit of 3 requests per second per organization. We have increased the default limit to <strong>80 requests per second per organization</strong> for uncached GraphQL requests to accommodate more production use cases. For requests that fetch content from our CDN cache, there is no rate limit.</p><h2>Query More Content Types in a Single Request</h2>
<p>You can now retrieve entries of up to <strong>three</strong> content types in a single GraphQL API request.<br></p>
<grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><figure><table><tbody><tr><td spellcheck="false">Here’s an example request that shows how you can fetch values of the <strong>Title</strong> field of entries of multiple content types.</td></tr><tr><td spellcheck="false"><pre>query {
  all_product {
total
    items {
      title
      }
  }
  all_category {
    total
    items {
      title
    }
  }
  all_brand {
    total
    items {
      title
    }
  }
}</pre></td></tr></tbody></table></figure>
<h2>Limits on Query Complexity and Cost</h2>
<p>GraphQL gives developers the ability to make complex queries. While this is an advantage for the requester, it also opens up certain security risks. A malicious attacker can request a heavy, nested query that can overload the server or database. Or even legitimate users can inadvertently request data that may cause performance issues.</p>
<p>One of the best strategies to mitigate such risks is to set the following standards:</p><ul><li>A single GraphQL query can fetch <strong>a maximum of 7,500 records</strong></li><li>A single GraphQL query can fetch <strong>a maximum of 100 referenced records</strong> for a single Reference field connection</li><li>You can use the <strong>skip</strong> and <strong>limit</strong> <strong>pagination parameters</strong> to fetch more reference connection records</li></ul>
<p>We do a cost and complexity analysis before executing the query and restrict the query from being executed if it exceeds the set limits.</p>
<grammarly-extension data-grammarly-shadow-root="true" style="position: absolute; top: 0px; left: 0px; pointer-events: none;" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" style="position: absolute; top: 0px; left: 0px; pointer-events: none;" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><grammarly-extension data-grammarly-shadow-root="true" class="cGcvT"></grammarly-extension><figure><table><tbody><tr><td spellcheck="false"><p>Let’s look at an example to understand how we do this:</p></td></tr><tr><td spellcheck="false"><pre>{
  all_blogs(limit:100) {
    items {
      related_blogsConnection(limit:75) {
        totalCount
        edges {
          node {
            ... on Blogs {
              title
            }
          }
        }
      }
    }
  }
}</pre></td></tr></tbody></table></figure>
<p>Now, we <strong>calculate</strong> the total records (entries) the above query is trying to fetch:</p>
<p><strong>Depth 0 (Blogs Content Type)</strong> = 100 blog entries</p>
<p><strong>Depth 1 (Related Blogs Reference Field)</strong>:  100 x 75 = 7,500 related blog entries</p>
<p><strong>Total Blog Entries</strong>: 100 blog entries + 7,500 related blog entries = <strong>7,600 entries</strong></p>
<p>Since the total entry count exceeds the maximum allowed limit of 7,500, we can prevent this query from connecting to the database.</p>
<p>If you intend to fetch more data, we recommend you paginate the references effectively and make multiple requests. </p>
<p>Refer to our <a href="https://www.contentstack.com/docs/developers/apis/graphql-content-delivery-api/#query-complexity-and-cost-calculation" target="_blank">documentation</a> to learn more about how we calculate query cost and complexity.</p><h2>Breaking Changes to Keep in Mind</h2>
<p>Contentstack will continue to support the GraphQL Content Delivery API Limited Availability version for <strong>30 days</strong> post the GA release.</p>
<p>To facilitate a smooth transition to the newer version of the API, we have listed below a few <strong>breaking changes</strong> in the API that you need to update within your backend code. You can incorporate these changes before the duration (mentioned above) to avoid schema build errors.</p><h3>Update to All Asset Related Typenames</h3>
<p>Contentstack converts every field UID to its corresponding GraphQL typename that follows the Pascal naming convention. However, a few instances may involve two different fields or objects having the same typename. This occurrence is referred to as a <a href="https://www.contentstack.com/docs/developers/apis/graphql-content-delivery-api/#typename-collision" target="_blank">Typename Collision</a>.</p>
<p>In our endeavor to avoid typename collisions, we prefix all asset-related GraphQL typenames with “SysAsset” instead of “Asset.”</p>
<p>Here’s a list of all the system-defined fields that have changed:</p><ul><li>"Asset" to "SysAsset"</li><li>"AssetWhere" to "SysAssetWhere"</li><li>"AssetConnection" to "SysAssetConnection"</li><li>"AssetEdge" to "SysAssetEdge"</li><li>"AllAssets" to "AllSysAsset"</li><li>"AssetSystemField" to "SysAssetSystemField"</li><li>"AssetDimension" to "SysAssetDimension"</li><li>"AssetDimensionWhere" to "SysAssetDimensionWhere"</li><li>"AssetOrderBy" to "SysAssetOrderBy"</li><li>"TransformUrl" to "SysAssetTransformUrl"</li><li>"ImageFormats" to "SysAssetImageFormats"</li><li>"DisableValues" to "SysAssetDisableValues"</li><li>"FitValues" to "SysAssetFitValues"</li><li>"OrientValues" to "SysAssetOrientValues"</li><li>"OverlayAlignValues" to "SysAssetOverlayAlignValues"</li><li>"OverlayRepeatValues" to "SysAssetOverlayRepeatValues"</li><li>"AutoValues" to "SysAssetAutoValues"</li><li>"DispositionValues" to "SysAssetDispositionValues"</li></ul><h3>Introduction of the X-Resolver-Cost Response Header</h3>
<p>To prevent malicious queries from hitting our backend database, we now perform a static analysis of each query before it hits the database. The x-resolver-cost response header calculates the worst-case response size that can be fetched by the query and provides an apt query cost analysis. This response header returns the total number of database round trips made for a single GraphQL query.</p><h2>Future Steps</h2>
<p>Contentstack will continue to add more capabilities to our GraphQL Content Delivery API as we go forward. Check our <a href="https://www.contentstack.com/docs/developers/apis/api-change-log/" target="_blank">Change Log</a> section to see the complete list of changes. To get started with your GraphQL API, check out our <a href="https://www.contentstack.com/docs/developers/apis/graphql-content-delivery-api/" target="_blank">developer documentation</a>.</p>

It’s official. Contentstack’s GraphQL Content Delivery API is now available to all customers.

When we first added support for GraphQL about two years ago, we saw it as a natural addition to a developers’ arsenal. We knew that providing more stable support would unlock tremendous value for developers and provide an efficient way to query data, no matter what they plan to build.

In the last two years, we worked hard to achieve that. We brought significant improvements in terms of capability, stability, and performance. Having proven itself over many months with customers using it in production, we are moving our GraphQL Content Delivery API from limited availability to general availability. Additionally, this latest release offers further rate limit increases, better stability, the ability to query multiple content types in a single request, and more.

Before we dig into what has changed from our Limited Availability version, here are highlights of the capabilities of our GA GraphQL API:

Now let’s look at some of the changes we have brought in this GA release from our Limited Availability version.

Our Limited Availability version had a rate limit of 3 requests per second per organization. We have increased the default limit to 

 for uncached GraphQL requests to accommodate more production use cases. For requests that fetch content from our CDN cache, there is no rate limit.

Query More Content Types in a Single Request

 content types in a single GraphQL API request.

GraphQL gives developers the ability to make complex queries. While this is an advantage for the requester, it also opens up certain security risks. A malicious attacker can request a heavy, nested query that can overload the server or database. Or even legitimate users can inadvertently request data that may cause performance issues.

One of the best strategies to mitigate such risks is to set the following standards:

We do a cost and complexity analysis before executing the query and restrict the query from being executed if it exceeds the set limits.

 the total records (entries) the above query is trying to fetch:

: 100 blog entries + 7,500 related blog entries = 

Since the total entry count exceeds the maximum allowed limit of 7,500, we can prevent this query from connecting to the database.

If you intend to fetch more data, we recommend you paginate the references effectively and make multiple requests.

 to learn more about how we calculate query cost and complexity.

Contentstack will continue to support the GraphQL Content Delivery API Limited Availability version for 

To facilitate a smooth transition to the newer version of the API, we have listed below a few 

 in the API that you need to update within your backend code. You can incorporate these changes before the duration (mentioned above) to avoid schema build errors.

Contentstack converts every field UID to its corresponding GraphQL typename that follows the Pascal naming convention. However, a few instances may involve two different fields or objects having the same typename. This occurrence is referred to as a 

In our endeavor to avoid typename collisions, we prefix all asset-related GraphQL typenames with “SysAsset” instead of “Asset.”

Here’s a list of all the system-defined fields that have changed:

Introduction of the X-Resolver-Cost Response Header

To prevent malicious queries from hitting our backend database, we now perform a static analysis of each query before it hits the database. The x-resolver-cost response header calculates the worst-case response size that can be fetched by the query and provides an apt query cost analysis. This response header returns the total number of database round trips made for a single GraphQL query.

Contentstack will continue to add more capabilities to our GraphQL Content Delivery API as we go forward. Check our 

 section to see the complete list of changes. To get started with your GraphQL API, check out our 

graphql-content-api-general-availability.png

Announcing General Availability of Contentstack’s GraphQL Content Delivery API

<p>Quick and easy collaboration among team members is crucial, especially for teams that regularly create a lot of content, as it directly impacts the delivery speed and quality of content.</p>
<p>Contentstack provides several tools that enable easy collaboration, such as entry presence, workflow stages, task assignment, etc. Today, we are glad to introduce another powerful collaboration tool: <strong>the ability to add comments to entry fields</strong>.  </p>
<p>With this feature, content managers can add comments to fields of an entry and reply inline, letting them initiate discussions around the content to collaborate efficiently. Let’s explore this feature in detail and understand what’s new for content managers.</p>
<p>While editing an entry, the ability to comment on entry fields helps streamline content creation and review. And the collaboration is even more powerful than just leaving comments. Here’s a list of actions that you can perform with the new commenting feature: </p>
<h2>Add comments to a field</h2>
<p>You can start a discussion on a field, and you can add several comments within that discussion. To create a comment, hover your mouse pointer over a field and click the comment icon.</p>
<p style="margin: auto; text-align: center;"><img data-image="07c6uicy8mb5" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt2bcb9028ccf99830/5f6e1e01981e5e454677305a/adding-comments-to-field-contentstack.jpg" data-sys-asset-uid="blt2bcb9028ccf99830" alt="adding-comments-to-field-contentstack.jpg"></p>
<p></p>
<h2>Reply to comments</h2>
<p>You or other content editors can reply to an existing comment by adding a comment below.</p>
<p style="margin: auto; text-align: center;"><img data-image="9o4ajfci2cw2" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt3004d711e26afbfb/5f6e1e12981e5e454677305e/replying-to-comments-contentstack.jpg" data-sys-asset-uid="blt3004d711e26afbfb" alt="replying-to-comments-contentstack.jpg"></p>
<p></p>
<h2>Mention users or roles in comments</h2>
<p>If you want to tag specific users in a comment, you can mention them using “@.” They will get an email as well as in-app notification about their mention. You can also tag roles.  </p>
<p style="margin: auto; text-align: center;"><img data-image="eeykjvzhr40c" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/bltf2a80bb3002f123d/5f6e1e23747ff04fb7900301/mention-users-roles-comments-contentstack.jpg" data-sys-asset-uid="bltf2a80bb3002f123d" alt="mention-users-roles-comments-contentstack.jpg"></p>
<p></p>
<h2>Resolve discussions</h2>
<p>When you complete a discussion, you can resolve the discussion, and make way for new discussions. Once resolved, the comment disappears from the field view, but it is always available in the right-hand panel, under “Resolved Discussions.” </p>
<p style="margin: auto; text-align: center;"><img data-image="lkgm40qer24n" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt7a32307387f59838/5f6e1e4667fb9e4545437b2f/resolve-discussions-in-comments-contentstack.jpg" data-sys-asset-uid="blt7a32307387f59838" alt="resolve-discussions-in-comments-contentstack.jpg"></p>
<p></p>
<h2>Reopen discussions</h2>
<p>You can reopen a resolved discussion in a single click. It then becomes an active discussion that starts appearing in the field view. You can then start adding comments to continue the discussion. </p>
<p style="margin: auto; text-align: center;"><img data-image="s2kc6tfbm9a9" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt22f1554ab29aa0cd/5f6e1eaf51d0774abbe54d32/resolve-discussions-in-comments-contentstack.jpg" data-sys-asset-uid="blt22f1554ab29aa0cd" alt="resolve-discussions-in-comments-contentstack.jpg"></p>
<p></p>
<h2>View a timeline of comments and discussions</h2>
<p>The timeline section gives a quick overview of all the comments and discussions added to all the fields of an entry. From here, you can also perform common actions, such as “Resolve,” “Reopen,” etc.</p>
<p style="margin: auto; text-align: center;"><img data-image="aj3t91tunn1o" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt86192a814c0e950c/5f6e1f121868224e73cb02e8/see-timeline-of-discussion-comments-contentstack.jpg" data-sys-asset-uid="blt86192a814c0e950c" alt="see-timeline-of-discussion-comments-contentstack.jpg"></p>
<p></p>
<h2>View your mentions</h2>
<p>When someone mentions you in a comment, you get in-app notifications within the stack. You can view them by clicking the notification icon on the top right corner. </p>
<p style="margin: auto; text-align: center;"><img data-image="oddqq8xbfnkt" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt698466d2644eb68f/5f6e1ed0968bb93b9e851267/view-your-mentions-comments-contentstack.jpg" data-sys-asset-uid="blt698466d2644eb68f" alt="view-your-mentions-comments-contentstack.jpg"></p>
<p></p>
<h2>“Mark as read” or clear comment notifications</h2>
<p>Notifications about your mentions remain as unread in your “Notifications” tab until you mark them as read. You can also clear the notifications section if you don’t want them anymore.&nbsp; </p>
<p style="margin: auto; text-align: center;"><img data-image="x66uti0gx0f4" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blt5649ef8169700cd5/5f6e1f2d8c3821496a60163a/mark-as-read-clear-notifications-comments-contentstack.jpg" data-sys-asset-uid="blt5649ef8169700cd5" alt="mark-as-read-clear-notifications-comments-contentstack.jpg"></p>
<p>Now that you know how this feature works, it’s time to start collaborating with your team members. Read our documentation on <a href="https://www.contentstack.com/docs/content-managers/working-with-entries/#manage-entry-comments" target="_blank">Commenting Within Entries</a> to learn more.</p>

Quick and easy collaboration among team members is crucial, especially for teams that regularly create a lot of content, as it directly impacts the delivery speed and quality of content.

Contentstack provides several tools that enable easy collaboration, such as entry presence, workflow stages, task assignment, etc. Today, we are glad to introduce another powerful collaboration tool: 

the ability to add comments to entry fields

With this feature, content managers can add comments to fields of an entry and reply inline, letting them initiate discussions around the content to collaborate efficiently. Let’s explore this feature in detail and understand what’s new for content managers.

While editing an entry, the ability to comment on entry fields helps streamline content creation and review. And the collaboration is even more powerful than just leaving comments. Here’s a list of actions that you can perform with the new commenting feature:

You can start a discussion on a field, and you can add several comments within that discussion. To create a comment, hover your mouse pointer over a field and click the comment icon.

You or other content editors can reply to an existing comment by adding a comment below.

If you want to tag specific users in a comment, you can mention them using “@.” They will get an email as well as in-app notification about their mention. You can also tag roles.

When you complete a discussion, you can resolve the discussion, and make way for new discussions. Once resolved, the comment disappears from the field view, but it is always available in the right-hand panel, under “Resolved Discussions.”

You can reopen a resolved discussion in a single click. It then becomes an active discussion that starts appearing in the field view. You can then start adding comments to continue the discussion.

View a timeline of comments and discussions

The timeline section gives a quick overview of all the comments and discussions added to all the fields of an entry. From here, you can also perform common actions, such as “Resolve,” “Reopen,” etc.

When someone mentions you in a comment, you get in-app notifications within the stack. You can view them by clicking the notification icon on the top right corner.

“Mark as read” or clear comment notifications

Notifications about your mentions remain as unread in your “Notifications” tab until you mark them as read. You can also clear the notifications section if you don’t want them anymore. 

Now that you know how this feature works, it’s time to start collaborating with your team members. Read our documentation on 

entry-comments-feature-contentstack.jpg

Collaborate Better With Entry Comments

<p>We all make mistakes. But the damage may be expensive if we accidentally delete important data, with no means to restore it.</p>
<p>To make sure it doesn’t happen for Contentstack users, we now provide the “Trash” feature that stores deleted items for a certain number of days and allows restoring these items before they are automatically deleted permanently.</p>
<p>The following explains the Trash feature in detail.</p>
<h2>The Trash - A Content Recovery Solution</h2>
<p>The Trash serves as a backup that stores all the deleted items – entries, assets, content types, and global fields – for up to 14 days from deletion. Within this duration, you can restore any deleted items in a single click, and you will find the items just as they were before you deleted them.</p>
<p>Another important feature is that you can restore items in bulk for some modules. For example, when restoring a content type, you can restore all the entries that were deleted with the content type. Likewise, you can restore assets while restoring an asset folder. This makes restoring easier, especially if the content type or asset folder contains hundreds of items.</p>
<p>An important point to remember while using the Trash is that Items within the Trash are <strong>automatically deleted forever after 14 days</strong>. So, make sure you restore accidentally deleted items before you lose them permanently.</p>
<p>The following explains how to restore content from the Trash.</p>
<h2>Restore Deleted Items from the Trash</h2>
<p>To restore deleted items from a stack, perform the following steps:</p>
<ol><li>Go to your stack, and then choose <strong>Settings</strong> &gt; <strong>Trash</strong>.<br></li><li>Click on the <strong>Entries</strong> tab, and go to the entry you want to restore (e.g., <strong>Bio for John Smith</strong>).</li>
<li>Click on the <strong>Restore</strong> button that appears at the right.</li><li>The entry is restored from the Trash and available in the content type where it was earlier.</li><li>When restoring a content type, you can select the “Restore With Entries” option to restore all the entries that were deleted with the content type.<br></li><li>When restoring an asset folder, you can select the “Restore With Assets” option to restore all the assets that were deleted with the folder.<br></li></ol>
<p style="text-align: center;"><img data-image="ar0rvkwy4fct" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/bltfb0e2cdf3a81fe25/5f03492ebb61012b022c1bad/blog-trash-image-contentstack-screenshot.png" data-sys-asset-uid="bltfb0e2cdf3a81fe25" alt="blog-trash-image-contentstack-screenshot.png"></p>
<p>Check out the documentation on the <a href="https://www.contentstack.com/docs/developers/manage-trash" target="_blank">Trash</a> feature to understand how it works in Contentstack.</p>

We all make mistakes. But the damage may be expensive if we accidentally delete important data, with no means to restore it.

To make sure it doesn’t happen for Contentstack users, we now provide the “Trash” feature that stores deleted items for a certain number of days and allows restoring these items before they are automatically deleted permanently.

The following explains the Trash feature in detail.

The Trash serves as a backup that stores all the deleted items – entries, assets, content types, and global fields – for up to 14 days from deletion. Within this duration, you can restore any deleted items in a single click, and you will find the items just as they were before you deleted them.

Another important feature is that you can restore items in bulk for some modules. For example, when restoring a content type, you can restore all the entries that were deleted with the content type. Likewise, you can restore assets while restoring an asset folder. This makes restoring easier, especially if the content type or asset folder contains hundreds of items.

An important point to remember while using the Trash is that Items within the Trash are 

automatically deleted forever after 14 days

. So, make sure you restore accidentally deleted items before you lose them permanently.

The following explains how to restore content from the Trash.

To restore deleted items from a stack, perform the following steps:

 feature to understand how it works in Contentstack.

the-trash-hero.png

Introducing Trash - Recover Lost Data and Accidental Deletions

<p>If your organization has a lengthy content creation lifecycle, a well-defined workflow is like an automated conveyor system that ensures that the progression of tasks is flowing in the right direction. The more control over your workflow, the better you can streamline the content creation process. </p>
<p>That’s why we introduced more granularity to control permissions in our workflows. You can now define which users or roles can edit the entries at different stages of the workflow. This ensures that only the right people can edit content at the right stage.</p>
<p>The following explains what’s new in our workflows.</p>
<h2>Set Edit Permissions on Specific Workflow Stages</h2>
<p>Until now, the “<a href="https://www.contentstack.com/docs/developers/set-up-workflows-and-publish-rules/add-workflows-and-stages/#add-stage-transition-and-access-rules">stage transition rules</a>” option in workflow settings allowed developers to define transitioning rules and enabled content creators to easily pass content from one stage to another in the content creation lifecycle. It also ensured that only the authorized users could change the entry stage. </p>
<p>However, the actual content, i.e., the entry, was open to everyone for editing, irrespective of the workflow stage it belonged to. This diluted the importance of a workflow. Imagine that the content is in its final stage, ready to be published on your website, and the author makes major changes to the content, or someone accidentally deletes a paragraph at the last minute. </p>
<p>It could lead to an unwanted disaster, couldn’t it? Not anymore.</p>
<p>We have now added a new option under the workflow settings that lets you define the users or roles that can edit the entry when in a particular stage.</p>
<p>For example, you can specify that only the users with the “Editors” role can edit the entry when in the “Review” stage, or only “Media Specialists” can make changes when the entry is on the “Images and Media” stage. </p>
<p>This ensures that there is never any unwanted modification to your content, especially by someone who shouldn’t be making the change in a  specific stage. </p>
<p>Read our documentation on <a href="https://www.contentstack.com/docs/developers/set-up-workflows-and-publish-rules#set-up-workflows">Workflows</a> to get an in-depth understanding of this enhancement.  </p>
<h2>How to Set Edit Permissions on a Workflow Stage</h2>
<p>To set edit access permissions on an entry that has been moved to a particular workflow stage, follow the below steps:</p>
<ol><li>Go to your stack, and then choose <strong>Settings</strong> &gt; <strong>Workflows</strong>.<br></li><li>Click on the workflow you want to update.<br></li><li>Go to the stage you want to edit permissions for, and click on “Stage transition and access rules” to expand the options.<br></li><li>Under the <strong>Users/roles who can edit the entry in this stage</strong> section, select the person or the role that you want to enable edit access (for example, <strong>Current stage user(s)</strong>).<br></li><li>Once you have made the changes, click on <strong>Save</strong>.</li></ol>
<p>This ensures that only the users who are allowed to transition the entry stage from one to the other are allowed to edit the entry in that stage. </p>
<p>Read more about <a href="https://www.contentstack.com/docs/developers/set-up-workflows-and-publish-rules/add-workflows-and-stages#add-workflow-stages">adding Workflow stages</a> and setting edit access permissions for specific stages.</p>

If your organization has a lengthy content creation lifecycle, a well-defined workflow is like an automated conveyor system that ensures that the progression of tasks is flowing in the right direction. The more control over your workflow, the better you can streamline the content creation process.

That’s why we introduced more granularity to control permissions in our workflows. You can now define which users or roles can edit the entries at different stages of the workflow. This ensures that only the right people can edit content at the right stage.

The following explains what’s new in our workflows.

Set Edit Permissions on Specific Workflow Stages

” option in workflow settings allowed developers to define transitioning rules and enabled content creators to easily pass content from one stage to another in the content creation lifecycle. It also ensured that only the authorized users could change the entry stage.

However, the actual content, i.e., the entry, was open to everyone for editing, irrespective of the workflow stage it belonged to. This diluted the importance of a workflow. Imagine that the content is in its final stage, ready to be published on your website, and the author makes major changes to the content, or someone accidentally deletes a paragraph at the last minute.

It could lead to an unwanted disaster, couldn’t it? Not anymore.

We have now added a new option under the workflow settings that lets you define the users or roles that can edit the entry when in a particular stage.

For example, you can specify that only the users with the “Editors” role can edit the entry when in the “Review” stage, or only “Media Specialists” can make changes when the entry is on the “Images and Media” stage.

This ensures that there is never any unwanted modification to your content, especially by someone who shouldn’t be making the change in a specific stage.

 to get an in-depth understanding of this enhancement.

How to Set Edit Permissions on a Workflow Stage

To set edit access permissions on an entry that has been moved to a particular workflow stage, follow the below steps:

This ensures that only the users who are allowed to transition the entry stage from one to the other are allowed to edit the entry in that stage.

 and setting edit access permissions for specific stages.

define-workflow-permissions.png

Define Entry Editing Permissions on Workflow Stages

<p>Modeling content or defining the structure of your app can be grueling at times. But with the right tools, you can create even the most intricate structures with ease. That’s why, a few months ago, we introduced “<a href="https://www.contentstack.com/docs/developers/global-field">Global fields</a>.” A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type of your stack. This makes content modeling easier and more flexible for developers.</p>
<p>In our latest release last week, we added more flexibility and capabilities to this field by removing certain restrictions. When creating content types, developers can now add “Reference,” “Group,” and “Modular Blocks” fields, among others, within the Global field. Also, Global fields can now be added within the “Group” fields or can be referenced as blocks within the “Modular Blocks” fields. This opens up a lot of possibilities and saves a vast amount of time and effort for developers.</p>
<p> </p>
<h2>Add “Reference,” “Group,” and “Modular Blocks” fields to Global fields</h2>
<p>The  “Reference,” “Group,” and “Modular Blocks” fields are some of the fields that help you create complex structures. Until now, it was not possible to use these within a Global field, which meant going through the pain of manually creating repetitive structures over and over again. The restrictions have been removed, and you can now add these fields to the Global fields. </p>
<p>Let’s look at an example where you might use a Modular Blocks field within a Global field. Most content types, for instance, may require multiple SEO fields, complex taxonomy fields, or embedded web form fields. To avoid adding these fields individually to several content types, developers can create a Global field with a Modular Blocks field within it, and add the above three sets of fields as blocks.</p>
<p>Then you add the Global field to all the content types. The content manager can then add the required block as needed while creating entries.</p>
<p style="text-align: center;"><img data-image="vremxpfsb7o2" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/bltedf784f4ee639dba/5e8ccba610ae897aa1eeacc6/modular-blocks-within-global-field-screenshot.png" data-sys-asset-uid="bltedf784f4ee639dba" alt="modular-blocks-within-global-field-screenshot.png"></p>
<p>Likewise, there are several use cases where developers might use “Reference” and “Group” fields within the Global fields. Read more about <a href="https://www.contentstack.com/docs/developers/global-field" target="_blank">Global fields</a> and their <a href="https://www.contentstack.com/docs/developers/global-field/limitations-of-global-field" target="_blank">limitations</a>.  </p>
<h2>Use Global fields within “Group” fields or as blocks of “Modular Blocks” fields</h2>
<p>When creating content types, developers can now add Global fields to “Group” fields. Similarly, Global fields can be referenced as blocks within the “Modular Blocks” field. This makes things easier for developers, since using predefined structures within these fields is much quicker than creating them repeatedly.</p>
<p style="text-align: center;"><img data-image="9xfq5ol0o251" src="https://images.contentstack.io/v3/assets/blt77283b164776448a/blta8cd214e9949d3fb/5e8ccbcbee13647a9627996b/global-field-within-modular-blocks-field-screenshot.png" data-sys-asset-uid="blta8cd214e9949d3fb" alt="global-field-within-modular-blocks-field-screenshot.png"></p>
<h2>Additional Resources</h2>
<ul>
<li><a href="https://www.contentstack.com/docs/developers/global-field" target="_blank">Global Fields</a></li>
<li><a href="https://www.contentstack.com/docs/developers/global-field/limitations-of-global-field" target="_blank">Global Fields Limitations</a></li>
<li><a href="https://www.contentstack.com/docs/developers/create-content-types/modular-blocks" target="_blank">Modular Blocks Fields</a></li>
</ul>

Modeling content or defining the structure of your app can be grueling at times. But with the right tools, you can create even the most intricate structures with ease. That’s why, a few months ago, we introduced “

.” A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type of your stack. This makes content modeling easier and more flexible for developers.

In our latest release last week, we added more flexibility and capabilities to this field by removing certain restrictions. When creating content types, developers can now add “Reference,” “Group,” and “Modular Blocks” fields, among others, within the Global field. Also, Global fields can now be added within the “Group” fields or can be referenced as blocks within the “Modular Blocks” fields. This opens up a lot of possibilities and saves a vast amount of time and effort for developers.

Add “Reference,” “Group,” and “Modular Blocks” fields to Global fields

Sebastian Rodrigues

Posts by Sebastian Rodrigues