webhook-example

JSON

{ "openapi": "3.1.0", "info": { "title": "Webhook Example", "version": "1.0.0" }, "webhooks": { "newPet": { "post": { "requestBody": { "description": "Information about a new pet in the system", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pet" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } } }, "components": { "schemas": { "Pet": { "type": "object", "required": ["id", "name"], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "tag": { "type": "string" } } } } } } 

YAML

openapi: 3.1.0 info: title: Webhook Example version: 1.0.0 # Since OAS 3.1.0 the paths element isn't necessary. Now a valid OpenAPI Document can describe only paths, webhooks, or even only reusable components webhooks: # Each webhook needs a name newPet: # This is a Path Item Object, the only difference is that the request is initiated by the API provider post: requestBody: description: Information about a new pet in the system content: application/json: schema: $ref: '#/components/schemas/Pet' responses: '200': description: Return a 200 status to indicate that the data was received successfully components: schemas: Pet: type: object required: - id - name properties: id: type: integer format: int64 name: type: string tag: type: string