Skip to content

Write notifications/README.md with integration guide #273

Description

@Nursca

Description
There is no documentation for the notifications service beyond a brief entry in docs/notifications.md. Integrators need a complete guide covering setup, webhook registration, event types, and HMAC signature verification.

Requirements and context

  • Service overview and architecture
  • Environment variable reference
  • Webhook registration walkthrough with curl examples
  • Full event type reference with example payloads
  • HMAC signature verification code examples (TypeScript, Python, Go)
  • Email subscription setup guide

Suggested execution

git checkout -b docs/notifications-readme
  • Create notifications/README.md
  • Write HMAC verification examples in multiple languages
  • Link from org root README.md

Example commit message
docs(notifications): write comprehensive notifications service README

Metadata

Metadata

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions