Conversation
- Document the x-fishjam-signature-256 header and SDK verification helpers (verifyWebhookSignature / verify_webhook_signature) with examples - Point webhook URL configuration at the Dashboard Webhooks tab instead of per-room webhookUrl params - De-duplicate webhook prose: server-setup is canonical, examples link to it - Bump js-server-sdk and python-server-sdk submodules to include the helpers
Contributor
There was a problem hiding this comment.
Pull request overview
Documents Fishjam webhook signature verification and updates webhook configuration guidance to reflect Dashboard-based webhook URL setup, while de-duplicating webhook documentation across backend guides.
Changes:
- Added “Verifying webhook signatures” section (HMAC-SHA256 over raw body,
x-fishjam-signature-256) and linked framework examples to it. - Updated docs to configure webhook URL via the Dashboard Webhooks tab (keeping batching as a per-room option).
- Refactored Fastify/FastAPI/production deployment examples to verify signatures before decoding and reduced repeated webhook prose.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/backend-quick-start.mdx | Updates quick-start next-steps link to jump directly to the Webhooks section. |
| docs/how-to/backend/server-setup.mdx | Makes server setup the canonical webhook doc; adds signature verification section and updates room creation guidance. |
| docs/how-to/backend/production-deployment.mdx | Updates production webhook handlers to verify signatures and revises webhook enablement instructions to use the Dashboard. |
| docs/how-to/backend/fastify-example.mdx | De-duplicates webhook prose and shows signature verification inside Fastify’s protobuf parser. |
| docs/how-to/backend/fastapi-example.mdx | De-duplicates webhook prose and adds signature verification to the FastAPI dependency. |
| docs/api/reference.md | Updates webhook configuration guidance to use the Dashboard and adjusts batching explanation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Clarify that the 401 response in the signature snippets is framework-specific (see linked framework examples) - Type-guard the x-fishjam-signature-256 header in the Express example instead of casting
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.
Description
Type of change: New Feature (docs)
Fishjam now signs every webhook delivery with an
x-fishjam-signature-256: sha256=<hex>header (HMAC-SHA256 of the raw request body). This PR documents it:verifyWebhookSignature(Node) /verify_webhook_signature(Python) examples, and wires verification into the Fastify, FastAPI, and production-deployment webhook handlers.webhookUrlper room in create-room requests (batchWebhookNotificationsstays a per-room param). The quick-start link now jumps straight to the Webhooks section.js-server-sdkandpython-server-sdksubmodules to include the verification helpers.Note: the submodule pointers currently reference the tips of the unmerged FCE-3619 SDK branches — re-point them to merged main commits before merging this PR.