> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cymph.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a sync

> Pick a source, choose what to mirror, set a schedule — then track it from the Sync Center.

Creating a sync takes two dialogs: pick the source, then choose what to mirror and how often. Nothing is scheduled until you confirm.

## Choose a source

1. Go to **Workspaces → your workspace → Sync Center**.
2. Click **Add Sync**.
3. Pick the integration to sync from. Filter the **Add New Sync** picker with the **All Integrations**, **Assets Source**, and **Playbook Source** pills, or search by name.

The picker lists one tile per product, not one per instance — which instance a sync reads from is chosen in the next step.

## Choose what to mirror

The second dialog is **Sync Assets** or **Sync Playbooks**, depending on what you picked. **Select Instance** comes first in both, then the fields below, then the schedule.

### Asset syncs

| Field | Required | What it does |
| - | - | - |
| **Select Instance** | Yes | The integration instance to read from |
| **Select Space** | Yes | Which resource types to mirror, grouped by family |
| **Import Scope** | No | Which subscriptions or regions to sweep — all of them unless you narrow it |

**Import Scope** only appears when at least one chosen resource type is read per subscription or per region. A sync covering only account-wide types — IAM roles, Entra ID users — has nothing to narrow, so the control is hidden.

Leaving **Import Scope** empty means every subscription or region, resolved fresh on each run, so one added later is picked up without editing the sync.

See [Assets](https://docs.cymph.io/synchronizer/assets.md) for what each source offers.

### Playbook syncs

| Field | Required | What it does |
| - | - | - |
| **Select Instance** | Yes | The integration instance to read from |
| **Projects** / **Repositories** | No | Which part of a SOAR library to mirror — all of it unless you narrow it |
| **Repository** / **Branch** / **Folder** | Varies by source | Where the documents live; folders are optional |
| **Organisation** / **Space** / **Site** | Varies by source | Which documentation space to mirror |
| **Automatic framework mappings** | No | Maps incoming playbooks to a framework version as they arrive |
| **Rewrite the documentation when the workflow changes** | No | SOAR sources only — off by default |
| **Rebuild the workflow when the document changes** | No | Documentation sources only — on by default |

Which selectors appear depends on the source: a SOAR source asks for one optional grouping, while a documentation source asks level by level — a GitHub sync wants a repository and branch before it can offer folders.

See [Playbooks](https://docs.cymph.io/synchronizer/playbooks.md) for what each source offers and what the two rewrite toggles do.

## Set the schedule

The fastest a sync can run is every five minutes. Presets cover the usual intervals from **Every 5 minutes** to **Every month**, and if none of them suits,with the **Custom…** option you can build the schedule you want.

**Set Timezone** defaults to your browser's and accepts any IANA zone.

Whichever you pick, Cymph states it back in words with the next firing: `Runs every day at 00:00` and `Next run: 31 Aug 00:00`.

## Start syncing

Click **Start Syncing**. The sync is created and its first run begins immediately, without waiting for the schedule.

## After it is running

The sync appears in the Sync Center table with its status. Use the **All Types**, **Playbooks**, and **Assets** filter to narrow a long list.

| Status | Meaning |
| - | - |
| **In sync** | The last run mirrored everything it covers |
| **Syncing…** | A run is in progress, with its `8/23` progress counter |
| **Waiting** | A run is queued behind another on the same sync |
| **Sync incomplete** | The run finished, but some records did not make it |
| **Sync failed** | The run could not proceed — hover for the reason |
| **Never synced** | Created, but no run has finished yet |
| **Pending sync** | Due to run |
| **Sync off** | The schedule is suspended |

**Sync incomplete** is worth separating from **Sync failed**: the source answered and the sync works, but individual records could not be mirrored. Open the history to see which.

The **⋯** menu on each row holds everything else:

| Action | What it does |
| - | - |
| **Sync now** | Runs immediately, without waiting for the schedule |
| **Cancel sync** | Stops a run in progress — shown only while one is running |
| **Edit Sync** | Changes what it covers, its frequency, or its timezone |
| **Turn off** / **Turn on** | Suspends or resumes the schedule |
| **Remove Sync** | Deletes the sync — what it already imported stays |

Only one run per sync happens at a time. Pressing **Sync now** while a run is in progress queues the next one behind it rather than running both.

> [!NOTE]
>
> A sync stays with the instance it was created for. **Edit Sync** can change everything else, but not which instance it reads from — to point at another instance, create a second sync.

The clock icon beside the menu opens **Sync History**: every run, who or what triggered it, and what changed — with each run expanding into the individual records it added, updated, or removed.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.