Get Started with Apps
The topics in this section provide general guidelines for building YouTrack apps.
Topic | Description |
|---|---|
Create your first app following this quick start guide. | |
Get an overview of an app package structure and its main parts. | |
Learn more about the app manifest and the information stored there. | |
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. |
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.
Apps Versus Workflows
Workflows are part of the ecosystem for apps in YouTrack. Like other apps, workflows are used to enhance and customize functionality in YouTrack. When you create, upload, or install a workflow, it is included in the list of apps that are available for use in the system.
Workflows are event-driven triggers that let you implement custom business logic in YouTrack. This means you can automate updates in response to changes in field values, states, or on a set schedule. You can also extend the user interface by adding custom actions that are triggered manually by users but run logic on the backend. There's even a module that lets you establish connections and send requests to external sites.
If you're looking to build a solution that only relies on workflow rules, these can be written and stored directly in YouTrack. If you don't plan to use any of the frontend extension points to customize the user interface, you can save yourself a lot of time and effort by working exclusively with the workflow engine.
You can always package a group of workflow rules and publish them as an app or include a set of workflows in an app package alongside widgets for other extension points.
To learn more about workflows in YouTrack, see JavaScript Workflow Quick Start Guide.
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.