Confluence

Explore 6 actions and their permissionsExact inputs, sign-in scopes, access limits and approval rules.

With Confluence, a hire can:

• list your spaces and search pages and blog posts by the words in them,
• read a page as plain text, with its latest comments,
• write a new page in a space, under a parent page if you like,
• add to a page (new paragraphs at the end, leaving its tables and macros as they are), or replace its text and rename it when asked,
• comment at the bottom of a page.

Your runbooks, specs, postmortems and help articles become something hires answer from, and keep up to date. It works on Confluence Cloud (atlassian.net) and on Confluence Data Center or Server that you run yourself.

1. Choose how Roster signs inCopy Anchor Link

Confluence signs in the same three ways as Jira:

• Confluence Cloud: email and API token. Open your Atlassian API tokens (the form in Roster links there too) as the account hires should act as, click Create API token, name it Roster and copy it.
• Confluence Cloud: an OAuth app of yours. At developer.atlassian.com/console/myapps, create an OAuth 2.0 integration, add the Confluence API with read:page:confluence, write:page:confluence, read:space:confluence, read:comment:confluence, write:comment:confluence and search:confluence, and set the callback URL to the address Roster shows on the connection (it ends in /api/integrations/confluence/oauth/callback).
• Confluence Data Center or Server: personal access token. In Confluence, click your avatar → Settings → Personal Access Tokens → Create token.

What hires write shows as the account the token or app belongs to, so you may want an account just for Roster, with access to the spaces hires work in.

2. Connect it in RosterCopy Anchor Link

1. Open Integrations → Tools → Add a tool, search for Confluence and choose it.
2. How Roster signs in: pick the way you chose above. Only its fields are shown.
3. Paste the email and API token, the personal access token, or the OAuth app's client ID and secret.
4. Confluence address: like https://acme.atlassian.net (with or without /wiki), or your own server's address, like https://wiki.example.com/confluence.
5. Click Connect. With an API token or a personal access token, Roster asks Confluence who it belongs to, and the connection shows Connected as that account and your site. If Confluence refuses it, Roster says so and saves nothing. With an OAuth app, then click Connect with Confluence and accept.

3. Give hires accessCopy Anchor Link

On the hire's Tools tab, click Give access on Confluence:

• Read only: it can list spaces, search and read pages, and nothing else.
• Read and write: it can also write pages, add to or rewrite them, and comment.
• Spaces: space keys like ENG or SUPPORT. Leave it empty for every space the account can reach. Anything outside the list is refused, searches included, and a new page can only go under a parent in the same space.

Hires refer to pages by their id, the number in the page's address. Every change a hire makes is a new version of the page, so Confluence's page history shows it and can undo it.

If something goes wrongCopy Anchor Link

• "Didn't accept the connection's credential": the token was revoked or expired, or the email doesn't match the token's account.
• "Says that conflicts" when updating: someone saved the page at the same moment. Ask the hire to try again; it reads the latest version first.
• Search finds nothing new: Confluence indexes changes within a minute or so.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {}
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "words to look for"
    },
    "space": {
      "type": "string",
      "pattern": "^~?[A-Za-z0-9][A-Za-z0-9:_-]{0,254}$",
      "description": "space key, e.g. ENG"
    },
    "limit": {
      "default": 15,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  },
  "required": [
    "text"
  ]
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^\\d{1,20}$",
      "description": "the page's id, the number in its address"
    }
  },
  "required": [
    "id"
  ]
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "space": {
      "type": "string",
      "pattern": "^~?[A-Za-z0-9][A-Za-z0-9:_-]{0,254}$",
      "description": "space key, e.g. ENG"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "description": "plain text; blank lines start new paragraphs"
    },
    "parent": {
      "description": "the parent page's id; it must be in the same space",
      "type": "string",
      "pattern": "^\\d{1,20}$"
    }
  },
  "required": [
    "space",
    "title",
    "body"
  ]
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^\\d{1,20}$",
      "description": "the page's id, the number in its address"
    },
    "body": {
      "description": "plain text to add, or the whole new text with mode replace",
      "type": "string"
    },
    "mode": {
      "default": "append",
      "type": "string",
      "enum": [
        "append",
        "replace"
      ]
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "required": [
    "id"
  ]
}

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^\\d{1,20}$",
      "description": "the page's id, the number in its address"
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "description": "plain text"
    }
  },
  "required": [
    "id",
    "body"
  ]
}