Skip to content

docs(run-payerbox): document AidboxTopicDestination event notifications#17

Open
not-in-stock wants to merge 1 commit into
mainfrom
497-document-topic-destination
Open

docs(run-payerbox): document AidboxTopicDestination event notifications#17
not-in-stock wants to merge 1 commit into
mainfrom
497-document-topic-destination

Conversation

@not-in-stock

Copy link
Copy Markdown
Contributor

What

Adds an operator how-to for outbound event notifications — Payerbox's topic-based subscription mechanism — which was previously undocumented.

New page: Run Payerbox → Maintain → Event Notifications (docs/run-payerbox/maintain/event-notifications.md).

Contents

  • How it works: AidboxSubscriptionTopic (trigger) + AidboxTopicDestination (sink), async delivery via the engine.
  • At-least-once vs best-effort delivery.
  • Destination kind table — webhook-at-least-once, aws-sns-*, and the Payerbox custom-aws-sns-* kinds (with reference enrichment).
  • Step-by-step configuration: allow-destinations profile whitelist → subscription topic → destination (SNS / webhook tabs, full parameter tables) → verify.
  • Deploy-time provisioning via init-bundle and the ordering rules.
  • Immutability: destinations are delete-and-re-create only; re-creation re-registers with the delivery engine.
  • Gotchas (idempotency, re-fire, stale config) and current limitations.

Examples are grounded in the actual SNS module and seed configuration, not paraphrased.

Wiring

  • Listed in SUMMARY.md under Maintain.
  • Linked from the Maintain index (maintain/README.md).

Checks

bun lint (docs-tools) — 13 checks passed; no warnings on the new page. Remaining repo warnings are pre-existing and unrelated.

Resolves HealthSamurai/smartbox#497

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant