Skip to content

docs: document webhook contracts - #129

Merged
LunaStev merged 3 commits into
wavefnd:masterfrom
udaya-ann:docs/webhook-contracts
Sep 29, 2026
Merged

LunaStev merged 3 commits into
wavefnd:masterfrom
udaya-ann:docs/webhook-contracts

Conversation

@udaya-ann

Copy link
Copy Markdown
Contributor

Summary

Verification

  • Reviewed the webhook implementation in internal/webhook/service.go and internal/webhook/model.go
  • Confirmed the documented payload fields, headers, signature format, retry behavior, event scopes, and Discord handling against the current implementation

Closes #55

@LunaStev LunaStev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The webhook contract documentation otherwise matches the current implementation. There is one event-name mismatch to fix.

Comment thread docs/webhooks.md

## Event Scopes

Webhook endpoints can be either **account-scoped** or **platform-scoped**.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current event constant in internal/webhook/model.go is mailing-list.message.created, not mailing-list.post. Please update this to the exact event type used by the implementation.

@LunaStev LunaStev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@LunaStev
LunaStev merged commit 106143f into wavefnd:master Sep 29, 2026
1 check 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.

Document the generic webhook verification and Discord delivery contracts

2 participants