Static Content Macro

A key to identify the macro. Keys must only contain alphanumeric characters and dashes, and must be globally unique. Prefixing it with the name of your add-on is the best way to ensure this.

A human readable name.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4

{
  "value": "My text"
}

The link to the add-on resource that provides the macro content. This URL has to be relative to the add-on base URL.

Additional context parameters can be passed as variables in the URL:

1
2
3
4
5

 {
   "url": "/macro-renderer?body={macro.body}&spaceid={space.id}&pageid={page.id}"
 }
 

Since macro bodies can be of arbitrary size and may contain sensitive data, care must be taken as to how its passed to your connect add-on. You have three options to gain access to the body:

- If you can predict the size of your body and it is consistently less than 128 characters, you can include it in the GET request using the {macro.body} parameter.
- If you know your macro contains a body that will often exceed the 128 character threshold (or is known to contain sensitive data), then you can include the {macro.id} parameter and use the Confluence REST api to call back to collect the body.
- If you want, you can include, {macro.body}, {macro.id}, and {macro.truncated}. This way your plugin can call back to confluence only if {macro.truncated} is 'true'. This will allow you to skip the callback if it's not needed. This would be useful for macros that don't contain sensitive data of an unpredictable size.

Note: If you include the {macro.body} in your URL you are potentially leaking sensitive data to any intermediate host on the internet. This may result in the body being cached or indexed by a third party. If you are concerned about the security of your macro, you should always use the {macro.id} and use the Confluence REST API to collect the body.

Here's an example:

Declare the variables that are later required to fetch the macro content in the URL:

1
2
3
4
5

 {
   "url": "/render-macro?pageId={page.id}&pageVersion={page.version}&macroId={macro.id}"
 }
 

Then use the Confluence REST API to collect the body, for example directly from the iframe:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

 AP.require("request", function(request) {
     var pageId = getUrlParameter("pageId");
     var pageVersion = getUrlParameter("pageVersion");
     var macroId = getUrlParameter("macroId");
     request({
         url: "/rest/api/content/" + pageId +
              "/history/" + pageVersion +
              "/macro/id/" + macroId,
         success: function(response) {
             var macro = JSON.parse(response);
             process(macro.body);
         }
     });
 });
 

Preview Mode: If you use the {macro.id} in your URL, the REST api will not return the macro body during a preview request, because the page has not been saved yet. You can use the {output.type} parameter to detect whether the macro is rendered in preview mode and adapt the response accordingly.

Note: macro.body will not be truncated when renderingMethod field was set to POST in static content macro. Refer to the Static Content Macros for information on how to set this field.

Currently supported variables for macros are:

- macro.hash: The hash of the macro body (deprecated, use the macro.id)
- macro.id: The id of the macro
- macro.body: The macro body, truncated to 128 characters
- macro.truncated: True if the macro body was truncated, false of not
- page.id: The page ID, e.g. 1376295
- page.title: The page title, e.g. My Page
- page.type: The page type, e.g. page
- page.version: The page version, e.g. 6
- space.id: The space ID, e.g. 65537
- space.key: The space key, e.g. AC
- user.id: The user ID, e.g. admin (deprecated in GDPR mode)
- user.key: The user key, e.g. ff80808143087d180143087d3a910004 (deprecated in GDPR mode)
- output.type: The output type, e.g. display or preview

Context parameters for macros are also required in the URL. Please see the Macro Input Parameter documentation for details.

Define aliases for the macro. The macro browser will open for the defined aliases as if it were this macro.

URL patterns associated with this macro. If a URL matching a defined pattern is pasted into the editor, this macro will be created and will replace the URL string.

Autoconvert allows your macro to be inserted into the editor when a recognised URL is pasted in by the user. You define recognised URL patterns using 'matchers' which are registered in the editor when your add-on is installed.

When the macro is created in the editor, the URL string that triggered the autoconvert will be captured and inserted as a parameter on the macro body. You must define the name of this parameter by providing a string value for 'urlParameter'. This allows you to access the URL that triggered the autoconvert.

Example

This example inserts a macro into the editor when a user pastes in certain simple Facebook links.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

{
  "renderModes": {},
  "url": "/dynamic-macro?url={url}",
  "categories": [],
  "outputType": "block",
  "bodyType": "none",
  "aliases": [],
  "parameters": [
    {
      "identifier": "url",
      "name": {
        "value": "URL"
      },
      "type": "string",
      "required": false,
      "multiple": false,
      "hidden": false
    }
  ],
  "autoconvert": {
    "urlParameter": "url",
    "matchers": [
      {
        "pattern": "https://www.facebook.com/{}/about"
      },
      {
        "pattern": "https://www.facebook.com/{}/music"
      },
      {
        "pattern": "https://www.facebook.com/{}/movies/{}"
      }
    ]
  },
  "name": {
    "value": "Dynamic Macro With Autoconvert"
  },
  "key": "dynamic-macro-with-autoconvert"
}

• rich-text
• RICH-TEXT
• multi-body-rich-text
• MULTI-BODY-RICH-TEXT
• plain-text
• PLAIN-TEXT
• none
• NONE

The type of body content, if any, for this macro.

The categories the macro should appear in. A macro with no category will show up in the default 'All' category.

Currently, the following categories are supported by Confluence:

• admin: Administration
• communication: Communication
• confluence-content: Confluence Content
• development: Development
• external-content: External Content
• formatting: Formatting
• media: Media
• navigation: Navigation
• reporting: Reporting
• visuals: Visuals & Images

A description of the macro's functionality.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
4

{
  "value": "My text"
}

A link to the documentation for the macro.

Represents a link, its optional title and alternative text.

Example

1
2
3
4
5
6
7
8

{
  "link": {
    "url": "/go-somewhere",
    "title": "Go Somewhere",
    "altText": "somewhere"
  }
}

The configuration of a custom macro editor. This is useful if the parameter input field types are not sufficient to configure the macro.

Macro Parameters go a long way when it comes to macro configuration, but there are cases when a macro add-on needs more control over the UI.

Defining a Macro Editor allows you to implement a custom UI for the macro, by specifying a URL to a page in your add-on which will be shown in the dialog iFrame.

In order to persist custom data in your macro editor, use the Javascript Confluence API and the Dialog API. For example:

AP.require(["confluence", "dialog"], function (confluence, dialog) { function onSubmit() { var macroParams = { myParameter: value }; confluence.saveMacro(macroParams); confluence.closeMacroEditor(); return true; }

dialog.getButton("submit").bind(onSubmit); });

In order to retrieve the custom data again when the editor is opened, use confluence.getMacroData (see Confluence API):

AP.require("confluence", function (confluence) { var macroData = confluence.getMacroData(function(macroParams) { doSomethingWith(macroParams.myParameter); }); });

Example

1
2
3
4
5
6
7
8
9
10
11
12

{
  "editor": {
    "url": "/map-editor",
    "editTitle": {
      "value": "Edit Map"
    },
    "insertTitle": {
      "value": "Insert Map"
    }
  }
}

Whether the macro should be "featured", meaning having an additional link in the "Insert More Content" menu in the editor toolbar.

If set to true, the macro will not appear in the macro browser.

A link to the icon resource (80x80 pixels) that will be shown in the macro selection dialog. The URL can be absolute or relative to the add-on base URL.

Defines an icon to display.

Example

1
2
3
4
5
6
7
8

{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

The image rendered in the editor as the macro placeholder. It can only be used with bodyless macros and will behave just like a regular macro placeholder. Any parameter changes in the macro browser will cause the image to be reloaded - so that changes can be seen.

Defines a macro image placeholder to display in the Confluence editor.

Example

1
2
3
4
5
6
7
8
9

{
  "imagePlaceholder": {
    "width": 100,
    "height": 25,
    "url": "/images/placeholder.png",
    "applyChrome": true
  }
}

• block
• BLOCK
• inline
• INLINE

How this macro should be placed along side other page content.

The list of parameter input fields that will be displayed.

The configuration of a property panel. Specify a hidden iframe to be loaded in the macro's property panel.

Defining a Macro Property panel allows you to add a hidden iframe to your macro's property panel. The iframe is loaded as soon as the property panel is opened.

In order to persist custom data using your property panel, use the Javascript Confluence API. For example:

AP.require(["confluence"], function (confluence) { var macroParams = { myParameter: value }; confluence.saveMacro(macroParams); });

In order to retrieve the custom data again when the property panel is opened, use confluence.getMacroData (see Confluence API):

AP.require("confluence", function (confluence) { var macroData = confluence.getMacroData(function(macroParams) { doSomethingWith(macroParams.myParameter); }); });

Dialogs may also be created. Use dialog.create (see Dialog API):

AP.require('dialog', function(dialog) { dialog.create({ key: 'my-module-key', width: '500px', height: '200px', chrome: true }).on("close", callbackFunc); });

• get
• GET
• post
• POST

HTTP method that will be used in the HTTP request.

For example:
If the rendering method was set to POST like this:

1
2
3
4
5
6

 {
     "renderingMethod": "POST",
     "url": "/macro-renderer?body={macro.body}"
 }
 

Then Confluence will send a POST request to /macro-renderer like:

1
2
3
4
5
6
7
8
9
10

   POST /macro-renderer HTTP/1.1
   Authorization: JWT <JWT token>
   Content-Type: application/x-www-form-urlencoded
   Transfer-Encoding: chunked
   Host: <host>
   User-Agent: Atlassian HttpClient <atlassian http client version> / Confluence-<confluence version> / Atlassian-Connect/<connect version>

body=<macro body>&<some value>&pageVersion=<some value>&tz=<some value>&lic=<some value>&userkey=<some value>&xd&e=<some value>&cp=<some value>&xdmc=<some value>&cv=<some value>&userid=<some value>
 

Note: All the parameters will be sent via POST payload in application/x-www-form-urlencoded instead of URL query parameters.
The latest version of Atlassian Connect Express and Atlassian Connect Spring Boot have built-in support for verifying requests sent by POST. However you might need to implement the query hash verification if the framework you are using doesn't support it.