fern icon indicating copy to clipboard operation
fern copied to clipboard

Add missing Webhook Payload Snippets Support

Open Koubek opened this issue 1 year ago • 0 comments

Which Fern component?

Fern Docs

How important is this?

P3 - Low (Nice to have)

What's the feature?

Feature: Support for Webhook Payload Snippets (similar to EndpointRequestSnippet and EndpointResponseSnippet).

Why: Currently, Fern offers convenient snippets to display real request and response examples in documentation. However, there doesn’t appear to be a corresponding feature for webhook payloads. Adding such functionality would ensure consistency across the docs and improve clarity for developers who rely on webhooks.

How: Provide a new snippet component (e.g., EndpointWebhookPayloadSnippet or maybe just WebhookPayloadSnippet) that enables users to embed live, real-world webhook payload examples in the documentation. Ideally, it would mirror the usage of existing snippet components, making it easy for developers to adopt.

Thanks :)

Any alternatives?

Write everything manually but because of that, it is prone to inconsistencies in the generated documentation.

Koubek avatar Mar 17 '25 13:03 Koubek