Add live example to webhook-payload-snippet and align with endpoint-schema-snippet #5452
Merged
Merged
Conversation
…chema-snippet structure
Contributor
|
🌿 Preview your docs: https://fern-preview-fern-webhook-payload-snippet-live-example.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
devalog
approved these changes
May 11, 2026
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.
Summary
Addresses the Slack feedback to add a live example to the Webhook payload snippet component page and align its structure with other component pages — using Endpoint schema snippet as the reference.
Changes
fern/products/docs/pages/component-library/default-components/webhook-payload-snippet.mdx<EndpointSchemaSnippet>page (what the component does + cross-reference to the related component).<WebhookPayloadSnippet webhook="on-conversation-completed" />inside ahighlight-frame, followed by the correspondingjsx Markdowncode block.webhook<ParamField>description with the namespace-prefixing note used on the other API-reference snippet pages.fern/apis/fai/openapi.json— Added anon-conversation-completedwebhook under the new top-levelwebhookskey so the live snippet has a real payload to render (operationId:on-conversation-completed, tag:Scribe webhooks).fern/products/docs/docs.yml— Hid thescribeWebhookstag from the Scribe API navigation so the docs-only webhook doesn't appear as a customer-facing API page.Review & Testing Checklist for Human
Scribe webhookstag does not appear in the Scribe API navigation (it is hidden viascribeWebhooks: hidden: trueindocs.yml).Notes
Requested by: Fern Support