Skip to content

Commit c56edbe

Browse files
docs: add WebhookPayloadSnippet component documentation (#2943)
Co-authored-by: fern-support <[email protected]> Co-authored-by: Fern Support <[email protected]>
1 parent c875ad5 commit c56edbe

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

fern/products/docs/docs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@ navigation:
9090
- page: Endpoint schema snippet
9191
path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx
9292
icon: fa-duotone fa-sitemap
93+
- page: Webhook payload snippet
94+
path: ./pages/component-library/default-components/webhook-payload-snippet.mdx
95+
icon: fa-duotone fa-webhook
96+
slug: webhook-payload-snippet
9397
- page: Files
9498
path: ./pages/component-library/default-components/files.mdx
9599
icon: fa-duotone fa-folder-tree
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Webhook payload snippet
3+
description: Reference a webhook payload from your API Reference to display example payloads in your documentation.
4+
---
5+
6+
Use the `<WebhookPayloadSnippet>` component to reference a webhook payload from your API Reference.
7+
8+
## Usage
9+
10+
```jsx Markdown
11+
<WebhookPayloadSnippet webhook="on-order-created" />
12+
```
13+
14+
## Properties
15+
16+
<ParamField path="webhook" type="string" required={true}>
17+
The operation ID of the webhook to display.
18+
</ParamField>

0 commit comments

Comments
 (0)