WebHooks

Demonstrates how to define top-level WebHooks in the OpenAPI document.

Note: This feature is currently not yet implemented in Kestrun. The example below is a placeholder for future support.

Full source

File: pwsh/tutorial/examples/10.12-OpenAPI-WebHook.ps1

<#
    Sample: OpenAPI WebHook
    Purpose: Demonstrate webhook components with multiple content types.
    File:    10.12-OpenAPI-WebHook.ps1
    Notes:   Shows class inheritance, component wrapping, and content type negotiation.
#>

throw "This example is not yet implemented."

Step-by-step

Not Implemented: This feature is planned for a future release.
Concept: WebHooks allow defining incoming events that the API consumer can subscribe to, distinct from callbacks which are tied to specific operations.

Try it

This example cannot be executed yet.

Troubleshooting

Issue: Feature not implemented.

Status: This feature is planned for a future release of Kestrun.
Workaround: Document incoming events and subscriptions in external guides or use OpenAPI extensions (when supported) to document webhook behavior.

References

OpenAPI Webhooks

Previous / Next

Previous: Component Callbacks Next: Redocly Museum API