For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog inStart for free
  • Getting started
    • Overview
    • How it works
    • Quickstart
    • Project structure
    • Customer showcase
    • Changelog
  • Configuration
    • Overview
    • Site-level settings
    • Page-level settings
  • Writing content
    • Markdown basics
    • Rich media in Markdown
      • Overview
      • Accordion
      • Anchor
      • Aside
      • Badge
      • Button
      • Callout
      • Card
      • Code block
      • Copy
      • Download
      • Endpoint request snippet
      • Endpoint response snippet
      • Endpoint schema snippet
      • Webhook payload snippet
      • Files
      • Frame
      • Icon
      • If
      • Indent
      • Parameter field
      • Prompt
      • Runnable endpoint
      • Schema
      • Step
      • Table
      • Tab
      • Tooltip
      • Versions
    • Fern Editor
    • Reusable snippets
  • AI features
    • Overview
    • Fern Writer
    • AI-generated examples
    • Markdown access
      • Overview
      • Customize LLM output
      • Agent directives
      • Analytics and integration
    • MCP server
    • API catalog discovery
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
Book a demoLog inStart for free
On this page
  • Usage
  • Properties
Writing contentComponents

Webhook payload snippet

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Endpoint schema snippet

Next

Files

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.

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).