Skip to content

Changelog

Notable changes to the Noticia public API. Backward-compatible changes (new endpoints, fields or error codes) ship within /v1. Breaking changes go to a new version with an overlap period.

The format follows Keep a Changelog.

  • Initial public API v1: Profiles, Subscriptions, Stores and Sales Events.
  • Organization-scoped API key authentication on the x-api-key header.
  • Unified error envelope with stable, machine-readable code values.
  • Cursor-based pagination on list endpoints (limit, cursor).
  • Upsert semantics keyed on external_id, with an optional Idempotency-Key header on writes for transport retries.
  • Public OpenAPI document at GET /v1/openapi.json and this documentation site.
  • Outbound webhooks (signed delivery, retries, redelivery dashboard).