Configuring Atlassian Confluence

info

Dispatch ships with Atlassian Confluence storage and document plugins. This page describes the available configurations for the plugins.

Dispatch configuration variables for storage plugin

API URL [Required]

URL of the Confluence instance. For Cloud this is the site root, for example https://your-site.atlassian.net/; Dispatch appends the /wiki path itself, including for a site on a custom domain. For Server/Data Center this is the instance URL, including any context path it is served under.

Hosting Type [Default: cloud]

Either cloud or server. Dispatch reaches Confluence Cloud over the REST v2 API and Confluence Server/Data Center over REST v1; these are different APIs, so this must match the deployment.

Username [Required]

Username for accessing the confluence instance. This user should have permission to create pages in the space.

Password [Required]

API token to access the confluence instance. Please refer to the link on creating a new API token.

Root Incident Storage Page ID [Required]

Page id of the page each incident's own page is created under, found in the page URL: /pages/<id>/<title>.

This is a page id, not a space key, and it must be a page rather than a Confluence Cloud folder. A document cannot live in a Confluence folder, so Dispatch's storage hierarchy is pages beneath pages: the incident's page under this one, and its sub-pages under that. The space is read from this page, so there is nothing else to configure; every incident lands in that space unless the project routes it elsewhere with a storage tag type.

Confluence requires page titles to be unique within a space, while Dispatch names each incident's sub-folders from the project's storage_folder_one/storage_folder_two settings — the same names for every incident. Dispatch therefore prefixes a sub-page's title with the incident's own page title, so the folder named Logs is created as INC-0001 - Logs. The name shown in Dispatch is unchanged.

warning

Earlier releases took a space key here, alongside a separate Parent ID of the pages field. Upgrading moves that parent page id into this field and drops the old one, so an existing instance needs no edit. Setting it by hand is the case to watch: a space key cannot be read as a page, so no incident storage is created and each attempt logs Exception happened while creating page … under <space key>.

Open On Close [Default: false]

Controls the visibility of resources on incident close. If enabled, Dispatch will make all resources visible to the entire workspace.

note

The Confluence plugin does not implement this yet; the setting is accepted and has no effect. Closing an incident logs a failure event for the attempt.

Readonly [Default: false]

The incident document will be marked as readonly on incident close. Participants will still be able to interact with the document but any other viewers will not.

note

The Confluence plugin does not implement this yet, in the same way as Open On Close above.

Dispatch Configuration Variables for document plugin

API URL [Required]

URL of the Confluence instance. For Cloud this is the site root, for example https://your-site.atlassian.net/; Dispatch appends the /wiki path itself, including for a site on a custom domain. For Server/Data Center this is the instance URL, including any context path it is served under.

Hosting Type [Default: cloud]

Either cloud or server. Dispatch reaches Confluence Cloud over the REST v2 API and Confluence Server/Data Center over REST v1; these are different APIs, so this must match the deployment.

Username [Required]

Username for accessing the confluence instance. This user should have permission to create pages in the space.

Password [Required]

API token to access the confluence instance. Please refer to the link on creating a new API token.