Apps
YouTrack apps are the primary package type for custom YouTrack functionality. An app can combine frontend widgets, backend JavaScript modules, settings, storage, custom MCP tools, and workflow rules.
Use the topics in this section to build, configure, test, and distribute apps.
Topic | Description |
|---|---|
Create your first app following this quick start guide. | |
Find answers to common questions about planning, building, configuring, and distributing apps. | |
Install apps from JetBrains Marketplace and update them from YouTrack. | |
Build apps with the experimental TypeScript-based Enhanced DX, including file-based routing and generated API types. | |
Get an overview of an app package structure and its main parts. | |
Learn more about the app manifest and the information stored there. | |
Add frontend widgets to supported locations in YouTrack. | |
Learn how to add settings that can be configured to customize and personalize features supported by your apps. | |
Learn how to extend core entities in YouTrack using custom properties. | |
Check the list of available permissions that let you manage who has access to the widgets supported by your apps. | |
Learn about the authentication approach and the permissions required to work with apps. | |
Learn how visibility can be used to limit access to an app in YouTrack. | |
Learn how scopes are used to define availability for different features. | |
Make sure that your app is ready for general use by checking all boxes in the launch checklist. | |
Follow tutorials that demonstrate how apps solve practical use cases. | |
Browse reference documentation for app modules and widget locations. |
Sample Apps
Software Developers from the YouTrack team at JetBrains have published a collection of apps to a public repository on GitHub. Feel free to browse the source code and use it as a springboard to develop your own widgets.
You can also explore the source code of the built-in YouTrack Demo App in YouTrack. The same source code is available in the YouTrack Demo App repository.
Apps and Pure Workflows
Workflow rules are backend JavaScript modules that can be included in an app package alongside widgets, HTTP handlers, custom MCP tools, settings, and storage declarations. The rules use the same constructors and JavaScript API whether the package contains only workflow rules or combines several module types.
For new development, start with an app when you expect the solution to grow, combine module types, or be distributed through JetBrains Marketplace. Create a pure workflow when you only need rule-based automation and want to author and manage the rule-only package with the dedicated workflow tools in YouTrack.
If your app includes workflow rules, use the Workflow Rule Types reference.
YouTrack Subreddit
If you're having a difficult time getting your app to work the way you want it to, join us on Reddit. Connect with other users to find real solutions to challenging situations.