docs: revise webhooks guide, dashboard-first creation with SDK verify - #55
Merged
Conversation
added 4 commits
July 25, 2026 12:11
- Lead endpoint creation with the dashboard flow (Tabs: Dashboard / SDK / cURL) - Front the @rendobar/sdk verifyWebhook one-liner plus a complete Express receiver - Add a Manage-from-code section for client.webhooks.* (list, test, rotate, retry, update, delete) - Fix stale delivery header example (del_ -> whd_ to match generateDeliveryId) - Use ffprobe as the real data-only job example; refresh SDK-based retry/rotation snippets - Update dateModified to 2026-07-25
- Creation is dashboard-only (drop SDK/cURL creation tabs) - Fold SDK calls into context (test in tip, rotate in rotation, retry in retries) - Trim prose and the failed-event example; keep it lean and readable
…oks guide - Lead the Create section with the Webhooks dashboard link - Embed empty-state and New Endpoint panel screenshots via <Frame>, served from cdn.rendobar.com/assets/docs/webhooks/
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.
What
A full revision of
guides/webhooks.mdxso the page matches what actually ships and reads cleanly, not verbosely.Highlights
whsec_secret), the path most users take.@rendobar/sdkverifyWebhook()one-liner plus a complete Express receiver (the raw-body gotcha is called out). A compact "verify without the SDK" CodeGroup covers Node and Python.test(tip),rotateSecret(rotation),retryDelivery(retries), rather than a bulky standalone section.Nothing stale
Verified line-by-line against source (
packages/shared/src/constants/webhook-events.ts,types/webhook.ts,apps/api/src/routes/webhook-endpoints.ts, and the dashboard route):X-Rendobar-Delivery: del_…→whd_…to matchgenerateDeliveryId().extract.metadatawith the realffprobedata-only example.outputshape all confirmed current.dateModifiedto 2026-07-25.Validation
validate:frontmatter,validate:nav,validate:plan-limitsall pass.🤖 Generated with Claude Code
https://claude.ai/code/session_01Ajz7odbJunsbosNj81M2Pi
Generated by Claude Code