Skip to main content
Confluence integrations pull pages and spaces into your workspace so they can be used as artifacts. You must enable Confluence at the instance level first—see the operator guide: Confluence integration setup. If the integration needs OAuth, use the login endpoints in OpenID & OAuth.

​
Basic request and response

Fetch integration configuration with GET /api/v1/app/integration/confluence/{integrationId}/config. 
curl "https://{BASE_URL}/api/v1/app/integration/confluence/{integrationID}/config" \
  -H "Authorization: Bearer {API_TOKEN}"

{
  "space_key": "SUP",
  "base_url": "https://confluence.auroralabs.com"
}

​
Start an ingest sync

curl -X POST "https://{BASE_URL}/api/v1/app/integration/confluence/{integrationID}/ingest" \
  -H "Authorization: Bearer {API_TOKEN}"

{
  "type": "sync_started",
  "current_artifact_count": 42,
  "integration_item_count": 120
}

​
Errors and edge cases

  • 403: integration not enabled or missing permissions.
  • 404: integration ID not found.