Add webhooks section to OpenAPI setup #894
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
handotdev
reviewed
Jul 11, 2025
api-playground/openapi-setup.mdx
Outdated
| @@ -4,7 +4,7 @@ description: "Reference OpenAPI endpoints in your docs pages" | |||
| icon: "file-json" | |||
| --- | |||
|
|
|||
| 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. | |||
| OpenAPI is a specification for describing APIs. Mintlify supports OpenAPI 3.0+ documents to generate interactive REST API documentation, and OpenAPI 3.1+ for documenting webhooks. | |||
There was a problem hiding this comment.
I think the disclaimer on the version should be closer with where the content is at. I don't think it needs to be at the high level overview
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation changes
This PR adds info on web hooks to https://mintlify.com/docs/api-playground/openapi-setup. Right now, there is just a brief mention about webhooks in a note which is too hard to find. This adds a section with info that webhooks are supported in OpenAPI 3.1+ and how to specify a webhook in a n MDX page.
Closes
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience