You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-playground/openapi-setup.mdx
+27-3Lines changed: 27 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: "Reference OpenAPI endpoints in your docs pages"
4
4
icon: "file-json"
5
5
---
6
6
7
-
OpenAPI is a specification for describing REST APIs. Mintlify supports OpenAPI 3.0+ documents to generate interactive API documentation and keep it up to date.
7
+
OpenAPI is a specification for describing APIs. Mintlify supports OpenAPI 3.0+ documents to generate interactive API documentation and keep it up to date.
The method and path must exactly match the definition in your OpenAPI specification. If the endpoint doesn't exist in the OpenAPI file, the page will be empty.
189
-
190
-
For webhooks, use `webhook` (case insensitive) instead of the HTTP method (like `GET` or `POST`) in your reference.
191
189
</Note>
192
190
193
191
### Autogenerate `MDX` files
@@ -239,3 +237,29 @@ openapi-schema: "schema-key"
239
237
```
240
238
241
239
</CodeGroup>
240
+
241
+
## Webhooks
242
+
243
+
Webhooks are HTTP callbacks that your API sends to notify external systems when events occur. Webhooks are supported in OpenAPI 3.1+ documents.
244
+
245
+
### Define webhooks in your OpenAPI specification
246
+
247
+
Add a `webhooks` field to your OpenAPI document alongside the `paths` field.
248
+
249
+
For more information on defining webhooks, see [Webhooks](https://spec.openapis.org/oas/v3.1.0#oasWebhooks) in the OpenAPI documentation.
250
+
251
+
### Reference webhooks in MDX files
252
+
253
+
When creating MDX pages for webhooks, use `webhook` instead of HTTP methods like `GET` or `POST`:
0 commit comments