> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://contentful-staging.ferndocs.com/developers/docs/_mcp/server. # App Framework ## Docs - [App Framework](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/overview.md): An introduction to building apps with Contentful's App Framework | Managing and distributing through custom and marketplace apps - [Create a custom app](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/tutorial.md): An introduction to building apps for Contentful | Install an app to a space | Choose content types for your app to interact with - [Building a backend app](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-identities-and-events.md): How to use app identities and events to allow an app to act outside the context of the web app. App interaction with Contentful's Content Management API. - [Request verification](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/request-verification.md): Verify requests to your backend are coming from your app | Establishing a signing secret | Signing requests | Key rotation - [Create a configuration screen](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-configuration.md): Learn how to create a configuration screen for your custom app. - [Create an app to support Custom External References](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/custom-external-references-example-tutorial.md): An introduction to building Functions to support Custom External References for Contentful - [Create an app to support Native external references](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/native-external-references-example-tutorial.md): A tutorial on how to create an app supporting Native external references - [Recommendations for AI app building](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/ai-recommendations.md): General best practices for AI-assisted App bulding that apply to any AI tool, including limitations and restrictions. - [Strategies and prompting](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/ai-strategies-and-prompting.md): AI strategies and prompting for app development, including feature planning, UI prototyping, and test generation. - [Agents rules](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/ai-agent-rules.md): Agents rules for AI-powered development in Contentful. Defines guardrails for coding agents, emphasizes official tooling, code validation, best practices, and team conventions. - [Tutorial - App building with AI](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/ai-tutorial.md): An introduction to building apps using AI for Contentful - [Integration App Example - Braze](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/ai-integration-app-example.md): Study case app that connect Contentful with external services or platforms, enabling content to move smoothly across systems. - [Platform Feature App Example - Closest Preview](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/ai-platform-feature-app-example.md): Study case app that enable content editors to quickly find the page that uses their component so they can preview it. - [Deploy a custom app](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/deploy-app.md): An introduction to deploying apps for Contentful. - [Hosting an app](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/hosting-an-app.md): Learn more about the different options of how to host an app | Hosting an app with Contentful or externally | Static site hosting - [Converting an extension into an app](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/migrating-extension-to-app.md): Learn about the benefits of apps and migrate your existing UI extension in a few steps to an app. Publishing an app to the marketplace. - [Publishing an app](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/publishing-an-app.md): How to get your app listed on the Contentful Marketplace | Maintenance and support | Best practices in development | Security | Legal terms - [Customize the location field editor](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/customizing-location-field.md): Learn how to customize the appearance of the location field editor in the web app via Contentful apps | Creating a custom location field - [Customizing sidebar](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/customizing-sidebar.md): Learn how to customize the appearance of the sidebar next to an entry in the web app and Contentful apps | Creating a custom sidebar - [Working with Functions](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/working-with-functions.md): Learn how to create, update, delete, view, and manage Contentful Functions. - [Work with apps in Release context](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/working-with-releases.md): Learn how to make your apps compatible with Contentful Timelines and implement opt-out mechanisms for release-scoped entries. - [App SDK Reference](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/sdk.md): The SDK reference guide for Apps and UI Extensions | Inclusion | Initialization | Locations | Fields and Entries | Content types - [Create Contentful App](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/create-contentful-app.md): Creating a new app with create-contentful-app | AppDefinition | Local development | Deploying with Contentful | Programmatic app management - [GitHub Action](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/github-action.md): GitHub Action to deploy Contentful apps - [Libraries](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/libraries.md): Speed up the development of apps using our libraries | Node.js apps toolkit | DAM app base | E-commerce app base - [Field Editors](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/field-editors.md): All editorial components that you can find in the Contentful Web application | Field editors | Documentation | Contribution guide - [Forma 36](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/forma-36.md): Forma 36 - The Contentful Design System | An open source design system by Contentful created with the intent to reduce developer overhead - [React Apps Toolkit](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/react-apps-toolkit.md): React hooks to simplify building your next React based app for Contentful | Installation and available features - [App Actions](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-actions.md): App actions allow apps to securely communicate with each other and easily extend the user interface. - [App Bundle](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-bundle.md): An App Bundle belongs to an AppDefinition and is an entity that is used when hosting an app on the Contentful App Framework. - [App Definition](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-definition.md): An AppDefinition is the entity that represents an app in Contentful. Containing general app information for visibility, installation and settings enablement. - [App Events](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-events.md): App events allow you to define HTTP endpoints that should be called in response to changes to your entries, content types, or assets. - [App Locations](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/locations.md): Understanding where your app can be rendered in Contentful | Locations | App Configuration | Page locations | Dialog | Entries - [App Installation](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-installation.md): An App Installation is an entity type that indicates if an app described by an App Definition is installed in a space environment. - [App Identity](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-identity.md): App identities allow apps to interact with the Contentful as an independent entity, similar to a user. - [App Keys](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-keys.md): An App Key is an entity that represents a key pair, which can be used by an app to make a signed request to Contentful. - [App Parameters](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/app-parameters.md): Use app parameters to separate code from configuration | What are parameters | Definitions - [Editor Interfaces](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/editor-interfaces.md): An editor interface represents the look and feel of content type fields in the web app | Settings | Custom widgets | Sidebar | Default configuration - [Target State](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/target-state.md): Target State is the understanding of where your app is rendered. It is responsible specific fields, sidebars and editors in the web app. - [Access Grant](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/access-grant.md): Access Grant is an entity that is used to manage which organization can install an App from the App Framework. - [Functions](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/functions.md): Functions are serverless workloads that run on Contentful's infrastructure to provide enhanced flexibility and customization. - [Resource Entities](https://contentful-staging.ferndocs.com/developers/docs/extensibility/app-framework/resource-entities.md): Learn how to use Resource Entities to extend Contentful with native external references. Understand how resource providers and resource types work together to connect your app with external services.