Schema Contracts
Overview
Schema Contracts let you define and publish a curated subset of your DealCloud data model: a named, scoped selection of objects and fields that both internal and external systems can reliably reference. This paradigm allows for controlled data exposure, thoughtful data mapping, and seamless interoperability of a site's data. Once published, a schema contract can be used by apps/systems (AI agents, API integrations, industry blueprints, 3rd party integrations, etc.) to speak a common language.
This matters because DealCloud's data model is fully customizable: every site defines its own objects and fields, meaning different sites may have different naming, structure, APINames, etc. That flexibility is a core strength of the platform, but it means external systems can't assume a common schema. A Schema Contract is the handshake that closes that gap, enabling a common language & awareness of the objects/data on a DealCloud site against what is necessary in its application.
Use Cases
- AI Agents & MCP Servers — Give AI Agents and MCP Servers a scoped, reliable selection of your DealCloud schema so it can reason over your data accurately with contextually relevant objects/fields.
- API Integrations — Provide third-party systems with a stable, mapped schema reference for reading from or writing to DealCloud.
- Schema Mapping — Map your site's objects and fields to a pre-defined contract, such as a partner-provided or industry-standard blueprint.
Setting Up a Schema Contract
Schema Contracts are found in the left navigation under Tools > Schema Contracts.
Create a New Contract
Click New Contract, give it a name and an optional description, then click Continue. Use a name that reflects the integration or application it's intended for.
Set Up the Contract
You'll see a list of all objects in your DealCloud instance. Check the object and fields you want to include. Clicking on an Object or Field will allow you to edit the Name and APIName. This is the magic of Schema Contracts, allowing you to thoughtfully expose, rename, and translate aspects of your site schema for a given application without needing to change the actual underlying site structure. You can also choose to add additional metadata using the Description and Internal Note fields.
When you're done selecting, click Save and Continue.
Review and Publish.
A review screen shows each selected object alongside all of its fields, with metadata like APINames, field types, and whether fields are required or read-only. This is what an external consumer will see.
When satisfied, click Save and Publish. The contract's status will update to Published and it's immediately available for use.