Build on a customer intelligence layer with a clean, documented API.
Send events, resolve identity, read unified profiles, and react with webhooks. Compass gives developers a validated event pipeline and an SDK to build on top of it.
Start here
The foundations every integration needs — how to authenticate and how to send well-formed events.
API overview
A tour of the Compass API surface — resources, conventions, and how the pieces fit together.
Authentication
Authenticate with scoped API keys and learn how credentials map to tenants and capabilities.
Event envelope
The common envelope every event shares — structure, required fields, and how to send events reliably.
Schema registry
Register and version the schemas your events validate against, so ingestion stays consistent.
The data you read and write
Identity, customers, and attributes are the resources; commerce, consent, and engagement are the event types that keep them current.
Identity
Resolve and manage identifiers so events land on the right unified profile.
Customers
Read and manage customer profiles built from your connected sources.
Attributes
Define and populate extensible attributes, including declared data from surveys.
Commerce events
Send orders, products, and spend as structured commerce facts.
Consent events
Record consent changes with provenance so suppression stays accurate.
Engagement events
Capture opens, clicks, and other engagement signals onto the timeline.
Go beyond ingestion
React to what happens in Compass and integrate faster with the SDK and sample applications.
Webhooks
Subscribe to platform events and react in your own systems in near real time.
Client SDK
An SDK that wraps authentication, the event envelope, and common calls so you can integrate quickly.
Sample applications
Reference apps that show end-to-end patterns for ingesting events and reading profiles.
Full references live in the docs
Every topic above is documented in depth, with request and response shapes, field definitions, and error handling.
Ready to connect your systems to Compass?
Start with the API overview, or talk to us about your integration and what you are building.