Modules

While the Forge platform is generally available, some 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.

Within the manifest.yml file, the modules dictionary defines the functions that contain your app's logic, and the different modules your app uses to integrate with Atlassian products.

Example

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

Common modules

You can use the following modules with Jira, Confluence, and Compass:

Compass modules

You can only use these modules with 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: