Webhook 负载片段 | Fern Documentation

<WebhookPayloadSnippet> 组件从您的 API 参考中显示 webhook 的请求负载架构。它呈现与 webhook 完整 API 参考页面相同的字段、类型和示例值，因此读者可以在您的内容中内联检查负载。

要显示常规 HTTP 端点的架构，请使用 <EndpointSchemaSnippet> 组件。

用法

通过其 operationId 引用 webhook。

Markdown

1 <WebhookPayloadSnippet webhook="on-conversation-completed" />

webhook

stringRequired

要显示的 webhook 的 operationId。如果您的 API 使用命名空间，请使用命名空间和 :: 作为前缀（例如，payments::on-payment-succeeded）。