Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the backend webhook documentation to recommend/illustrate webhook notification batching and to standardize webhook handling around SDK-provided decoders that return lists of notifications (batched or not).
Changes:
- Document
batchWebhookNotifications/batch_webhook_notificationsand update room-creation examples to enable batching. - Add/refresh webhook receiver examples to decode
application/x-protobufwebhook bodies into iterable notification lists. - Refresh production deployment guidance with clearer webhook/auth examples (now split by language tabs).
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/backend-quick-start.mdx | Removes an outdated “listen for events” learning bullet to better match the tutorial scope. |
| docs/how-to/backend/server-setup.mdx | Adds batching recommendation + decoding examples for Node/Python webhooks. |
| docs/how-to/backend/production-deployment.mdx | Updates production guidance with language-tabbed auth + webhook handling and batching recommendation. |
| docs/how-to/backend/fastify-example.mdx | Updates Fastify webhook parsing to use decodeServerNotifications and handle notification lists/batches. |
| docs/how-to/backend/fastapi-example.mdx | Updates FastAPI webhook parsing to use decode_server_notifications and iterate notification lists/batches. |
| docs/api/reference.md | Adds reference-level guidance on batching and decoder behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MiloszFilimowski
approved these changes
Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the backend docs to reflect webhook notification batching (js-server-sdk#273, python-server-sdk#83).
What is batching? By default Fishjam sends one webhook POST per event. With batching enabled, it coalesces several notifications produced close together into a single
NotificationBatchServerMessageper POST — fewer HTTP requests and faster delivery, which keeps your backend responsive under load. Receivers just decode the body and iterate; the decoder unwraps the batch, so batched and single notifications are handled the same way.batchWebhookNotifications/batch_webhook_notificationswhen creating a room.decodeServerNotifications/decode_server_notifications, which transparently unwrap aNotificationBatch— a single message and a batch are handled identically.production-deployment: replace the fictional signature-verification flow with the realapplication/x-protobufdecode loop, add Python tabs throughout, and split the auth example into authentication and create-room-and-add-peer (the room is now created lazily before the peer).backend-quick-start: drop the misleading "listen for events" bullet.js-server-sdkandpython-server-sdksubmodules.Verified:
yarn build(twoslash type-checking) and spellcheck both pass.