Skip to content

Add live example to webhook-payload-snippet and align with endpoint-schema-snippet #5452

Merged
devalog merged 1 commit into
mainfrom
fern/webhook-payload-snippet-live-example
May 11, 2026
Merged

Add live example to webhook-payload-snippet and align with endpoint-schema-snippet #5452
devalog merged 1 commit into
mainfrom
fern/webhook-payload-snippet-live-example

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 11, 2026

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
    • Replaced the stub intro with a description that mirrors the <EndpointSchemaSnippet> page (what the component does + cross-reference to the related component).
    • Usage section now renders a live <WebhookPayloadSnippet webhook="on-conversation-completed" /> inside a highlight-frame, followed by the corresponding jsx Markdown code block.
    • Expanded the webhook <ParamField> description with the namespace-prefixing note used on the other API-reference snippet pages.
    • Page structure is now: intro → Usage → Properties (matching the snippet component pages, which omit Variants when the component has no additional selectors).
  • fern/apis/fai/openapi.json — Added an on-conversation-completed webhook under the new top-level webhooks key so the live snippet has a real payload to render (operationId: on-conversation-completed, tag: Scribe webhooks).
  • fern/products/docs/docs.yml — Hid the scribeWebhooks tag from the Scribe API navigation so the docs-only webhook doesn't appear as a customer-facing API page.

Review & Testing Checklist for Human

  • Open the preview link and confirm the Usage section renders the live webhook payload (event / conversationId / domain / messageCount / completedAt fields with their example values).
  • Confirm the page structure (intro → Usage → Properties) reads consistently with Endpoint schema snippet and Endpoint request snippet.
  • Verify the new Scribe webhooks tag does not appear in the Scribe API navigation (it is hidden via scribeWebhooks: hidden: true in docs.yml).

Notes

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 11, 2026 15:24
@github-actions
Copy link
Copy Markdown
Contributor

@devalog devalog merged commit 2bb9258 into main May 11, 2026
3 checks passed
@devalog devalog deleted the fern/webhook-payload-snippet-live-example branch May 11, 2026 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant