Overview
Confluence is Atlassian’s collaborative workspace. Teams use it to create, share, and organize documentation, meeting notes, project plans, and knowledge bases. Pages are grouped into spaces.
Persona’s Confluence integration lets a Workflow create a page in a Confluence space, update an existing page, and look up spaces and pages. For example, a Workflow can create a page that records the result of a manual review, then update the page when the review is resolved.
Integration features
The Confluence integration supports these Workflow actions:
- Get spaces: List the spaces that the connected Atlassian user can see.
- Get a space by ID: Retrieve one space.
- Get pages in space: List the pages in a space, with optional filters for depth, status, and title.
- Get a page by ID: Retrieve one page, with optional labels, properties, and version history.
- Create a page: Create a page in a space, as a published page or as a draft.
- Update a page: Change the title, content, status, location, or owner of an existing page.
Prerequisites
Before you configure the integration, you need:
- An Atlassian account with access to a Confluence Cloud site.
- Your Atlassian Cloud ID. To find it, follow Atlassian’s guide.
Set up Confluence credentials
Confluence connects through OAuth, so you sign in to Atlassian rather than pasting a key.
- In the Persona Dashboard, go to Integrations > Marketplace and select Confluence.
- Click Add Credential and enter a nickname for the credential.
- Sign in to Atlassian, select your Confluence site, and approve the requested access. The integration asks for permission to view pages, create and update pages, and view spaces.
- Enter your Atlassian Cloud ID when prompted.
- Save the credential.
The credential works only against the Confluence site whose Cloud ID you entered. To work with a different site, create a separate credential.
Use Confluence in a Workflow
- Create a Workflow, or open the Workflow you want to update.
- Add an Action step and select Integrations.
- Select Confluence, choose the saved credential, and select an action.
- Map Persona data to the action’s input fields.
- Save and publish the Workflow.
Confluence actions
Most actions need IDs from other actions. A typical setup uses Get spaces to find the Space ID, then Get pages in space to find a Page ID.
Get spaces
Returns the spaces that the connected user can see. Use it to find the Space ID that other actions require.
Optional fields include: Space IDs, Space Keys, Type, Status, Labels, Sort, Description Format, Include Icon, Cursor, Limit.
Get a space by ID
Returns one space.
Required fields: Space ID.
Optional fields: Description Format, Include Icon.
Get pages in space
Returns the pages in a space. Use it to find the Page ID for Get a page by ID and Update a page.
Required fields: Space ID.
Optional fields include: Depth, Sort, Status, Title, Body Format, Cursor, Limit.
Get a page by ID
Returns one page.
Required fields: Page ID.
Optional fields include:
- Body Format: Return the page content in storage format or Atlassian Document Format.
- Get Draft: Return the draft version of the page, if one exists.
- Version Number: Return a specific version of the page.
- Include Labels, Include Properties, and Include Versions
Create a page
Creates a page in a space and returns the new page, including its Page ID.
Required fields: Space ID.
Optional fields include:
- Status: Publish the page immediately, or save it as a draft.
- Title: Required when you create a published page.
- Parent Page ID: Create the page under an existing page.
- Body: The page content, as a Representation (Storage Format, Atlas Document Format, or Wiki Markup) and the Content in that format.
Update a page
Updates an existing page and returns the updated page.
Required fields: Page ID, Status, Title, Body, and Version, which contains the New Version Number.
Optional fields include: Space ID, to move the page to a different space. Parent Page ID, to move the page under a different parent page. Owner Account ID, to give the page to a different owner.
The New Version Number must be exactly one more than the page’s current version number. Use Get a page by ID immediately before the update to get the current version number.
FAQs
Why does Update a page return a 409 error?
Confluence returns 409 CONFLICT when the New Version Number is not exactly one more than the page’s current version. This occurs when the page changed after you last read it. Get the page again, then send its current version number plus one.
Which content format should I use for a page body?
Atlassian recommends Atlassian Document Format for new integrations. Storage Format is the older XHTML-based format, and Confluence continues to support it. Confluence accepts Wiki Markup as input, but converts it to one of the other two formats.
Plans Explained
Confluence Integration by plan
| Startup Program | Essential Plan | Growth Plan | Enterprise Plan | |
|---|---|---|---|---|
| Confluence Integration | Not Available | Not Available | Limited | Available |