FAQ / Extensibility

On this page

Can I customize the Contentful web app?

Yes, you can customize the web app by building apps, introducing UI extensions, or tweaking the standard behavior of field editors. An app is a single page application (SPA) consisting of HTML, CSS and Javascript files that we render in an iframe. The app framework provides a number of standard locations for integrating your app into the web app UI:

  • Entry field

  • Entry editor

  • Entry sidebar  

  • Dialogue

  • Page

Advanced features like App identities and App events allow your apps go beyond the immediate web app UI and modify content using the Content Management API (CMA). You will find more resources on these topics under the Extensibility section of the developer documentation.

What is the difference between Apps and UI Extensions?

Apps are the next generation of UI Extensions. They are faster to build, update and manage and are easy to orchestrate when used in multiple spaces throughout your organization.  Features like App Identities and App events make it possible to build fully automated workflows with apps, whereas UI Extensions act on behalf of the user and require the user's input to accomplish a task. 

Apps and UI Extensions are compatible at the moment of this writing and share a lot of tooling, including the UI Extension SDK. While we plan to support UI Extensions into the foreseeable future, our current product efforts are focused on the app framework. For this reason, we encourage our customers to migrate their UI Extensions to Apps whenever possible to take advantage of the full range of extensibility features we offer. 

How do I install an app?

Contentful allows users to build two types of apps: marketplace apps and private apps. The installation process depends on the type of the app you want to install.

For marketplace apps, navigate to the app page in the App Marketplace and click Install now. Select the target space and — if you have multiple environments in the space — the target environment. Grant the app access to your space by clicking Authorize access.

App Installation Flow

Finally, fill out the required configuration fields (note that these vary from app to app) and save your settings. For faster access, you can also install Marketplace apps directly from within the web app by visiting the App menu tab in the main navigation.

For private apps, begin by creating an app definition under the App section of your organizational settings. The app definition includes the basic information about your app: name, URL, and target location. For apps using advanced App Framework features, this is where you generate public-private keys and subscribe to app events.

App definition illustration

Once you install the app definition, you can install the app into the target space the same way you install Marketplace apps. To read more about app installation and distribution, refer to our app development guide.

Who can install apps within my space?

To create an app definition in your organization, you have to be assigned the Developer, Admin or Owner organizational role. To install an app within your space, you have to be assigned either the Developer or Admin role.

Apps Organizational Roles

How can I distribute the app I built?

If you are interested in making your app available to the wider Contentful community, you can apply to have your app listed on the App Marketplace or open a pull request to feature it in the Awesome Apps list we maintain.

Where can I host my app?

There are no special technical requirements for hosting your app: it can be hosted on any platform as long as it can be accessed through a public URL. If you are already using cloud platforms like AWS, GCP or Azure, you can also use them for hosting your app. Alternatively, you can host your app on dedicated platforms like Vercel, Heroku, Netlify, Glitch, Digital Ocean and more.  

Do apps using identities count towards our user quota? 

No, apps do not contribute towards organizational user quota and can be created free of charge. However, for technical reasons, we limit the maximum number of app definitions that can be created per organization at 10 and the maximum number of installations that can be installed per environment at 10. For more information on app limits please refer to the Technical limits page.

Does Contentful provide app usage analytics?

No. At the moment we do not provide such functionality. If you would like to request new features or share your feedback, please fill out the app framework feedback form.

Can I charge for my app?

Yes. Contentful does not provide a built-in mechanism for billing app users through the App Marketplace, but you can list apps requiring a subscription and offer an alternative payment channel. To see how other apps monetize access, check out Optimizely, Jira, GlobalLink offerings on the marketplace.

What are the requirements for listing my app on the app marketplace?

To be considered for the marketplace listing, apps should fulfill the following criteria:

  • Provide clear value to end users

  • Offer publicly available user documentation

  • Have an official privacy policy and usage license

  • Provide user support and be actively maintained

To determine whether your app qualifies for the marketplace listing, submit a request to our technology partnerships team.

add-circle remove style-two-pin-marker subtract-circle