Webhooks are available with OpenAPI 3.1, and they are already fully supported by Bump. Here is how you should add these webhooks to your documentation.
One of the greatest new features provided by OpenAPI 3.1 is the support of webhooks. Indeed, a OpenAPI 3.1 documentation may include
pathsand / or
pathswere required for previous version.
# Each webhook needs a name
# This is a Path Item Object, the only difference is that the request is initiated by the API provider
description: A new pet arrived, let's come and discover it IRL.
description: Information about a new pet in the system
description: Return a 200 status to indicate that the data was received successfully
- Webhook's name is deduced from the
- Webhook's operation name is extracted from field
- As for endpoints, webhook has body parameters, responses... and some
request payloadexamples are generated.
Furthermore, webhooks are fully compatible with UI customization How to group operations?
By adding some
tagsto your webhooks, you can re-organize how webhooks are named, sorted, and how webhooks operations are sorted.