Confluence

You can integrate your TeamRetro team with your Confluence Cloud or Confluence Server Space to publish retrospective and health check summaries. To configure this integration you must be a TeamRetro team administrator.


Supported Confluence editions:

  • Confluence (Cloud)
  • Confluence (Data Center)
  • Confluence (Server)

Supported authentication methods:

  • Confluence Cloud - Atlassian Login - connect to your Confluence (Cloud) instance using the Atlassian Cloud Oauth2 provider.
  • Confluence Cloud - API Token - connect to your Confluence (Cloud) instance with a secure way of using scripts.
  • Confluence Server / Data Center - Personal Access Token - connect to your Confluence (Data Center / Server) using personal access tokens as a safe alternative to authenticating with a username and password.
  • Confluence Server / Data Center - Basic Authentication - connect to your Confluence (Data Center / Server) using username / password.

  • Confluence Server / Data Center - Application Link - connect to your Confluence (Data Center / Server) using your Confluence instance as an Oauth provider.


Please note if connecting to Data Center or Server editions, your Confluence instance must be publicly accessible on the internet (so our application can talk to it). For further information on how our Confluence integrations work and the authorization scopes requested, please refer to Confluence Integration Security.



Configure in TeamRetro


  1. On the TEAM > SETTINGS > INTEGRATIONS screen

  2. Click CONNECT next to Confluence.


  3. In the configuration dialog, select the AUTHENTICATION METHOD you wish to use.
    1. Confluence Cloud - Atlassian Login
    2. Confluence Cloud - API Token
    3. Confluence Server / Data Center - Personal Access Token

    4. Confluence Server / Data Center - Basic Authentication

      Confluence Server / Data Center - Application Link


If you selected Confluence Cloud - Atlassian Login for Confluence (Cloud):

    1. Click Sign In To Confluence Cloud.

    2. You will be redirected to atlassian.com to authorize TeamRetro to post pages to your space.

      For further information how our Confluence integrations work and the authorization scopes requested, please refer to Confluence Integration Security.


    3. Click on Accept to authorize TeamRetro.


    4. Select your Atlassian Cloud instance from the dropdown


    5. Click NEXT (->)


If you selected Confluence Cloud - API Token for Confluence (Cloud), you first need to configure the API Token in your Confluence instance.

    1. Open your Confluence instance in a new tab and navigate to Your profile and settings > Manage account.
    2. You will be directed to your Atlassian Account. Select the Security tab.
    3. Click Create and manage API tokens.

    4. Click Create API token.


    5. In the Create API token dialog:
      1. Enter a Label for your token: TeamRetro (or similar).

      2. Click Create.


      3. On the new API token screen, make note of or copy your API token.

    6. Return to the TeamRetro tab.
    7. Enter your Server URL (note: your Confluence instance must be accessible on the public internet to our IP addresses).
    8. Enter your API token (provided by Confluence).
    9. Enter your Email Address (provided by Confluence).

    10. Click Next (->).


If you selected Confluence Server / Data Center - Personal Access Token for Confluence (Data Center) or Confluence (Server), you first need to configure the Access token in your Confluence instance.

  1. Open your Confluence instance in a new tab and navigate to Your profile picture > Setting > Personal Access Token.
    1. Click Create Token.
    2. In the Create a personal access token dialog:
      1. Enter a Name for your token: TeamRetro (or similar).
      2. Select Expiry date (you can select Automatic expiry or Never expiry).

      3. Click Create.

    3. On the Credentials screen, make note of or copy your Personal Access Token.

    4. Return to the TeamRetro tab.
    5. Enter your Server URL (note: your Confluence instance must be accessible on the public internet to our IP addresses).

    6. Enter your Personal Access Token (provided by Confluence).

    7. Click Next (->).


If you selected Confluence Server / Data Center - Basic Authentication for Confluence (Data Center) or Confluence (Server):

Enter your:

    1. Server URL (note: your Confluence instance must be accessible on the public internet to our IP addresses).
    2. Confluence Username (we recommend creating a new user with minimal permissions for this).

    3. Confluence Password

    4. Click Next (->).


If you selected Confluence Server / Data Center - Application Link for Confluence (Data Center) or Confluence (Server), you first need to configure the Application Link in your Confluence instance.

    1. Open your Confluence instance in a new tab and navigate to Confluence Administrator.
    2. Select Application Links under Administration on the left side.
    3. Click Create Link.
    4. In the Create Link dialog:
      1. Select External Application.
      2. Select Incoming.

      3. Click Continue.

      4. On the Configure an incoming link page:
        1. Enter Name: TeamRetro (or similar).

        2. Enter Redirect URL:

          https://oauth.teamretro.com/integrations/Confluence/applicationLink (for US environment).

          https://oauth.eu.teamretro.com/integrations/Confluence/applicationLink (for EU environment).

        3. Select Permission: Write.

        4. Click Save.

        5. On the Credentials screen, make note of or copy your Client ID and Client secret.

      5. Return to the TeamRetro tab
        1. Enter your: Server URL (note: your Confluence instance must be accessible on the public internet to our IP addresses).
        2. Enter your Client ID (provided by Confluence).
        3. Enter your Client Secret (provided by Confluence).

        4. Click Next (->).


      6. Click Sign In To Confluence

      7. Your Confluence instance will prompt you to authorize TeamRetro for access, click Allow.


  1. On the CONFIGURATION screen -
    1. Choose the Space that is associated with this TeamRetro team.
    2. Choose the Retrospective Parent Page (You can choose None, Create a new parent page or choose the existing page. By default it is “None”).

    3. Enter your Retrospective Page Title (By default TeamRetro will make a page title as “{{RetrospectiveTitleOrDate}} - Retrospective”. If you wish to change where your retrospective pages are created in your space, you can enter the preferred page titles.


      The following substitutions are supported in Retrospective Page Title:

      {{RetrospectiveTitleOrDate}} eg. Sprint 22

      {{YY}} eg. 23 (meeting year)

      {{YYYY}} eg. 2023 (meeting year)

      {{MM}} eg. 03 (meeting month)

      {{MMM}} eg. Mar (meeting month)

      {{MMMM}} eg. March (meeting month)

      {{D}} eg. 3 (day of month)

      {{DD}} eg. 03 (day of month)

      {{Do}} eg. 3rd (day of month)


    4. Choose the Health Check Parent Page (You can choose None, Create a new parent page or choose the existing page. By default it is “None”).

    5. Enter your Health Check Page Title (By default TeamRetro will make a page title as “{{HealthCheckTitleOrDate}} - Health Check”. If you wish to change where your health check pages are created in your space, you can enter the preferred page titles.


      • The following substitutions are supported in Health Check Page Title:

        {{HealthCheckTitleOrDate}} eg. Sprint 22

        (date options as above)



    6. Click Next (->).


  2. On the TEST screen - click "Publish Test Retrospective Summary" or “Publish Test Health Check Summary” to confirm that your integration is set up correctly. If the new summary item is published successfully, you will see a notification with the option to View in Confluence or Delete. If an error is encountered (such as a missing required field) details will be displayed.




  3. Click SAVE CHANGES.


Using your Integration


On the "Share" step of each retrospective and health check, you'll now be able to click the publish button and select "Publish to Confluence".


Still need help? Contact Us Contact Us

Related Articles