> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt.

# Webhook payload snippet

> Reference a webhook payload from your API Reference to display example payloads in your documentation.

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](/learn/docs/ai-features/markdown) 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>`](/learn/docs/writing-content/components/endpoint-schema-snippet) component.

## Usage

Reference a webhook by its `operationId` to display its payload schema.

**`Markdown`**

```jsx Markdown
<WebhookPayloadSnippet webhook="on-conversation-completed" />
```

## Properties

**`webhook`** `string` — required

The `operationId` of the webhook to display. If your API uses [namespaces](/learn/api-definitions/overview/project-structure#combined-sdks-from-multiple-apis), prefix with the namespace and `::` (e.g., `payments::on-payment-succeeded`).

---

> Reference a webhook payload from your API Reference to display example payloads in your documentation.