Cadres IT Operations & Infrastructure
Products Architecture Docs Blog
Sheet SYN-04 Rev 2026.08
Start Trial

Sheet SYN-04 · Network Operations Manual

Integrations & the Plugin Bridge

Connecting vendor platforms: the add wizard, credentials, sync cadence, and sync run detail.

Audience: Administrators connecting vendor platforms Focus: Vendor onboarding and sync

Scope

An integration connects one vendor platform account to Synapse. This guide covers adding an integration, handling its credentials, setting its sync cadence, and reading sync runs.

The plugin bridge

Each vendor plugin declares what it can do and which credentials it needs. The add wizard builds itself from that declaration, so a newly registered plugin appears in the wizard with no other change. Current examples: Cisco Meraki (inventory, wireless, and health), Fortinet (inventory), and Palo Alto Strata (inventory). Other plugins can be added.

Adding an integration

The add wizard has four steps:

  1. Pick a vendor. The wizard lists every registered plugin and its capabilities.
  2. Enter credentials. The form comes from the plugin’s credential schema. Secret fields are password inputs and are not shown again after you save. A typical plugin asks for an API key, plus an optional vendor organization or base URL.
  3. Pick the owning organization and a name. This is the Synapse organization, not the vendor’s.
  4. Set the sync cadence. The default is every eight hours. The minimum is five minutes.

Synapse encrypts credentials at rest and never returns them. You cannot view or edit a stored credential. To change one, replace it.

If the tenant’s plan does not include that vendor’s plan family, the wizard disables creation and shows an upgrade hint.

Testing and syncing

  • Test checks the stored credentials and changes nothing.
  • Sync now runs a full sync immediately and shows the resulting run.
  • Scheduled sync runs on the configured cadence.

Each sync run has ordered steps. Each step records its phase, status, and any error. The run ends as success, partial, or failed. When an integration degrades, start with the run detail.

Other rules

  • Creating an integration and running a sync are both audited.
  • The integrations list shows each integration’s health and last sync status, with test and sync buttons on each row.
  • Even read access to integration management is restricted. Managing vendor connections is an administrative task.