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.

Confluence modules

You can only use these modules with Confluence:

Jira modules

You can only use these modules with Jira:

Jira Service Management modules

You can only use these modules with Jira Service Management: