Writing contentComponents

Webhook payload snippet

View as Markdown

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.

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

Usage

Reference a webhook by its operationId.

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

Properties

webhook
stringRequired

The operationId of the webhook to display. If your API uses namespaces, prefix with the namespace and :: (e.g., payments::on-payment-succeeded).