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
Notifications, AI provider (BYOM), and Smart Hub settings.
BYOM Setup
Connect OpenAI, Anthropic, or Google Gemini (via Regular API or Vertex AI) keys to use your own models for documentation generation.
Smart Hub & Features
Learn about Related Issue scanning, creating docs from tickets, and bulk actions.
Connect Confluence
After installing Sync-o, connect your Confluence instance to enable documentation updates.
Troubleshooting
Solutions for common issues: missing updates and common errors.
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
- Connect Confluence: In Manage apps, click Sync-o → Connections tab, then click Connect next to Confluence
Important: Sync-o auto-connects to Jira during install, but Confluence must be connected manually. Without this step, Sync-o cannot update your docs. See the full guide →
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 to the updated page), and on the Confluence page via a short audit comment.
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 and publishes the update immediately.
If you want page creation enabled for your workspace, email [email protected].
Core Concepts
Understand how Sync-o thinks, how it differs from ChatGPT, and what the Smart Hub does.
The Smart Hub is your mission control inside every Jira ticket. It gives you instant Traffic Light status on documentation health (Red=Outdated, Green=Verified), scans for related docs in parent/linked issues, and lets you generate new specs with one click.
ChatGPT requires manual copying, prompting, and formatting. Sync-o is an agent that integrates directly with Jira & Confluence. It automatically finds the right page, understands the context, and applies the update with zero friction.
Sync-o always reads the latest version of the Confluence page before making any changes. If a human has manually updated the page, Sync-o sees those changes as the new "source of truth" and will only append or modify based on the new context from the Jira ticket.
Billing & Subscription
Understand what a Sync is, how billing works, and where subscription is managed.
A Sync is one successful update operation to a Confluence page or section.
This metric is tracked for your Usage Analytics dashboard, but since our plans are unlimited, it does not affect your billing.
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 [email protected].
Atlassian's pricing model for Marketplace apps is straightforward: apps are billed based on the total number of users in your Atlassian license (e.g., Jira or Confluence).
We do not control this policy—it is a mandatory requirement for all apps on the Atlassian Marketplace.
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 [email protected].
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 [email protected].
The Standard plan works with both Team-managed and Company-managed projects.
However, the Advanced plan features are exclusively available for Company-managed projects due to Atlassian API capabilities.
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 Google Gemini via Regular API or Vertex AI) 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 Google 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.
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 Confluence page
- 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
- 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.
- Update skipped: The update may have been skipped because the AI determined the ticket content wasn’t relevant to that Confluence page. Check the Jira ticket comments for details.
- License expired: Confirm your Atlassian Marketplace subscription is active for the site/workspace where Sync-o is installed.
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 [email protected] with the ticket key and the Confluence page URL.
Start with the Jira ticket comments—they’re the fastest way to see what Sync-o attempted (target page and whether it published the update or skipped it).
If you need deeper troubleshooting, your Jira admin can help collect context, or you can reach us at [email protected].
Email [email protected] 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