Skip to main content
WEBHOOK

Headers

webhook-id
string
required
Minimum string length: 1
webhook-timestamp
string
required
Minimum string length: 1
webhook-signature
string
required
Minimum string length: 1

Body

application/json

Immutable reference-only notification. Retries preserve event_id and the exact stored body bytes; signing timestamp changes per attempt. No document content, excerpt, explanation, cursor or secret is embedded.

event_id
string
required
Pattern: ^[A-Za-z0-9_-]+$
type
enum<string>
required
Available options:
match.created,
match.corrected,
match.no_longer_matches,
match.withdrawn
schema_version
enum<string>
required
Available options:
1
occurred_at
string<date-time>
required
references
object
required

owner is the Subscription Owner, so a client routes the notice to its user; absent for a global Subscription and in notices committed before owners existed. match_id is the new Match for created/corrected, prior positive Match for no_longer_matches/withdrawn. record_version_id is the causal correction version for corrected/no_longer_matches, otherwise the matched version. References alone confer no access.

Response

Receiver durably accepted/deduplicated this event.