Docs refactor — API reference layer landed
Documentation release. No API behavior changed.This release ships the first complete API reference layer for the Operata API. Nothing changed in the wire protocol, authentication scheme, or response shapes — only the documentation. Existing integrations keep working without modification.Endpoints now documented end to endContact endpoints (5):
- List contact summaries —
GET /v1/data/calls. - Get a contact record —
GET /v1/data/{contactId}. - List contact stats —
GET /v1/data/calls/{contactId}/details. - List CCP logs —
GET /v1/data/ccpLogs. - List users —
GET /v2/admin/users.
- Get redaction config —
GET /v1/config/REDACTION_CONFIG/json. - Update redaction config —
PUT /v1/config/json. - Delete redaction config —
DELETE /v1/config/REDACTION_CONFIG.
- Getting started — base URL, authentication header, and a first request.
- Errors — the Stripe-pattern error table mapping HTTP status to error
codeandtype, with the recommended client behavior for each row. - Pagination — cursor-based pagination, page size limits, and
next_cursorsemantics. - Rate limits — request quotas, the
X-RateLimit-*headers, and429retry guidance. - Idempotency — the
Idempotency-Keyheader, replay window, and supported methods. - Versioning — the
v2path prefix, the deprecation policy, and how breaking changes get announced.
- Webhooks overview — Operata delivers webhooks via Amazon EventBridge. The page covers the delivery model, the event envelope, and how to subscribe an EventBridge bus.
- Webhook events — the catalog of event types Operata emits, each with a sample payload.
- No new endpoints, no new fields, no removed fields, no changed response codes, no changed authentication. The API surface this release documents is the surface that has been live; this entry exists to anchor the changelog stream.