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
1Currentreview.created and rating.dropped, the store-agnostic envelope, HMAC-SHA256 signatures.

Write your consumer defensively: ignore unknown fields, and key your idempotency on event_id.

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).
  • Additional events and a public roadmap.