docs: Add webhook security guidance to crawl and batch-scrape features #253
Conversation
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
Add explicit documentation about webhook signature verification (HMAC-SHA256) in the crawl and batch-scrape feature pages. This prevents customers from needing support to discover how to verify webhook authenticity and ensures security best practices are emphasized at the point where developers first learn about webhooks. Changes: - Add dedicated "Security: Verifying Webhook Signatures" section to both crawl and batch-scrape feature pages - Explain HMAC-SHA256 signature verification process - Link directly to webhook security documentation with implementation examples - Add warning about always verifying signatures before processing webhooks - Mention where to find webhook secret in account settings Fixes issue where customers discover webhooks but aren't immediately informed about signature verification requirements and how to implement it. Co-Authored-By: devhims <himanshu@sideguide.dev>
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
This PR adds explicit documentation about webhook signature verification (HMAC-SHA256) in the crawl and batch-scrape feature pages.
Problem: Customers discovering webhooks through the feature documentation weren't aware that:
Solution: Added dedicated "Security: Verifying Webhook Signatures" sections to both feature pages that:
Changes
features/crawl.mdx: Added security section with signature verification guidancefeatures/batch-scrape.mdx: Added identical security section for consistencyImpact
This prevents customers from needing support to discover webhook security practices and ensures developers understand signature verification at the point where they first learn about webhooks.
Test Plan