Skip to content

docs: Document Notification Payload Schema (#79)#92

Merged
Abd-Standard merged 1 commit into
Core-Foundry:mainfrom
gaiabio12-design:docs/notification-payload-schema
Jun 19, 2026
Merged

docs: Document Notification Payload Schema (#79)#92
Abd-Standard merged 1 commit into
Core-Foundry:mainfrom
gaiabio12-design:docs/notification-payload-schema

Conversation

@gaiabio12-design

Copy link
Copy Markdown
Contributor

Summary

Adds NOTIFICATION_PAYLOAD_SCHEMA.md as requested in #79.

What's included

  • Full field reference for CreateScheduledNotificationInput — all required and optional fields with types, defaults, and constraints
  • Notification type table — four channels (Discord, email, webhook, SMS) with targetRecipient format per channel
  • JSON examples — one complete, copy-pasteable example per notification type
  • Validation rules — field-level and channel-specific validation (Discord webhook URL format, E.164 for SMS, etc.)
  • Deduplication — documents how eventId prevents duplicate deliveries
  • Versioning table — v1.0 baseline with changelog guidance for future breaking changes

The schema is derived directly from the existing TypeScript interfaces in listener/src/types/scheduled-notification.ts and the REST API in listener/src/api/events-server.ts, so it accurately reflects the implementation.

Closes #79

Adds NOTIFICATION_PAYLOAD_SCHEMA.md documenting the full structure,
required/optional fields, validation rules, and JSON examples for all
four notification channels (Discord, email, webhook, SMS).

Closes Core-Foundry#79

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Abd-Standard Abd-Standard merged commit 3047990 into Core-Foundry:main Jun 19, 2026
1 of 2 checks passed
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.

[Docs] Document Notification Payload Schema

2 participants