Webhook payload snippet

The <WebhookPayloadSnippet> component displays a webhook’s request payload schema from your API Reference. It renders the same fields, types, and example values that appear on the webhook’s full API Reference page, so readers can inspect the payload inline alongside your prose. When AI agents fetch the Markdown version of a page, the payload schema is included as structured content in the Markdown output.

To display the schema for a regular HTTP endpoint, use the <EndpointSchemaSnippet> component.

Usage

Reference a webhook by its operationId.

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

Properties