Unify webhook signature-header docs across the three SDKs - #361
Merged
Conversation
One canonical description covering both layers: the wire carries the value on Primitive-Signature, X-Primitive-Signature, and X-Webhook-Signature; the SDK verifies Primitive-Signature and still accepts the retired MyMX-Signature name for older captures. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
docfacts impact
This PR also touches evidence for 30 verified claims and 3 documented pages — no action needed unless behavior changed; the nightly scan re-verifies automatically. details
|
Confidence Score: 5/5The documentation-only PR appears safe to merge. The revised descriptions consistently distinguish the headers emitted on deliveries from the narrower header names recognized by the SDK handlers, with no code or runtime behavior changed.
|
| Filename | Overview |
|---|---|
| sdk-go/README.md | Aligns the advanced webhook documentation with the server’s wire headers and the Go verifier’s accepted header names. |
| sdk-node/README.md | Corrects both Node.js signature-verification sections to consistently distinguish emitted headers from verifier fallback behavior. |
| sdk-python/README.md | Aligns Python webhook documentation with the same canonical wire and verifier-header description. |
Reviews (1): Last reviewed commit: "Unify webhook signature-header docs acro..." | Re-trigger Greptile
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
1 participant
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.
The three READMEs described webhook signing three different ways, and each was wrong at a different layer. Ground truth: the server (callWebhookOnce) sends one HMAC value on Primitive-Signature, X-Primitive-Signature, and X-Webhook-Signature; it never sends MyMX-Signature. The SDK verifiers read Primitive-Signature and retain MyMX-Signature as a retired fallback name. All four call sites now share one canonical description covering both the wire and the verifier.
Follow-up worth a product decision: the MyMX-Signature fallback in all three SDK verifiers matches nothing the platform has sent since the rename, and the server's X-Webhook-Signature is likewise unread by the SDKs; both could retire on the next major.
🤖 Generated with Claude Code