Overview
Atlassian Confluence is the team wiki / knowledge platform – spaces, pages, blog posts. The Automize Confluence connector covers page CRUD, space listing, search, attachments, and comments via the Confluence Cloud REST API.
- Regions: Confluence Cloud is global – talks to yourcompany.atlassian.net. Server / Data Center editions use a different REST API surface (v1 vs v2) and would need separate configuration. The current connector targets Cloud.
- Plans: Free, Standard, Premium, Enterprise – all expose the REST API. Read-only macros (Excel etc.) work everywhere; advanced page macros need Premium/Enterprise.
Setting up the connection
Auth type: HTTP Basic.
- Sign in to id.atlassian.com → Security → API tokens.
- Create an API token. Name it (e.g. Automize). Copy it.
- In Automize, open Settings → Connectors → Confluence → Add connection. Enter your atlassian.net sub-domain, username = your Atlassian email, password = the API token.
Find your credentials at https://id.atlassian.com/manage-profile/security/api-tokens.
Rate limits
Confluence Cloud enforces ~5,000 req/hour per user. The connector retries 429 with exponential backoff. Heavy reads should paginate via limit + start (max limit=200).
Data model
Confluence's primitives:
Space ─┬─ Pages ─┬─ Child pages (recursive tree)
│ ├─ Comments
│ └─ Attachments
└─ Blog posts
Pages have content in 'storage' format (Confluence XHTML) – different
from Markdown. Use Confluence's converter or the storage format
reference when authoring.Available operations
9 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Create Page | General | Create a new page |
| Delete Page | General | Delete a page |
| Get Page | General | Get page details |
| Get Space | General | Get space details |
| List Attachments | General | List attachments on a page |
| List Pages | General | List pages in a space |
| List Spaces | General | List all spaces |
| Search | General | Search content using CQL |
| Update Page | General | Update a page |
Operations
Create Page
Create a new page
| Parameter | Required | Type | Description |
|---|---|---|---|
Spaceid spaceId | Yes | text | |
Status status | Yes | text | |
Title title | Yes | text | |
Body body | Yes | textarea |
Tips
- space_key + title + body (in storage format).
- parent_id (optional) makes it a child page in the space tree.
Errors
A page with this title already exists– Page titles must be unique within a space. Append a suffix or update existing.
Delete Page
Delete a page
| Parameter | Required | Type | Description |
|---|---|---|---|
Page Id page_id | Yes | text |
Tips
- Soft-deletes (moves to trash). Restorable from space admin → trash.
Get Page
Get page details
| Parameter | Required | Type | Description |
|---|---|---|---|
Page Id page_id | Yes | text |
Tips
- page_id (numeric). expand=body.storage,version,space,ancestors to fold in nested data.
Get Space
Get space details
| Parameter | Required | Type | Description |
|---|---|---|---|
Space Id space_id | Yes | text |
List Attachments
List attachments on a page
| Parameter | Required | Type | Description |
|---|---|---|---|
Page Id page_id | Yes | text |
Tips
- Attachments on a page. Returns metadata; use Download Attachment (separate endpoint) for bytes.
List Pages
List pages in a space
No input parameters.
Tips
- Lists pages in a space. Filter by space_key + parent_id.
List Spaces
List all spaces
No input parameters.
Tips
- Returns all spaces visible to the user.
- Filter by type (global, personal). Paginate via limit + start.
Search
Search content using CQL
No input parameters.
Tips
- cql: Confluence Query Language (e.g. 'space = MYSPACE AND type = page AND text ~ "design doc"').
- Used by the Confluence search bar.
Update Page
Update a page
| Parameter | Required | Type | Description |
|---|---|---|---|
Page Id page_id | Yes | text | |
Id id | Yes | text | |
Status status | Yes | text | |
Title title | Yes | text | |
Body body | Yes | textarea | |
Version version | Yes | text |
Tips
- PUT-style. MUST include the current version number + 1 – Confluence uses optimistic locking.
- Get current version from Get Page → version.number, then send version: {number: current+1}.
Errors
Cannot upgrade page from version X to Y– Stale version number. Get the page again, increment, retry.
FAQ
- Storage format vs Markdown vs Wiki – which?
- Confluence storage format is XHTML with custom macros (e.g. <ac:structured-macro ac:name='code'>). Markdown isn't natively supported via API. Use Atlassian's Storage Format reference or convert Markdown → storage upstream.
- Why does Update Page fail with 'cannot upgrade version'?
- You sent an outdated version number. Confluence uses optimistic locking. Always Get Page first to read the current version, then increment + send.
- Server / DC vs Cloud – same connector?
- This targets Cloud (REST API v1/v2 via atlassian.net). Server/DC have a different REST API (different paths). Use a separate connection / connector for Server/DC.
- How do I publish a draft vs live page?
- Create Page defaults to live (status=current). For drafts, pass status=draft. Draft pages don't appear in space navigation until published.