Extensibility API for Web Developers
Last modified: October 16, 2025
This feature is in beta. For more information, see Release Status.
For information on new releases of the Extensibility API, see Extensibility: Web API Release Notes.
Introduction
Extensions can be written in TypeScript or other web languages, described here, or using a C# API, which is documented in Extensibility API for C# Developers.
Extension development is only possible with the
--enable-extension-development feature flag.
For more detailed information on the web API, see the Mendix Studio Pro Web Extensibility API reference documentation.
Prerequisites
To use the Web Extensibility API, you must have:
- A basic understanding of the Mendix platform
- Some understanding of the Mendix Model
- Some TypeScript development experience
Getting Started
For detailed information on how to get started with extensions, see Get Started with the Web Extensibility API.
How-tos
Below is a list of how-tos for you to begin with:
- How to Create a Dockable Pane
- How to Interact With Local App Files
- How to Create a Menu
- How to Show a Message Box
- How to Access a Mendix Model
- How to Open a Tab
- How to Show a Popup Notification
- How to View User Preferences
- How to Show a Modal Dialog
- How to Open Documents
- How to Exchange Information Between Active Views
- How to Show Version Control Information