Last updated Aug 31, 2022

Example apps for Compass

Before you begin exploring these example apps, you'll need to set up the Forge CLI first. Learn more about getting started.

Once the Forge CLI is up and running, clone an example app repository to explore and customize it locally. Each repository's file contains quickstart instructions and other details about the app.

For more information, refer to our getting started guides for building Bitbucket, Confluence, Jira, and Jira Service Management apps. Our tutorials and guides also offer useful information for common tasks.

The forge register command creates a unique app ID in the manifest.yml file and links the ID to the current developer. Forge apps can currently only be deployed and installed by the developer who is linked to the app.

Compass details app

Displays details about various Compass entities on pages in the Compass component side navigation

Compass web trigger app

Creates a web trigger to receive and display a message of the day on the Compass admin page for the app.

Compass metrics and events ingestor app

Demonstrates a basic admin page skeleton for requesting API credentials. Uses the dataProvider module and webtriggers to set up and ingest metrics and events on a Compass component.

Rate this page: