feature(live): webhook / external push for chat channel messages by ArnavBallinCode · Pull Request #3445 · fossasia/eventyay

ArnavBallinCode · 2026-04-30T09:56:58Z

Summary

Adds per-room webhook configuration so chat messages and emoji reactions are POSTed to external endpoints with HMAC-SHA256 authentication. This enables external moderation tools (e.g. chatstream-moderate) to receive and process live chat events in real time.

Webhook Payload Schema

{
  "message_id":            "int — Eventyay event_id",
  "channel":               "uuid — Eventyay chat channel identifier",
  "timestamp":             "ISO 8601 — message creation time",
  "screen_name":           "string — chat display name",
  "sender_id":             "string — Eventyay internal user ID (opaque, anonymized)",
  "centralauth_id":        "int | null — Wikimedia CentralAuth gu_id (persistent, globally unique)",
  "centralauth_username":  "string | null — Wikimedia CentralAuth gu_name (global username)",
  "message":               "string — message body text",
  "message_type":          "\"text\" | \"emoji\"",
  "profile_img":           "null (reserved)",
  "user_language":         "string | null — user's locale (BCP 47)",
  "meta":                  "object — type-specific extras (see below)"
}

`meta` by message type

`message_type`	`meta` fields
`text`	`{}`
`emoji`	`{ "target_message_id", "reaction", "action": "add"\|"remove", "reactions": {} }`

CentralAuth field mapping

Webhook field	Source in Eventyay	CentralAuth equivalent
`centralauth_id`	`SocialAccount.uid` (allauth, provider=mediawiki) → `int`	`gu_id` — persistent, globally unique numeric ID
`centralauth_username`	`User.wikimedia_username` (CharField, set at OAuth login)	`gu_name` — global username (can be renamed)
`sender_id`	Eventyay internal user ID (string)	No CentralAuth equivalent — opaque, stable, anonymized

Identity resolution for video room users: Video room users are created separately via JWT token auth. Their token_id is sha256(main_user.email)[:7], which allows tracing back to the main Django user's SocialAccount to resolve CentralAuth fields. Both centralauth_id and centralauth_username will be null for users who did not log in via Wikimedia OAuth.

OAuth endpoint: All three OAuth endpoints hit meta.wikimedia.org/w/rest.php/oauth2/ (authorize, access_token, profile). The OIDC sub claim from meta.wikimedia.org is the CentralAuth global user ID (gu_id), not a local wiki ID.

Authentication

HMAC-SHA256 signature: X-Eventyay-Signature: sha256=<hex_digest>
Computed as HMAC-SHA256(raw_request_body, shared_secret)
Secret is per-room, configured in the room settings UI
Challenge verification on first registration: GET ?challenge=<token> → respond {"challenge": "<token>"}

Security

SSRF protection: Webhook URLs are validated with urlparse, private network blocking via socket.getaddrinfo + ipaddress.ip_address. Private networks are only allowed in DEBUG mode.
Secret stripping: webhook_hmac_secret is stripped from get_room_config() so it's never sent to WebSocket clients.
Input validation: URL scheme normalization, fragment/credential rejection, specific exception handling.
Message type allowlist: Only text and emoji types trigger webhooks; files, deleted, call are skipped.

Screenshots

- New Celery task (send_chat_webhook) for HMAC-SHA256 signed HTTP POST - Dispatch webhook after group_send in ChatModule.send() and .react() - Challenge verification on webhook URL registration in room config patch - Webhook config stored in module_config JSONField (no migration needed) - HTTPS-only URL validation, fire-and-forget delivery

- Relax HTTPS requirement when DEBUG=True for local development - Add tools/test_webhook_receiver.py for manual testing

sourcery-ai

Sorry @ArnavBallinCode, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Show webhook config inputs under the Chat toggle in the room sidebar addons panel. Fields are only visible when chat is enabled.

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

- Strip webhook_hmac_secret from frontend room configs - Validate secret whenever webhook_url is set, not just on URL change - Use urlparse for URL validation, block private networks in prod - Use sync_to_async instead of database_sync_to_async for HTTP - Use event_data sender instead of str(sender.id) to avoid 'None' - Skip webhook for unsupported message types (files, deleted, call) - Include reaction emoji, action, and reactions snapshot in meta

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Look up CentralAuth gu_id (SocialAccount.uid) and gu_name (User.wikimedia_username) at webhook dispatch time. For video room users created via JWT token auth, trace back to the main Django user by matching token_id to sha256(email)[:7] of MediaWiki-linked users.

lgelauff · 2026-05-02T14:10:10Z

on the accepting side, we're live: https://chatstream-moderate.toolforge.org/ . Let me know if you like access for testing. Github updated with documentation.

My AI assistant suggested you double check target_message_id and its definition. I didnt verify myself.

Is there a 'channel language' that you could add? Might be helpful. I added some other fields that I thought might be useful, and updated the specs to this PR as much as possible.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 11 comments.

- Fix sender_id for reactions: always use acting user (self.consumer.user.id) instead of event_data['sender'] which is the original message author - Reuse shared encode_email() from eventyay_common.utils instead of duplicating the implementation - Stricter SSRF: use not ip.is_global instead of is_private to also catch loopback, link-local, and reserved ranges via DNS resolution - Fix misleading error message: 'http or https' instead of 'HTTPS only' for the scheme validation that also accepts http - Guard event.py webhook_hmac_secret pop against missing/non-dict config - Sanitize webhook URL in log output by stripping query string and fragment - Remove unused sys import from test_webhook_receiver.py

@lgelauff

Avoid querying the DB on every webhook dispatch. Results are cached in Django's cache (Redis) with a 1-hour TTL. CentralAuth renames are rare so stale data is acceptable, as noted by @lgelauff.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

ArnavBallinCode added 2 commits April 30, 2026 14:55

Allow HTTP webhook URLs in DEBUG mode, add test receiver

f21cfa5

- Relax HTTPS requirement when DEBUG=True for local development - Add tools/test_webhook_receiver.py for manual testing

Copilot AI review requested due to automatic review settings April 30, 2026 09:56

github-project-automation Bot added this to Eventyay Next Apr 30, 2026

github-project-automation Bot moved this to Backlog in Eventyay Next Apr 30, 2026

sourcery-ai Bot reviewed Apr 30, 2026

View reviewed changes

ArnavBallinCode changed the title ~~Feature/chat webhook push~~ Feature: chat webhook push Apr 30, 2026

Copilot started reviewing on behalf of ArnavBallinCode April 30, 2026 09:57 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

Add webhook URL and secret fields to room config UI

8bfba25

Show webhook config inputs under the Chat toggle in the room sidebar addons panel. Fields are only visible when chat is enabled.

Saksham-Sirohi requested a review from Copilot April 30, 2026 10:44

Copilot started reviewing on behalf of Saksham-Sirohi April 30, 2026 10:45 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

ArnavBallinCode requested review from Sak1012, Saksham-Sirohi and mariobehling April 30, 2026 11:15

Merge branch 'dev' into feature/chat-webhook-push

29064ab

Copilot AI review requested due to automatic review settings April 30, 2026 12:33

Copilot started reviewing on behalf of ArnavBallinCode April 30, 2026 12:34 View session

Copilot AI reviewed Apr 30, 2026

View reviewed changes

ArnavBallinCode changed the title ~~Feature: chat webhook push~~ feature(live): webhook / external push for chat channel messages Apr 30, 2026

Merge branch 'dev' into feature/chat-webhook-push

4c39ab8

Copilot AI review requested due to automatic review settings May 3, 2026 09:24

Copilot started reviewing on behalf of ArnavBallinCode May 3, 2026 09:25 View session

Copilot AI reviewed May 3, 2026

View reviewed changes

Merge branch 'dev' into feature/chat-webhook-push

ea95115

Saksham-Sirohi requested a review from Copilot May 4, 2026 10:23

Copilot started reviewing on behalf of Saksham-Sirohi May 4, 2026 10:24 View session

Copilot AI reviewed May 4, 2026

View reviewed changes

ArnavBallinCode added 2 commits May 8, 2026 13:36

Merge branch 'dev' into feature/chat-webhook-push

53cb419

Copilot AI review requested due to automatic review settings May 8, 2026 08:23

Copilot started reviewing on behalf of ArnavBallinCode May 8, 2026 08:24 View session

Cache CentralAuth lookup per user for 1 hour

3e18eff

Avoid querying the DB on every webhook dispatch. Results are cached in Django's cache (Redis) with a 1-hour TTL. CentralAuth renames are rare so stale data is acceptable, as noted by @lgelauff.

Copilot AI reviewed May 8, 2026

View reviewed changes

ArnavBallinCode requested a review from lgelauff May 8, 2026 08:49

Conversation

ArnavBallinCode commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Webhook Payload Schema

meta by message type

CentralAuth field mapping

Authentication

Security

Screenshots

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

lgelauff commented May 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ArnavBallinCode commented Apr 30, 2026 •

edited

Loading

`meta` by message type