About Connect modules for Confluence

Build with Forge

Forge is our next-generation developer platform, offering developers the best the Atlassian platform has to offer. Learn more about Forge

Already have a Connect app? Start adding Forge features in less than an hour, without changing anything about your existing app.

Connect modules allow Connect apps to extend the Confluence user interface, create custom Macros or content, handle event listening (webhooks), and even run scripts or other code. If you're not familiar with Connect apps, learn how Connect works first.

Add modules to your Connect app

To use a module in your app, declare the module in your App descriptor file under modules, including any required properties. The properties you include control the customization options for your module.

For example, this module adds content to the byline of your Confluence pages, just below the page title.

1
2
{
  "modules": {
    "contentBylineItems": [
      {
        "url": "/my-byline-item",
        "context": "addon",
        "target": {
          "type": "inlinedialog"
        },
        "tooltip": {
          "value": "Item Tooltip"
        },
        "name": {
          "value": "Item Text"
        },
        "key": "byline-item",
      }
    ]
  }
}

For more control over when and where some modules are displayed, you can use the conditions property. For example, you may want to display a certain tooltip only if the condition user_is_admin is true. Learn more about Conditions.

Some modules can be registered dynamically at runtime using the REST API, rather than via the app descriptor. See Dynamic modules for more details.

Learn more about how modules work by reading our Confluence modules guide or dive into each module's properties by selecting a module on the left.