API Overview
Sozo CRM integrations are built around authenticated requests and role-safe access to sales, pipeline, and payout data.Authentication
Every request is tied to an authenticated user context.
Role-Safe Access
Permissions are enforced based on admin, manager, and rep roles.
Event-Driven Automations
Trigger downstream actions from stage and deal lifecycle changes.
Reliable Payloads
Use stable identifiers and avoid brittle name-based matching.
Authentication pattern
Use a signed user token when calling protected endpoints.cURL example
Core data domains
Deals
Deals
Pipeline lifecycle, customer records, and operational status for each opportunity.
Reps and Teams
Reps and Teams
Identity, team mapping, role, and visibility scope for sales users.
Commissions
Commissions
Split logic, payout state, and dispute-safe earnings records.
Notifications and Events
Notifications and Events
System events used for alerts, automation triggers, and manager oversight.
Integration best practices
Use immutable identifiers
Use immutable identifiers
Store and pass record IDs rather than matching by names or free-form text.
Design for retries
Design for retries
Network calls and webhooks can repeat. Make create/update operations idempotent.
Validate at boundaries
Validate at boundaries
Validate inbound payloads before write operations to prevent partial failures.
Batch where possible
Batch where possible
Group related writes to keep state consistent and reduce edge-case drift.
Typical error categories
error
The authenticated user does not have access for the requested action.
error
The record or collection path could not be resolved.
error
A required field is missing or a payload type is incorrect.
error
The operation timed out; retry with backoff and observability.
Next steps
Quickstart
Set up production-ready workflows before connecting external systems.
Integrations
Review integration patterns and rollout guidance.
Hosted MCP
Connect AI clients to your docs and implementation context.