Skip to main content
This page outlines planned, backward-compatible enhancements to the API and runtime. It reflects proposed work — existing endpoints continue to behave as documented elsewhere. Structured errors (with codes)
  • Current: { "error": string }
  • Planned: { code: string, message: string, details?: object }
  • Rationale: machine-parseable errors, better client handling
  • Example codes: invalid_key, missing_scope, rate_limited, tenant_paused, validation_error
  • Status: Implemented
Rate limit headers
  • Current: Retry-After on 429
  • Planned: add X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
  • Rationale: clearer client behavior and backoff hints
  • Status: Implemented
Idempotency response headers
  • Current: Idempotency accepted via header/body
  • Planned: echo Idempotency-Key and add Idempotency-Replayed: true on reused results
  • Rationale: observability and correctness during retries
  • Status: Implemented
Request IDs
  • Planned: include X-Request-Id in responses; accept inbound X-Request-Id
  • Rationale: end-to-end correlation and supportability
  • Status: Implemented
OpenAPI + SDKs
  • Planned: publish OpenAPI spec and lightweight SDKs (TS/JS, Python), and reference snippets in docs
  • Rationale: reduce friction and drift; enable codegen
  • Status: Proposed
Pagination (future list endpoints)
  • Planned: limit + cursor{ items, nextCursor? }
  • Rationale: scalable list patterns and consistent client code
  • Status: Proposed
Sending pipeline improvements
  • Planned: improve internal sending path and event routing
  • Rationale: better tagging and correlation for timelines
  • Status: Proposed
Webhook Inspector
  • Planned: UI for inbound deliveries, headers/body, response, replay; idempotent replays
  • Rationale: faster debugging and safer operations
  • Status: Proposed
Warm-up planner & bulk readiness
  • Planned: per-day caps per org; readiness checks (SPF/DKIM/DMARC/BIMI) surfaced in UI; enforced for bulk
  • Rationale: safer scaling and compliance guardrails
  • Status: Proposed
Security upgrades
  • Planned: token rotation endpoints, optional TTL on unsubscribe tokens
  • Rationale: hygiene and incident response
  • Status: Proposed
Note: timelines and scope may evolve; see Versioning for policies. These changes will be announced before rollout and designed to avoid breaking clients.