Platform 101

Use this page as a technical orientation before reading endpoint-specific docs. It explains how SpotDraft fits into a contract lifecycle management integration and where the public API usually participates.

The CLM journey

SpotDraft manages the contract lifecycle across three broad phases:

Phase	What happens in SpotDraft	Typical integration role
Create	A contract is generated from a template, uploaded as third-party paper, or imported as an executed agreement.	Send source-system identifiers, contract data, counterparties, signatories, and intake answers.
Manage	The contract moves through review, redlining, approvals, signature setup, signing, execution, hold, or void paths.	Listen for lifecycle webhooks and fetch fresh state only when downstream systems need detail.
Store and sync	The repository stores the contract record, structured metadata, versions, and final documents.	Sync executed documents, status, metadata, and analytics-ready identifiers back to downstream systems.

Integration scope

Most API integrations should treat SpotDraft as the CLM system of record and the upstream business system as the source of commercial context. The integration writes enough structured data into SpotDraft to create and manage the contract, then reacts to webhooks and fetches downstream data when the contract changes.

Public API capability areas

The public API is organized around a few practical capability areas.

Create and import contracts

• create and list contracts
• retrieve contract status
• create contracts from templates
• upload contracts for review or signature
• create executed contracts
• send a contract to counterparties or signature where supported

Manage structured contract data

• write contract_data during template-driven creation
• read and update external metadata
• retrieve intake-form responses
• retrieve questionnaire responses
• read or update key pointers
• retrieve notes, recipients, versions, content, and related contract state

Configuration and reference data

• list templates
• list contract types
• retrieve contract-type intake forms, entities, and access control
• list users and roles needed for invitation or assignment flows

Webhooks and downstream sync

• create or delete public webhooks
• fetch the webhook HMAC key
• re-trigger latest webhooks for repair flows where available
• process lifecycle events in your own webhook receiver

SpotDraft does not provide product-side API or webhook logs in the developer portal. Your integration should log outbound API requests, inbound webhook deliveries, signature verification results, queue jobs, retries, and downstream processing outcomes.

Technical operating model

The code supports a common operating pattern:

• your system creates or updates contract work synchronously
• SpotDraft continues processing after the request returns
• later activity is surfaced through webhooks
• your system fetches fresh contract data only when it needs more detail

That is why webhook handling is part of the core integration model, not an optional extra.

What should be stable in your integration

Treat these as integration contracts you own:

• the regional base URL and workspace environment
• the upstream id stored in external_metadata
• the mapping from source-system fields into contract data, intake responses, or metadata
• the webhook event types you subscribe to
• the idempotency key or dedupe strategy for webhook processing
• the downstream sync rules for documents, metadata, and status

What should be validated per workspace

These depend on workspace configuration and should be checked in UAT and production separately:

• contract types
• templates
• questionnaire and intake-form fields
• creator entities
• counterparty setup
• user, role, and approval routing
• signing provider and signing order behavior
• webhook endpoint registration

How to use this orientation

Once the terminology and architecture are clear:

1. Use Access and Prerequisites to confirm the workspace is ready.
2. Use Quickstart to make the first authenticated request.
3. Use Object Glossary to align teams on product and API terminology.
4. Use Data Model to understand contracts, metadata, and downstream sync data.
5. Use Webhooks for asynchronous delivery design.
6. Use the relevant integration guide or API playbook for a concrete implementation path.