Last updated Apr 1, 2023

Modules

Modules are defined in the manifest, and they describe how Forge apps extend and interact with Atlassian products.

Here are some examples of what you can do with Forge modules:

Create new custom fields in Jira
Add new menu items in Jira issues
Display app content in Confluence pages and blogs
Create Confluence custom content, such as templates, forms, or macros
Add a pull request card in Bitbucket
Use webhooks to listen for events

Some Forge modules remain in beta. While in beta, we may make changes that might break your apps. Learn more about the Forge deprecation policy, and what this means for functionality in beta.

Example

Here's an example of how modules appear in the manifest.yml file.

1
2
modules:
  macro:
    - key: hello-world-macro
      function: hello-world-macro-func
      title: Hello world macro!
      description: Inserts hello world!
  webtrigger:
    - key: webtrigger-sync
      function: my-forge-app-sync-func
    - key: my-webtrigger-async
      function: my-async-func
  trigger:
    - key: issue-creation-trigger
      events:
        - avi:jira:created:issue
        - avi:jira:updated:issue
      function: issue-trigger-func
  jira:workflowValidator:
    - key: my-forge-workflow-validator
      name: My example Forge workflow validator
      description: The description of my example Forge workflow validator
      function: my-forge-validator-function
  function:
    - key: my-forge-app-sync-func
      handler: index.runSync
    - key: my-async-func
      handler: index.runAsync
    - key: hello-world-macro-func
      handler: macro.run
    - key: issue-trigger-func
      handler: jira.issueCreationTrigger
    - key: my-forge-validator-function
      handler: index.runValidate

Reference documentation

To learn more, check out the modules reference documentation.

Consumer

Define how the queue processes async events with the consumer module.

Function

Define the app's behavior in the function module.

Scheduled trigger

Invoke a function repeatedly using the scheduledTrigger module. Each trigger starts about 5 minutes after app deployment and then runs at set intervals—hourly, daily, or weekly.

Trigger

Invoke a function with the trigger module when a product event, app lifecycle event, or data security policy event occurs. For example, when an issue is created in Jira.

Web trigger

Invoke a function with the webtrigger module when an HTTP request is made. Use the web trigger runtime API within your app to get the URL for calling the web trigger.

Compass modules

You can only use these modules with Compass:

The ability to access UI extensions in Compass depends on your user role. Product admins can access all extensions, while full users can access some extensions. Basic users can't access any extensions in Compass.

Compass admin page

Add an app configuration page that is accessible by Compass admins.

Compass component page

Add an item to the left navigation on the Compass component details page.

Compass data provider

Enable apps to send events and metrics to Compass when specific links are added to a component.

Compass global page

Create a page in the Apps dropdown, which displays as a new Compass page for all users.

Compass team page

Add an item to the left navigation on the Compass team details page.

Confluence modules

You can only use these modules with Confluence:

Confluence content action

Add a menu item to the more actions menu for pages and blogs.

Confluence content byline item

Add an entry to the content byline section, displaying the module's title, icon, and tooltip under the title, next to the contributor metadata.

Confluence context menu

Add an entry to the context menu when text is selected on a page or blog.

Confluence custom content

Create custom content types that integrate with existing structures and support search and indexing.

Confluence global page

Create top-level pages which can be accessed via the Apps section of the main navigation menu.

Confluence global settings

Add top-level settings and enhance app configuration.

Confluence homepage feed

Add dynamic content in the right side panel of the Confluence home page.

Confluence space page

Create dedicated pages within a Confluence space.

Confluence space settings

Add a tab to the integration settings of a Confluence space.

Macro

Insert dynamic content into the user interface through an editor.

Jira modules

You can only use these modules with Jira:

Jira admin page

Add an item to the Apps section of the left navigation in Jira admin settings.

Jira custom field

Create a new custom field to help users add information to issues tailored to their team's needs.

Jira custom field type

Create a new custom field type, allowing administrators to create custom fields based on it.

Jira dashboard action script

Add an invisible container to the Dashboards page.

Jira dashboard gadget

Create a dashboard gadget displayed on the Dashboards page.

Jira entity property

Request indexing of an entity property's fields by Jira to make them queryable in JQL.

Jira global page

Add an item to the Apps section of the main navigation that opens as a full-page.

Jira global permission

Create custom global permissions in Jira, manageable by admins and accessible via REST APIs.

Jira issue action

Add a menu item to the more actions menu on the issue view.

Jira issue activity

Add an item to the Activity panel of Jira issues.

Jira issue context

Add a collapsible panel below other fields on the right side of the issue view.

Jira issue glance

Add an issue glance allowing content to be shown or hidden.

Jira issue navigator action

Add a menu item to the apps menu on the issue navigator view.

Jira issue panel

Add issue panels for detailed issue views.

Jira issue view background script

Add an invisible container to run background scripts for dynamic updates.

Jira JQL function (preview)

Enable your app to define custom JQL functions.

Jira project page

Add an custom project page to enhance project navigation and access.

Jira project permission

Create custom project-specific permissions in Jira, manageable by admins and accessible via REST APIs.

Jira project settings page

Add an item to the project settings sidebar.

Jira UI modifications

Modify the Jira UI using the UI modifications APIs.

Jira time tracking provider (preview)

Add a time tracking provider to customize the work log experience.

Jira workflow validator (preview)

Create workflow validators for process control.

Jira workflow condition (preview)

Create Jira workflow conditions to customize and control workflow transitions.

Jira workflow post function (preview)

Create Jira workflow post functions to automate tasks and enhance workflow.

Jira Service Management modules

You can only use these modules with Jira Service Management:

Jira Service Management assets import type

Display a modal to set up Forge imports, including login and app configuration details.

Jira Service Management organization panel

Add a panel to the Organization page in the Project settings section.

Jira Service Management portal footer

Add a panel at the bottom of customer portal pages.

Jira Service Management portal header

Add a panel at the top of customer portal pages.

Jira Service Management portal profile panel

Add a panel to the Profile page.

Jira Service Management portal request create property panel

Display a panel on the request creation screen in the customer portal.

Jira Service Management portal request detail

Add a panel to a portal request, displaying content below the Activity panel.

Jira Service Management portal request detail panel

Add a panel to display information in the right sidebar of the portal request screen.

Jira Service Management portal request view action

Add items to the request view sidebar to open a modal with more app information.

Jira Service Management portal subheader

Add a panel under the title of customer portal pages.

Jira Service Management portal user menu action

Add a menu item to the customer portal, which displays as a modal dialog.

Jira Service Management queue page

Add an item to the left sidebar queues in a project to display a page with information related to that queue.

-->