Skip to main content

​
What Cymph uses it for

Cymph connects to Confluence for two purposes:
  1. Importing content — reads pages and spaces, so existing documentation can be brought into Cymph. (read)
  2. Publishing documentation — creates a new Confluence page from a playbook’s documentation. (write) See Deploy playbooks.
A single token can serve either or both purposes. If you only import, Cymph needs read scopes; publishing requires an additional write scope — see Permissions below.
Confluence and JIRA are separate integration types but share the same Atlassian API token mechanism. The token must be created for the right app and carry the scopes listed below.

​
Requirements

​
Token setup

Follow the instructions provided here to generate a token.

​
Permissions

​
To import content

Or, if you are using classic scopes:

​
To also publish documentation

Add the following scope:
Or, with classic scopes:
An Atlassian API token inherits the permissions of the user it belongs to, so the account must have access to the spaces you want Cymph to read — and, for publishing, permission to add pages to the target space.
Use a dedicated Atlassian service account rather than a personal one — pages created by Cymph will be attributed to whichever account owns the token.

​
What Cymph reads and writes

Cymph reads spaces and page content, and creates pages when you publish documentation. Pages are created with status current (published, not draft) in the space you select, using Confluence’s storage format — Cymph converts the playbook’s documentation blocks to Markdown and then to storage HTML. Cymph returns the new page’s URL, which becomes the “navigate to the pushed playbook” link in Deploy History.
Cymph never updates or deletes existing pages — each publish creates a new page. Publishing the same playbook twice produces two pages, and Confluence rejects the second if the title collides within the space.

​
Publishing formats

Confluence accepts Markdown documentation only. PDF publishing is not supported — Confluence pages have no native PDF type, and Cymph will reject the attempt with “PDF push is not supported for Confluence”. Image blocks are omitted.

​
Testing the connection