Connectors Confluence

Confluence

Text

The Confluence connector is a text connector that fetches pages from a Confluence space via the REST API and extracts claims from page content using db.ingest_text().

How it works

1 Get your Confluence credentials

You need three things: your Confluence instance base URL, your Atlassian account email (used as the username), and an API token.

2 Generate an API token

Go to id.atlassian.com/manage-profile/security/api-tokens and create a new API token. Copy the token value — you will not be able to see it again.

3 Install the requests package

$ pip install requests

4 Connect

In db.connect(), pass url for the base URL, token for the API token, and email for the username.

conn = db.connect("confluence",
    url="https://your-org.atlassian.net",
    token="ATATT3x...",
    space_key="ENG",
)
result = conn.run(db)
Parameter Required Default Description
base_url Yes Confluence instance URL (e.g. https://your-org.atlassian.net)
username Yes Atlassian account email
api_token Yes Atlassian API token
space_key No None Space key (e.g. ENG). If omitted, fetches all spaces.
max_pages No 100 Maximum pages to fetch
save No False Encrypt and persist credentials

Note: In db.connect(), pass url for base_url, token for api_token, and email for username.

Basic usage

conn = db.connect("confluence",
    url="https://your-org.atlassian.net",
    token="ATATT3x...",
    space_key="ENG",
)
result = conn.run(db)

With save and max_pages

conn = db.connect("confluence",
    url="https://your-org.atlassian.net",
    token=os.environ["CONFLUENCE_TOKEN"],
    space_key="ENG",
    max_pages=200,
    save=True,
)
result = conn.run(db)

All spaces

conn = db.connect("confluence",
    url="https://your-org.atlassian.net",
    token="ATATT3x...",
)
result = conn.run(db)

Related Connectors