Design webhook schema migration for independently deployed receivers
A required payload change cannot be safely deployed to all partner receivers at once.
- Focused work estimate
- 5h + prerequisites
- Priority in the scenario
- High
- Engineering practice
- API lifecycle · Compatibility
Estimated field mix
- API design60%
- System design40%
Field percentages are editorial estimates of the ticket's engineering focus. They total 100%; they are not measured time, proficiency scores, or ownership evidence.
Review it, then add it to your workspace.
The board opens an editable draft; nothing is saved until you confirm it. Sign-in and workspace permissions apply, and Demo boards remain ephemeral.
Project context
A fictional logistics platform sends shipment events to partner endpoints. Partners need stable schemas and recovery semantics despite duplicate delivery, failures, and subscription changes.
Setup prerequisites
- Create a local webhook sender and receiver doubles with synthetic shipment events and disposable signing keys.
Preceding work
Complete these dependencies, or supply their agreed outputs before taking this ticket.
- BAPIHOOK-101 · Define immutable webhook envelopes independently of database rows
- BAPIHOOK-102 · Authorize subscription creation and event scope per organization
- BAPIHOOK-103 · Validate webhook destinations through the restricted network boundary
- BAPIHOOK-104 · Sign exact webhook bytes with versioned verification metadata
- BAPIHOOK-105 · Document at-least-once delivery with stable event identities
- BAPIHOOK-106 · Bound retry scheduling and distinguish terminal receiver responses
- BAPIHOOK-107 · Expose event ordering limits without requiring global sequencing
- BAPIHOOK-108 · Replay terminal deliveries without mutating original event content
Acceptance criteria
- Compare versioned subscriptions and additive-compatible evolution.
- Define supported version overlap and retirement evidence.
- Rehearse receiver upgrade, rollback, and replay of historical events.
Implementation constraints
- Historical events retain their original schema identity.
Verification to include
- Upgrade one synthetic receiver while another stays legacy.
- Replay an old event after upgrade and verify documented handling.
Deliverables
- Webhook evolution decision record.
Rollout and recovery
Keep supported schema serializers and examples through the retention window.
Value of the work
For the engineer: Practice public event contracts, delivery guarantees, and partner recovery workflows.
For the team: Provide inspectable asynchronous integration behavior with controlled retries and clear compatibility.
Evidence boundaries
Outcome Evidence: Tests, patches, and runbooks are requested deliverables. They become Outcome Evidence only through a qualified Mission and immutable Evidence IDs.
Ownership Evidence: Independent adaptation must be observed under a declared verification policy and cite immutable Evidence IDs. Completing a planning ticket establishes no Ownership Evidence.