Cinchy Platform Documentation

website·Indexed 34 days ago

https://docs.cinchy.com/

Documentation for the Cinchy data collaboration platform, including release notes from version 5.2 through 5.20, API guides, and detailed upgrade instructions for IIS and Kubernetes environments (including AWS EKS and Azure AKS).

Tokens
256.9K
Snippets
852
Records
2.1K
Agent score
49%

What's inside Cinchy

  1. Overview of the Cinchy MCP Server

    The Cinchy MCP Server enables AI assistants (such as Claude) to interact directly with the Cinchy data platform. It allows users to perform operations including querying tables, modifying data, troubleshooting syncs, and creating schemas, while ensuring all actions are performed under the user's specific identity and entitlements.
  2. Overview of the Cinchy Observability Dashboard

    The Observability Dashboard provides a centralized view of sync health across a Cinchy environment. It surfaces health scores, failure patterns, execution trends, and real-time listener metrics to allow for quick issue identification without manual log parsing. The dashboard does not compute scores live; instead, it reads the most recent snapshot generated during a scheduled maintenance pass.
  3. Overview of Cinchy Webhook Ingestion

    Cinchy allows users to subscribe to and ingest webhooks from external applications via a unique API endpoint. When an external application triggers the endpoint, Cinchy executes a pre-identified saved query under an authorized user account to insert or update data into a Cinchy table. This feature is compatible with Cinchy v4.21+.
  4. Overview of Cinchy Event Broker/CDC Source

    The Cinchy Event Broker/CDC (Change Data Capture) source captures data changes (additions, updates, or deletions) on a Cinchy table and uses these events to trigger data syncs. It supports both batch syncs and real-time syncs, though real-time is the most common use case. To implement a real-time sync, change notifications must be enabled on the Cinchy table and a listener configuration must be set up.
  5. Overview of Cinchy Data Collaboration

    Cinchy's Data Collaboration Platform is designed to eliminate data silos and the 'integration tax'—the recurring cost and complexity of building bespoke ETL processes or APIs to move data between fragmented applications. Instead of copy-based integration, Cinchy uses a federated, access-based real-time approach called 'Data Co-Production.' This allows multiple stakeholders to co-produce and maintain data in a controlled environment, reducing the need for redundant integrations and accelerating IT delivery.
  6. Overview of OpenSearch Dashboards for Cinchy v5

    For Cinchy v5 deployments on Kubernetes, OpenSearch Dashboards is the recommended tool for logging. It captures and indexes logs into a single dashboard location where they can be queried, searched, and filtered. Logs include Correlation IDs, allowing them to be traced across various system components. The logging components utilize persistent storage.
  7. Overview of SOAP 1.2 Web Service destination

    The SOAP 1.2 Web Service destination allows applications to communicate across different operating systems and languages using an XML-based protocol over HTTP. It can be used to create, retrieve, update, or delete records (such as accounts, leads, and custom objects) from a server. This destination supports both batch and real-time synchronization.
  8. Overview of the Cinchy Network Map

    The Network Map is a system applet in Cinchy that provides a visualization of platform data and interconnections. In this map, each node represents a table the user has access to, and each edge represents a link between two tables. Node size is determined by the number of links referencing that table. The map includes a timeline to view the network's evolution over time and respects user entitlements for viewable tables and linked columns. The Network Map experience is located on the Homepage.
  9. Overview of Cinchy Query data sync sources

    Cinchy queries are data sync sources that utilize the platform's Saved Query functionality. They are typically used to poll for specific data (e.g., unapproved timesheets) and sync that data to a destination, such as a Cinchy Table.