Paradaux
Issues

PAR-162

0

Document the webhooks feature in /docs (player guide + admin page)

DoneNormalUnassignedEconomy Explorer

Why

The transaction-feed webhooks (PAR-151/153/155/160) have no player documentation. Add it to the /docs portal.

Pages

  • docs/guides/webhooks.md (player + developer): what webhooks are; set one up on the site at /me/webhooks (no API key — scope to your personal account or a finance-access firm); set one up via the REST API; the delivery payload + headers; verifying the X-Treasury-Signature HMAC-SHA256 signature (with a code example); Discord auto-embeds (paste a Discord webhook URL, no code); reliability (settled-only, retries/backoff, auto-disable, delivery-health view); managing (pause/enable, rotate secret, delete). Linked from guides/index.md and cross-linked from guides/api.md.
  • docs/admin/webhooks.md (admin-only section): the /admin/webhooks page — list/search/filter every webhook, create one for an arbitrary account. Linked from admin/index.md.

Follow-up to PAR-151/153/155/160. User-docs (not dev-docs) tone, matching the existing Stripe-style guides.

Resources

Comments

No comments yet.

Activity

  • ParadauxIO linked a commit — Commit 1eb42bf — Merge pull request #19 from MCCitiesNetwork/develop
  • ParadauxIO linked a commit — Commit b7e1691 — Document the webhooks feature in /docs (PAR-162)
  • ParadauxIO changed status to Status → Done
  • ParadauxIO linked a pull request — PR #19 merged — Release: webhooks documentation (player guide + admin page) (PAR-162)
  • tesks changed status to Status → Pending Release
  • ParadauxIO linked a pull request — PR #19 open — Release: webhooks documentation (player guide + admin page) (PAR-162)
  • ParadauxIO linked a pull request — PR #19 open — Release: admin mode + webhooks documentation (PAR-161, PAR-162)
  • ParadauxIO linked a pull request — PR #19 open — Release: webhooks documentation (player guide + admin page) (PAR-162)
  • ParadauxIO linked a commit — Commit b7e1691 — Document the webhooks feature in /docs (PAR-162)
  • tesks created the issue