Overview
SpotDraft's public API is built for server-to-server integrations. The common pattern is that your own system remains the source of truth for the business process, while SpotDraft handles contract creation, later contract activity, and document-related flows exposed through the public API.
This portal is designed for:
- customer developers integrating their internal systems with SpotDraft
- teams evaluating native integrations and public API integration patterns
Use the public API when you need to:
- create contracts from structured business data
- sync external identifiers such as CRM, ERP, or procurement IDs into SpotDraft
- react to later contract activity through webhooks
- embed selected SpotDraft experiences in your own product
- retrieve signed documents or contract metadata back into your systems
How to use this portal
This portal is organized in four layers.
Getting Startedhelps you confirm access, choose environments, and make the first successful request.Platform Guidesexplain the SpotDraft CLM journey, data model, webhook model, and API operating rules.Integration Guidesshow how SpotDraft fits into CRM, ERP, repository, and warehouse patterns.API Playbooksshow realistic end-to-end implementation flows using the public API.
If you are new to the portal, the best path is:
- Access and Prerequisites
- Quickstart
- Authentication and Regions
- Platform 101
- Data Model
- Webhooks
- the integration guide or playbook that matches your pattern
Common integration patterns
Most teams fall into one or more of these patterns:
- create contracts from an internal workflow, then sync the final result back
- upload third-party paper and route it into review or signature
- subscribe to webhook events instead of polling contract status continuously
- retrieve contracts later by external metadata rather than by title
- import already executed contracts for repository visibility and reporting
What you should decide before building
Before writing code, lock down these decisions:
- which SpotDraft host, API version, and workspace your integration targets
- where credentials will be stored and rotated
- which upstream identifier will be written into
external_metadata - which webhook events your integration needs and where those deliveries will be processed
- what reconciliation job will repair missed downstream processing without becoming the primary integration path
- whether users will stay in your product or move into SpotDraft UI for some steps
Where to go next
- Use Access and Prerequisites to confirm the workspace is ready.
- Use Quickstart for the first successful request.
- Use Platform 101 for the object model and public API concepts.
- Use Authentication and Regions for host, path, and header rules.
- Use Webhooks if you expect asynchronous lifecycle events.
- Use Generate Contracts and Sync Data Back for the most common production integration pattern.