Confluence
Schema-driven source documentation.
CONFLUENCE44 fields2 examples
Commonly Asked Questions
Assistant knowledge mapped to this source type from
assistant_knowledge.json.Required
Fields required for a valid configuration payload under `config.required`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| required | object | Yes | — | — | no extra properties |
| required.account_email | string | Yes | Atlassian account email used with API token for Basic authentication | — | format email |
| required.base_url | string | Yes | Confluence Cloud tenant URL (for example, https://your-domain.atlassian.net) | — | format uri |
Masked
Sensitive fields under `config.masked` (secrets/credentials).
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| masked | object | Yes | — | — | no extra properties |
| masked.api_token | string | Yes | Atlassian API token for Confluence Cloud | — | — |
Optional
Optional configuration fields under `config.optional`.
| Path | Type | Required | Description | Default | Constraints |
|---|---|---|---|---|---|
| optional | object | No | — | — | no extra properties |
| optional.connection | object | No | HTTP and retry settings for Confluence API calls. | — | no extra properties |
| optional.connection.max_retries | integer | No | Maximum retry attempts for transient API failures and rate limits | 3 | min 0, max 10 |
| optional.connection.rate_limit_delay_seconds | number | No | Additional delay between API requests to reduce rate-limit pressure | 0 | min 0 |
| optional.connection.request_timeout_seconds | number | No | HTTP request timeout for Confluence API calls | 30 | min 1 |
| optional.content | object | No | Confluence content extraction controls. | — | no extra properties |
| optional.content.attachment_max_bytes | integer | No | Maximum bytes downloaded per attachment for MIME inference and text extraction | 5242880 | min 1024 |
| optional.content.include_attachments | boolean | No | Include Confluence page attachments as related assets | true | — |
| optional.content.include_footer_comments | boolean | No | Include footer comments and aggregate them into a per-page comments asset | true | — |
| optional.content.include_inline_comments | boolean | No | Include inline comments and aggregate them into a per-page comments asset | true | — |
| optional.content.include_linked_file_assets | boolean | No | Materialize linked file-like URLs from page body as related assets | true | — |
| optional.scope | object | No | — | — | no extra properties |
| optional.scope.spaces | object | No | Space-level filters passed to Confluence /spaces endpoint. | — | no extra properties |
| optional.scope.spaces.type | enum | No | Filter spaces by space type Allowed values: global, collaboration, knowledge_base, personal, system, onboarding, xflow_sample_space | — | — |
| optional.scope.spaces.ids | array | No | Filter spaces by IDs (up to 250) | — | max items 250 |
| optional.scope.spaces.ids[] | integer | No | — | — | — |
| optional.scope.spaces.keys | array | No | Filter spaces by keys (up to 250) | — | max items 250 |
| optional.scope.spaces.keys[] | string | No | — | — | — |
| optional.scope.spaces.labels | array | No | Filter spaces by labels (comma-separated in API request) | — | max items 250 |
| optional.scope.spaces.labels[] | string | No | — | — | — |
| optional.scope.spaces.status | enum | No | Filter spaces by status Allowed values: current, archived | — | — |
Examples
Reference payloads generated from shared source examples JSON.
Confluence pages for selected engineering spaces
Ingest Confluence Cloud pages for specific spaces with comments and attachments enabled
Schedule
{
"enabled": true,
"preset": "nightly",
"cron": "12 1 * * *",
"timezone": "UTC"
}Config Payload
{
"type": "CONFLUENCE",
"required": {
"base_url": "https://acme.atlassian.net",
"account_email": "platform-bot@acme.com"
},
"masked": {
"api_token": "your-atlassian-api-token"
},
"optional": {
"connection": {
"request_timeout_seconds": 30,
"max_retries": 3
},
"scope": {
"spaces": {
"keys": [
"ENG",
"PLATFORM"
],
"status": "current"
}
},
"content": {
"include_footer_comments": true,
"include_inline_comments": true,
"include_attachments": true,
"include_linked_file_assets": true,
"attachment_max_bytes": 5242880
}
},
"sampling": {
"strategy": "LATEST",
"limit": 100
}
}Confluence knowledge base full crawl
Scan all pages in current knowledge-base spaces and run broken-link checks
Schedule
{
"enabled": true,
"preset": "weekly",
"cron": "5 2 * * 0",
"timezone": "UTC"
}Config Payload
{
"type": "CONFLUENCE",
"required": {
"base_url": "https://acme.atlassian.net",
"account_email": "security-bot@acme.com"
},
"masked": {
"api_token": "your-atlassian-api-token"
},
"optional": {
"scope": {
"spaces": {
"type": "knowledge_base",
"status": "current"
}
},
"content": {
"include_footer_comments": true,
"include_inline_comments": false,
"include_attachments": true
}
},
"sampling": {
"strategy": "ALL"
},
"detectors": [
{
"type": "BROKEN_LINKS",
"enabled": true
}
]
}