Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Changelog

Event schema

The delivered event payload carries a schema_version. It is bumped only on a breaking change to the payload; additive, backward-compatible fields do not bump it.

schema_versionStatusNotes
2Currentrating.dropped is delta-only; the absolute-threshold rule (and its trigger field) was removed. Everything today ships under 2, including the pattern family (rating.trend, feature.demand_surged, issue.surging and their riders).
1HistoricalThe original envelope: review.created and rating.dropped (delta + threshold rules), store-agnostic payload, HMAC-SHA256 signatures.

Additive, backward-compatible fields never bump the version: the optional enrichment object on review.created and the country field on rating.dropped both arrived without a bump. Write your consumer defensively: ignore unknown fields, treat enrichment as optional (it may be null), and key your idempotency on event_id.

Events

The pattern family is live and documented, the paid layer on top of the free review.created and rating.dropped:

  • rating.trend: a gradual, smoothed rating decline (the gentle companion to rating.dropped).
  • feature.demand_surged and issue.surging: the subscribable heads of the demand- and issue-surge lifecycles, each delivering their edge-triggered riders (recurred / intensified / sustained / subsided, plus issue.version_regressed) to the same hook.

See Events & delivery for the full catalog and the paid/free line.

API

The REST Hook API lives under /api/v1. The authoritative, versioned contract is the OpenAPI reference, generated from the code.

Coming

  • Make and n8n integration guides (the API already supports them via source).
  • A public roadmap.