{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img","cards","card"]},"type":"markdown"},"seo":{"title":"Understanding the Synqly Model","siteUrl":"https://docs.synqly.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"understanding-the-synqly-model","__idx":0},"children":["Understanding the Synqly Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Synqly solves the operational complexity of building and maintaining integrations across many"," ","services while keeping a consistent, unified developer experience."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Instead of writing custom"," ","code for every provider, your application integrates ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["once"]}," with Synqly's unified APIs. Synqly handles translation, normalization, and provider-specific"," ","execution behind the scenes."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/synqly_data_flow.22cdbd2bedc6c26d6baa4a16ae25600e16d2587b71f945eabd505fc1a9634d08.5c9a700f.png","alt":"synqly data flow","withLightbox":false,"align":"center","style":{"marginTop":"15px","marginBottom":"15px"}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Internally, Synqly introduces organizational, integration, and security models that ensure tenant"," ","isolation, secure authentication, and scalable integration management. Those models are the real"," ","foundation of the platform and understanding them makes everything else click."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"platform-overview","__idx":1},"children":["Platform Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Synqly platform is built around three connected layers. Each exists to solve a distinct"," ","architectural problem."]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Organizational Model","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Who owns what."]}," Defines ownership, access control, and how customer data stays isolated"," ","across your entire deployment."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Integration Model","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How things connect."]}," Defines how external systems are wired up, configured, and made"," ","reusable across tenants."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Authentication Model","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How access is controlled."]}," Separates administrative authority from runtime execution"," ","using distinct token scopes."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"organizational-model","__idx":2},"children":["Organizational Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Who owns what."]}," Defines ownership, access control, and how customer data stays isolated across your entire deployment."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n org(Organization)\n mem(Members)\n ips(Integration Points)\n acc(Accounts)\n int(Integrations)\n eu(End Users)\n ten(Your Tenants)\n\n org --> mem & ips & acc\n acc --> int\n ten -.->|\"represented by\"| acc\n eu -.->|\"belong to\"| ten\n","diagramHtml":"

represented by

belong to

Organization

Members

Integration Points

Accounts

Integrations

End Users

Your Tenants

","diagramHtmlDark":"

represented by

belong to

Organization

Members

Integration Points

Accounts

Integrations

End Users

Your Tenants

"},"children":["flowchart TD\n org(Organization)\n mem(Members)\n ips(Integration Points)\n acc(Accounts)\n int(Integrations)\n eu(End Users)\n ten(Your Tenants)\n\n org --> mem & ips & acc\n acc --> int\n ten -.->|\"represented by\"| acc\n eu -.->|\"belong to\"| ten\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At the root of this model is the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization"]},", which owns the resources required to operate an integration ecosystem, including ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Members"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration Points"]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accounts"]},". Accounts typically represent your customers or tenants, providing isolated environments where integrations can be configured and managed independently."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Understanding the Organizational Model is essential for understanding how Synqly approaches multi-tenancy, security, and resource ownership."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following sections explore each concept in greater detail and explain how they work together to establish ownership boundaries."]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Organization","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/organization"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The root container that owns all Synqly resources and establishes the governance boundary."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Members","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/members"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Personal accounts and service accounts that act within an Organization."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Accounts","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/accounts"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Synqly's representation of your customers, providing strict data isolation between tenants."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"End Users","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/end-users"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The customers of your customers who authenticate providers or configure connections."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-model","__idx":3},"children":["Integration Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How things connect."]}," Defines how external systems are wired up, configured, and made reusable across your tenants."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n conn(Connector - Ticketing)\n ip(Integration Point)\n int(Integration)\n prov1(Provider - Jira)\n prov2(Provider - ServiceNow)\n prov3(Provider - Zendesk)\n conn -->|\"unified interface\"| ip\n ip -->|\"policy + config\"| int\n int --> prov1 & prov2 & prov3\n","diagramHtml":"

unified interface

policy + config

Connector - Ticketing

Integration Point

Integration

Provider - Jira

Provider - ServiceNow

Provider - Zendesk

","diagramHtmlDark":"

unified interface

policy + config

Connector - Ticketing

Integration Point

Integration

Provider - Jira

Provider - ServiceNow

Provider - Zendesk

"},"children":["flowchart LR\n conn(Connector - Ticketing)\n ip(Integration Point)\n int(Integration)\n prov1(Provider - Jira)\n prov2(Provider - ServiceNow)\n prov3(Provider - Zendesk)\n conn -->|\"unified interface\"| ip\n ip -->|\"policy + config\"| int\n int --> prov1 & prov2 & prov3\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["At a high level, the model separates:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["What your application integrates with (Connector)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["How that integration is governed (Integration Point)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Which provider is actually connected (Integration)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This separation allows applications to integrate against a stable, unified interface while retaining the flexibility to connect different providers for different customers or environments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following sections explain each component of the Integration Model in detail. Start with the concept you're interested in, or read them in order to understand how integrations are built from the unified interface down to the provider connection"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Connectors","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/connectors"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A unified API and data model abstracting a category of providers, such as Ticketing or Identity."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Integration Points","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/integration-points"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reusable governance rules defined once at the Organization level and applied across many Integrations."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Integrations","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/integrations"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The live, authorized connection between an Account and a specific Provider."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Providers","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/providers"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Specific third-party platforms — Jira, Okta, Slack, AWS — that Connectors expose."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication-model","__idx":4},"children":["Authentication Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["How access is controlled."]}," Separates administrative authority from runtime execution using distinct token scopes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Synqly exposes two distinct API layers, and each requires a different kind of credential."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Management APIs"]}," control how your integration system is structured — creating Accounts, configuring Integration Points, managing Members. The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connector APIs"]}," perform the actual work against external providers — fetching tickets, querying identity events, routing alerts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These two layers carry fundamentally different levels of authority, and Synqly enforces that separation by design."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Token"},"children":["Token"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API layer"},"children":["API layer"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Authority"},"children":["Authority"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization Access Token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Management APIs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Broad — operates across the entire Organization"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration Access Token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connector APIs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Narrow — scoped to a single Integration"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This separation is enforced at the platform level, not just by convention. A runtime Integration Access Token cannot perform administrative operations, and an Organization Access Token cannot call Connector APIs. Each token is strictly limited to the layer it was issued for. The result is least-privilege by default."]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Organization Access Tokens","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/organization-access-tokens"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Credentials for the Management APIs — used for administrative operations across an Organization."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Integration Access Tokens","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/guides/getting-started/concepts/integration-access-tokens"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Credentials for the Connector APIs — scoped to a single Integration for runtime provider access."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"putting-it-all-together","__idx":5},"children":["Putting It All Together"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The complete Synqly model, from organizational structure through to runtime execution:"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n org(Organization)\n mem(Members)\n ips(Integration Points)\n acc(Account)\n int(Integration)\n prov(Provider)\n\n org --> mem & ips & acc\n acc --> int --> prov\n","diagramHtml":"

Organization

Members

Integration Points

Account

Integration

Provider

","diagramHtmlDark":"

Organization

Members

Integration Points

Account

Integration

Provider

"},"children":["flowchart TD\n org(Organization)\n mem(Members)\n ips(Integration Points)\n acc(Account)\n int(Integration)\n prov(Provider)\n\n org --> mem & ips & acc\n acc --> int --> prov\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The typical integration lifecycle follows this sequence:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authenticate"]}," using an Organization Access Token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create"]}," an Account to represent a tenant in your system."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configure"]}," an Integration within that Account, referencing a Provider"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate"]}," an Integration Access Token scoped to that Integration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Call"]}," Connector APIs using the Integration Access Token to interact with the Provider"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n product(\"Your Product\")\n mgmt(\"Management APIs\")\n conn(\"Connector APIs\")\n accounts(\"Create Accounts & Integrations\")\n providers(\"Interact with Providers\")\n\n product -- \"Organization Access Token\" --> mgmt\n product -- \"Integration Access Token\" --> conn\n mgmt --> accounts\n conn --> providers\n","diagramHtml":"

Organization Access Token

Integration Access Token

Your Product

Management APIs

Connector APIs

Create Accounts & Integrations

Interact with Providers

","diagramHtmlDark":"

Organization Access Token

Integration Access Token

Your Product

Management APIs

Connector APIs

Create Accounts & Integrations

Interact with Providers

"},"children":["flowchart TD\n product(\"Your Product\")\n mgmt(\"Management APIs\")\n conn(\"Connector APIs\")\n accounts(\"Create Accounts & Integrations\")\n providers(\"Interact with Providers\")\n\n product -- \"Organization Access Token\" --> mgmt\n product -- \"Integration Access Token\" --> conn\n mgmt --> accounts\n conn --> providers\n"]}]},"headings":[{"value":"Understanding the Synqly Model","id":"understanding-the-synqly-model","depth":1},{"value":"Platform Overview","id":"platform-overview","depth":2},{"value":"Organizational Model","id":"organizational-model","depth":2},{"value":"Integration Model","id":"integration-model","depth":2},{"value":"Authentication Model","id":"authentication-model","depth":2},{"value":"Putting It All Together","id":"putting-it-all-together","depth":2}],"frontmatter":{"slug":"guides/getting-started/concepts","seo":{"title":"Understanding the Synqly Model"}},"lastModified":"2026-06-11T11:53:23.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/getting-started/concepts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}