Overview

UI apps can be used to load visual content from third-party systems (e.g. Jira Epics) or to create your custom content in Gtmhub. UI apps in Gtmhub load content in an iframe. They need to be styled according to Gtmhub's style guide.

Keep reading to learn about UI apps in Gtmhub, and watch our video below to see how to submit a UI app to the Gtmhub Marketplace.

How to submit a UI app

Building a UI app

First, get familiar with Gtmhub's style guide and developer documentation.

UI apps require you to fill in a section called "UI app details for manifest".

The Source is a link to where your app is hosted. You can host the app's source code in a repository of your choice (e.g. Github). The apps should be either public or private (you should give access to Gtmhub).

Once the app is approved, Gtmhub Engineers will deploy it into Gtmhub's codebase.

For UI Location, you will select where your app will be visualized in the UI of Gtmhub and what permissions it will have. We currently support:

  • Objective side view

  • Key result side view

Objective side view

Key result side view

App settings fields are the fields an admin is required to enter in order to start using the app:

  • Key - To be stored in DB

  • Label - Name of the field that the users see when they configure the app

  • Type - Type of the field (text/drop-down)

  • Should be required - If the field is required

  • Should be secured - If the field is masked

App custom fields are not mandatory. They appear in the interface of objective and key result side view or remain hidden. They contain strings. If your app auto-creates custom fields in Gtmhub, these fields can not be deleted by end-users who install the app. Learn more about custom fields here.

More instructions on building a UI app can be found in our Developer documentation - https://developer.gtmhub.com/

Testing a UI app

You can test how your UI app is set up and functioning in the platform.

Step 1 - Save your app details to draft

Step 2 - From the ellipsis menu, select to test app

Step 3 - You'll be navigated to your app settings page. Enter the settings.

Step 4 - Navigate to where your app should appear in the platform and test its functionality.

Submit for review

Once you are done building your app, submit the app for review. Once approved by our team the app will be published in the Marketplace. If returned, you'll receive an e-mail with comments and the app will move back to draft.

Use privately

You can also use the app privately in your account. All draft apps are automatically installed in your account and are fully functional.

Did this answer your question?