Get Started
Back to Templates

WebhookDocs: generate swagger preview of your active workflows

Created by

Created by: Danger || dangerblack

Danger

Last update

Last update 2 months ago

Categories

Share

How it Works

This meta-workflow is designed to intelligently scan all your active workflows in n8n, identify those that contain Webhook nodes, and automatically generate a Swagger (OpenAPI) specification based on them.

The output Swagger document reflects all accessible endpoints from your Webhook nodes, making it easier to:

  • Visualize your API structure
  • Share your endpoints
  • Integrate with tools like Postman or Swagger UI

image.png

Enhanced Parameter Support

If you want the Swagger to reflect request parameters (e.g., query or body fields), you can annotate your Webhook nodes using the Note section. When configured properly, these annotations enrich your Swagger documentation with parameter names, types, and descriptions.

image.png
image.png

Setup Steps

  1. Add the WebhookDocs to n8n
    Import the WebhookDocs JSON file into your n8n instance.
  2. Activate the WebhookDocs (you can also use the test-endpoint)
    Annotate Webhook Nodes (Optional but Recommended)
    To enable parameter documentation, open the Note section of each Webhook node and add annotations in the following format:
//@body field_name string description
//@query field_name string description
  1. Open the page https://n8n.youristance.com/webhook/swagger