Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

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

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

---

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@ruhanponnada ruhanponnada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ruhanponnada ruhanponnada merged commit 8cb398e into main Jul 14, 2025
4 checks passed
@ruhanponnada ruhanponnada deleted the webhook-support branch July 14, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants