Repository navigation
feat: add webhooks 2.0 documentation & mid insights screenshots - #319
Merged
pedroalmeidaes merged 2 commits intoSep 15, 2026
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Both guides contain unresolved replay-protection gaps and broken JavaScript examples.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds Webhooks 2.0 documentation for Select and Offer Marketplace, covering delivery handling, history, replaying, headers, and signature verification.
Changes:
- Documents retries, delivery metadata, idempotency, history, and replay workflows.
- Updates custom-header and signature-verification guidance.
File summaries
| File | Summary | Findings |
|---|---|---|
select/webhooks.md |
Expands Select webhook lifecycle and verification documentation. | Critical: stale timestamps are not rejected, allowing replay. Moderate: crypto.createHmac lacks a required import. |
oaas/webhooks.md |
Expands Offer Marketplace webhook management and delivery documentation. | Critical: stale timestamps are not rejected, allowing replay. Moderate: crypto.createHmac lacks a required import. |
Review details
Suppressed comments (4)
oaas/webhooks.md:126
- Because
Buffer.from(undefined)throws, a request withoutx-fidel-signaturemakes this validator raise instead of returningfalseand allowing the handler to reject the request cleanly. Validate that the header is present and a string before constructing the buffer.
const received = Buffer.from(fidelHeaders["x-fidel-signature"]);
const expected = Buffer.from(signature);
oaas/webhooks.md:118
- This JavaScript example calls
crypto.createHmacwithout importing or definingcrypto; the browsercryptoobject and Node's global API do not provide this method, so the example fails when copied as shown. Add a Node crypto import (or otherwise identify the required setup).
function isSignatureValid(fidelHeaders, rawBody, secret, url) {
function base64Digest(value) {
return crypto.createHmac("sha256", secret).update(value).digest("base64");
select/webhooks.md:634
- Because
Buffer.from(undefined)throws, a request withoutx-fidel-signaturemakes this validator raise instead of returningfalseand allowing the handler to reject the request cleanly. Validate that the header is present and a string before constructing the buffer.
const received = Buffer.from(fidelHeaders["x-fidel-signature"]);
const expected = Buffer.from(signature);
select/webhooks.md:627
- This JavaScript example calls
crypto.createHmacwithout importing or definingcrypto; the browsercryptoobject and Node's global API do not provide this method, so the example fails when copied as shown. Add a Node crypto import (or otherwise identify the required setup).
function isSignatureValid(fidelHeaders, rawBody, secret, url) {
function base64Digest(s) {
return crypto.createHmac("sha256", secret).update(s).digest("base64");
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
artur-nogueira
approved these changes
Sep 15, 2026
pevidex
approved these changes
Sep 15, 2026
pedroalmeidaes
deleted the
FT-1602-update-external-facing-documentation
branch
September 15, 2026 15:24
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.
Steps to test
env DOCS_BRANCH=this-pr-branch yarn docsto download the docs files from this PR.yarn startand go to/docsto check the changes.