Documentation
Help-center style answers for installing Sync-o, linking Jira tickets to Confluence pages, tuning AI + safety controls, billing basics, and troubleshooting.
Type to filter questions across all sections.
Guides & Resources
Configuration Guide
Master confidence thresholds, auto-publishing rules, and notification noise control.
BYOM Setup
Connect OpenAI or Anthropic keys to use your own models for documentation generation.
Smart Hub & Features
Learn about Related Issue scanning, creating docs from tickets, and bulk actions.
Troubleshooting
Solutions for common issues: missing updates, permission errors, and Draft mode.
Getting Started
Install Sync-o, link your first Confluence page, and understand when updates run.
- Open Atlassian Marketplace (in Jira/Confluence: Apps → Explore apps)
- Search for Sync-o and click Install
- Approve the requested permissions
- Open Apps → Manage apps and finish setup in Sync-o settings
Tip: If you don’t see the Apps menu, you likely need an Atlassian admin to install and configure Sync-o.
Sync-o uses the Confluence URL on your Jira issue to know what page should be updated.
- Copy the URL of the Confluence page you want updated
- Paste it into the Jira ticket (link field, description, or a comment)
- Make sure Sync-o has access to that Confluence space/page
Sync-o detects Confluence URLs from: the official Jira–Confluence link, URLs in the ticket description, and URLs in ticket comments.
Sync-o typically runs when Jira issues are completed (for example, when they’re moved to Done), based on your automation settings.
You’ll see what happened in the Jira ticket comments (link + confidence score), and on the Confluence page via a short audit comment or a saved draft.
On select plans, Sync-o can create a new Confluence page when relevant documentation doesn’t exist yet. Otherwise, it updates the page you linked on the Jira ticket (or saves a draft depending on confidence).
If you want page creation enabled for your workspace, email support@sync-o.io.
Billing & Subscription
Understand what a Sync is, how drafts are counted, and where billing is managed.
A Sync is one successful update operation to a Confluence page or section.
If Sync-o drafts an update and you choose to discard it, you aren’t charged for that attempt.
Drafts are designed for safe review. If Sync-o drafts an update and you discard it, that draft doesn’t count as a billable Sync.
If you’re unsure how something will be counted in your environment, send the ticket key to support@sync-o.io.
Sync-o billing is managed through the Atlassian Marketplace. Your site admin can upgrade/downgrade, renew, and view invoices from Atlassian’s billing and app management screens.
Most customers start with an Atlassian Marketplace trial. Trial availability depends on the listing and your Atlassian plan.
If you don’t see a trial option, reach out at support@sync-o.io.
Security & Compliance
What Sync-o can access, what it can’t, and how data is protected.
Sync-o needs permissions to read context and write back the result:
- Jira: Read/write access to issues, comments, and project settings
- Confluence: Read/write access to pages and comments
- App storage: Configuration storage for your settings
If a page is restricted, Sync-o can’t update it unless the app has access to that space/page.
No. Sync-o does not connect to GitHub/GitLab/Bitbucket. It only reads the text within your linked Jira tickets and Confluence pages.
This keeps Sync-o more secure and easier to adopt, because it operates on requirements and documentation—not source code.
No. Sync-o does not use your data to train our own AI models.
If you use BYOM, your third‑party AI provider’s policies apply—review your provider’s terms and DPAs for your compliance requirements.
- Encrypted in transit (TLS)
- Encrypted at rest (including API keys via AWS KMS)
- No secrets in logs: API keys are never written to logs or posted in comments
For more details, see the Trust Center and Privacy Policy.
Integrations & Compatibility
What Sync-o supports today and how to think about fit.
Sync-o is currently optimized for Jira Cloud and Confluence Cloud. Support for Data Center (on‑prem) is on our roadmap.
For enterprise requirements, email support@sync-o.io.
Yes. Because Sync-o analyzes the requirements in Jira rather than raw code, it works for any stack—Java, Python, Rust, or even no‑code tools.
Yes—Sync-o can operate across the Jira projects and Confluence spaces where it’s installed and has permission.
If you want to limit scope, use standard Jira/Confluence permissions and page restrictions to control where Sync-o can write.
Today, Sync-o focuses on doing one thing extremely well: keeping Confluence docs in sync with Jira.
If you need additional integrations, tell us what you’re trying to automate at support@sync-o.io.
AI Configuration (BYOM)
Connect your own AI provider and understand how keys and fallback behave.
Bring Your Own Model (BYOM) lets your team connect your own AI provider (OpenAI, Anthropic, or Gemini) so Sync-o can generate documentation updates using your preferred model and your billing account.
This is especially useful when you have procurement requirements, want tighter cost controls, or need consistency with the models your organization already uses.
- Go to Sync-o Settings → AI Configuration
- Select your provider (OpenAI, Anthropic, or Gemini)
- Enter your API key
- Click Test Key to verify
- Save Settings
Tip: Use a dedicated key (or service account) so you can rotate credentials and track usage cleanly.
Yes. Sync-o treats API keys like production credentials:
- Encrypted at rest using AWS KMS (AES-256)
- Decrypted only when needed to process a request (not kept in plaintext storage)
- Never written to logs or included in ticket/page comments
If you ever need to rotate a key, you can update it in settings at any time.
If your provider returns an error (for example, an invalid key, rate limit, quota issue, or a temporary outage), Sync-o automatically falls back to the default Gemini model so work can continue.
The same safety controls still apply (confidence thresholds, draft vs publish), so you stay in control of what goes live.
Confidence Thresholds
Control what gets auto-published, saved as a draft, or skipped.
Sync-o assigns a confidence score (0–100%) to every proposed update. The score reflects how strongly the Jira ticket’s content (description, acceptance criteria, comments, and linked context) matches the target Confluence page’s topic and structure.
Think of it as a safety gauge: higher scores mean Sync-o is more certain the change belongs on that page, and lower scores help prevent irrelevant or noisy updates.
High Confidence (>90%): Sync-o auto-publishes the update immediately.
Medium Confidence (70–90%): Sync-o saves a draft so a human can review and publish.
Low Confidence (<70%): Sync-o takes no action to reduce noise and avoid off-topic edits.
Yes. In Sync-o Settings → Automation, you can tune thresholds to match your team’s risk tolerance.
- If you want maximum control, set Auto‑Publish to 100% so everything becomes a draft first.
- If your docs are mature and updates are predictable, you can lower the threshold to publish more automatically.
Notifications
Tune the audit trail so your team gets visibility without spam.
Sync-o leaves a lightweight audit trail so people can understand what changed and why:
- Confluence page comments: a clear summary of what was updated (and what section was affected)
- Jira ticket comments: links to the updated page or saved draft, including the confidence score used
- Optional @mentions: notify the reporter, assignee, or page owner when you want a human to review
Yes. In Settings → Notifications, you can toggle what Sync-o posts so you get visibility without spam:
- Confluence page comments
- Jira comments for published updates
- Jira comments for draft updates
- Optional @mentions for the reporter/assignee
Troubleshooting
Common problems and the fastest ways to diagnose them.
View Full Troubleshooting Guide
Common causes:
- No Confluence link: Ensure the Jira ticket includes a Confluence URL (in a link field, description, or comment) and that Sync-o has access to that space/page.
- Low confidence score: Sync-o may decide the ticket isn’t a strong match for that page, so it won’t publish (or may save a draft depending on your thresholds).
- License expired: Confirm your Atlassian Marketplace subscription is active for the site/workspace where Sync-o is installed.
- Draft status: The update may have been saved as a draft for review rather than published—check for drafts and recent page comments.
Low confidence is usually a signal that Sync-o doesn’t have enough context or the linked page is too broad.
- Link the most specific page (ideally the exact doc that should change, not a general overview)
- Add context to the ticket: acceptance criteria, screenshots, expected behavior, and edge cases
- Keep tickets + docs aligned: consistent headings and terminology improves matching over time
It’s normal for scores to start lower—once your docs have stable structure and the right links, they tend to improve.
Most permission issues come from page restrictions or missing app access.
- Confluence restrictions: Check if the page or space is restricted to specific users/groups.
- App permissions: Confirm the Sync-o app has the required Jira/Confluence scopes.
- Site context: Make sure Sync-o is installed on the same Atlassian site where the project/space lives.
If you’re stuck, email support@sync-o.io with the ticket key and the Confluence page URL.
Start in the Jira ticket comments—they’ll link you to either the published Confluence page or the saved draft, along with the confidence score used.
If you can’t find the draft link, check the Confluence page’s recent comments and history, or email support@sync-o.io.
Start with the Jira ticket comments—they’re the fastest way to see what Sync-o attempted (target page, confidence score, and whether it published, drafted, or skipped).
If you need deeper troubleshooting, your Jira admin can help collect context, or you can reach us at support@sync-o.io.
Email support@sync-o.io with:
- Your Atlassian site URL
- The Jira ticket key
- A brief description of the issue
- What you expected to happen vs what happened
- Approximate timestamp (and your timezone), plus screenshots if available